Skip to main content

DataPlaneEgressDiagnostics

Router-side DATA egress isolation and pressure metrics.

activeStreamQueuesActivestreamqueues (integer)required

Independent remote command queues currently active.

queueDepthQueuedepth (integer)required

Frames currently queued across remote command streams.

maxQueueDepthMaxqueuedepth (integer)required

Highest aggregate remote DATA queue depth observed.

localShortCircuitsLocalshortcircuits (integer)required

Frames delivered locally without remote Zenoh egress.

remoteFramesEnqueuedRemoteframesenqueued (integer)required

Remote frames accepted into bounded command queues.

remoteFramesPublishedRemoteframespublished (integer)required

Remote frames successfully published over Zenoh.

remoteFramesDroppedRemoteframesdropped (integer)required

Remote frames dropped by queue or stream admission bounds.

remotePublishFailuresRemotepublishfailures (integer)required

Remote publishes that raised or exceeded their deadline.

remoteBytesPublishedRemotebytespublished (integer)required

Serialized DATA bytes successfully published over Zenoh.

inboundPayloadQueueDepthInboundpayloadqueuedepth (integer)

Payload frames waiting in an isolated network-ingress lane.

Default value: 0
inboundPayloadQueueCapacityInboundpayloadqueuecapacity (integer)

Hard capacity of the isolated payload ingress lane.

Default value: 0
inboundTerminalQueueDepthInboundterminalqueuedepth (integer)

Terminal frames waiting in an isolated network-ingress lane.

Default value: 0
inboundTerminalQueueCapacityInboundterminalqueuecapacity (integer)

Hard capacity of the isolated terminal ingress lane.

Default value: 0
inboundFramesDroppedInboundframesdropped (integer)

Network-ingress frames rejected by isolated lane bounds.

Default value: 0
idleStreamReclaimsIdlestreamreclaims (integer)

Remote command queues reclaimed after their idle lease expired.

Default value: 0
enqueueLatencySamplesEnqueuelatencysamples (integer)required

Remote frames with measured TopicRouter enqueue latency.

enqueueLatencySecondsAverage object

Average TopicRouter-to-egress enqueue latency.

anyOf
number
enqueueLatencySecondsMax object

Maximum TopicRouter-to-egress enqueue latency.

anyOf
number
publishLatencySamplesPublishlatencysamples (integer)required

Remote frames with measured Zenoh publish latency.

publishLatencySecondsAverage object

Average successful or failed Zenoh publish latency.

anyOf
number
publishLatencySecondsMax object

Maximum successful or failed Zenoh publish latency.

anyOf
number
owners object

Per-owner pressure counters keyed by opaque node id.

property name* DataPlaneOwnerDiagnostics

Bounded egress pressure metrics for one remote DATA owner.

queueDepthQueuedepth (integer)required

Frames currently queued for this owner.

activeStreamsActivestreams (integer)required

Independent command egress queues active for this owner.

maxQueueDepthMaxqueuedepth (integer)required

Highest aggregate queue depth observed for this owner.

framesEnqueuedFramesenqueued (integer)required

Frames accepted into this owner's command queues.

framesPublishedFramespublished (integer)required

Frames successfully published for this owner.

framesDroppedFramesdropped (integer)required

Frames rejected by this owner's bounded queues.

publishFailuresPublishfailures (integer)required

Publish exceptions or deadline expirations for this owner.

idleStreamReclaimsIdlestreamreclaims (integer)

Command queues reclaimed after their egress idle lease expired.

Default value: 0
DataPlaneEgressDiagnostics
{
"activeStreamQueues": 0,
"queueDepth": 0,
"maxQueueDepth": 0,
"localShortCircuits": 0,
"remoteFramesEnqueued": 0,
"remoteFramesPublished": 0,
"remoteFramesDropped": 0,
"remotePublishFailures": 0,
"remoteBytesPublished": 0,
"inboundPayloadQueueDepth": 0,
"inboundPayloadQueueCapacity": 0,
"inboundTerminalQueueDepth": 0,
"inboundTerminalQueueCapacity": 0,
"inboundFramesDropped": 0,
"idleStreamReclaims": 0,
"enqueueLatencySamples": 0,
"enqueueLatencySecondsAverage": 0,
"enqueueLatencySecondsMax": 0,
"publishLatencySamples": 0,
"publishLatencySecondsAverage": 0,
"publishLatencySecondsMax": 0,
"owners": {}
}