Skip to main content

DataPlaneDiagnostics

Bounded local metrics for serving-stream delivery and lifecycle health.

transportTransport (string)required

Configured DATA transport on this API node.

Possible values: [disabled, gossipsub, zenoh]

reorderBufferEnabledReorderbufferenabled (boolean)required

Whether this API reorders DATA frames before dispatch.

activeStreamsActivestreams (integer)required

Streams accepted without a terminal frame yet.

framesReceivedFramesreceived (integer)required

All DATA frames observed before deduplication.

framesDispatchedFramesdispatched (integer)required

Ordered, unique DATA frames accepted for live commands.

startedFramesStartedframes (integer)required

Accepted started lifecycle frames.

chunkFramesChunkframes (integer)required

Accepted non-terminal payload frames.

completedFramesCompletedframes (integer)required

Accepted completed terminal frames.

failedFramesFailedframes (integer)required

Accepted failed terminal frames.

cancelledFramesCancelledframes (integer)required

Accepted cancelled terminal frames.

duplicateFramesDuplicateframes (integer)required

Frames dropped because their sequence was already observed.

outOfOrderFramesOutoforderframes (integer)required

Frames received above the next expected sequence.

skippedSequencesSkippedsequences (integer)required

Missing sequence numbers skipped after a bounded reorder wait.

lateFramesLateframes (integer)required

Frames dropped because no live command queue remained.

missingStartedStreamsMissingstartedstreams (integer)required

Streams whose first accepted frame was not started.

missingTerminalStreamsMissingterminalstreams (integer)required

Streams finalized locally without an accepted terminal frame.

idleTimeoutsIdletimeouts (integer)required

API stream receives that exceeded the DATA idle deadline.

transportFailuresTransportfailures (integer)required

Streams failed locally after a DATA ordering or delivery gap.

firstByteSamplesFirstbytesamples (integer)required

Streams with a measured started-to-first-payload interval.

firstByteSecondsLast object

Most recently measured started-to-first-payload latency.

anyOf
number
firstByteSecondsAverage object

Average started-to-first-payload latency for this process.

anyOf
number
firstByteSecondsMax object

Maximum started-to-first-payload latency for this process.

anyOf
number
streamSpanSamplesStreamspansamples (integer)required

Terminal streams with a measured first-payload-to-terminal span.

streamSpanSecondsLast object

Most recently measured first-payload-to-terminal span.

anyOf
number
streamSpanSecondsAverage object

Average first-payload-to-terminal span for this process.

anyOf
number
streamSpanSecondsMax object

Maximum first-payload-to-terminal span for this process.

anyOf
number
egress objectrequired

Router-side DATA queue, publish, and isolation 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
DataPlaneDiagnostics
{
"transport": "disabled",
"reorderBufferEnabled": true,
"activeStreams": 0,
"framesReceived": 0,
"framesDispatched": 0,
"startedFrames": 0,
"chunkFrames": 0,
"completedFrames": 0,
"failedFrames": 0,
"cancelledFrames": 0,
"duplicateFrames": 0,
"outOfOrderFrames": 0,
"skippedSequences": 0,
"lateFrames": 0,
"missingStartedStreams": 0,
"missingTerminalStreams": 0,
"idleTimeouts": 0,
"transportFailures": 0,
"firstByteSamples": 0,
"firstByteSecondsLast": 0,
"firstByteSecondsAverage": 0,
"firstByteSecondsMax": 0,
"streamSpanSamples": 0,
"streamSpanSecondsLast": 0,
"streamSpanSecondsAverage": 0,
"streamSpanSecondsMax": 0,
"egress": {
"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": {}
}
}