Skip to content

Typed Status Reference

Every status published by a component with a registered status struct (RFC-029 D4), rendered from the same pass that generates schema/status/. The field descriptions are the struct doc comments; the schema documents are the published contract. Components not listed here are not typed yet and remain in the hand-maintained telemetry reference, which also holds everything shared: the wire encoding, the numeric-kind rules, and the module id table.

A required field is present in every emission of the component; an optional field may be absent, and absent is a different statement than zero. An enumerated field is published as its integer index; the value names below are the schema's x-enum-varnames mapping. A component status is the shared componentStatusIndex definition of schema/common/v1.schema.json, which every status document references.

app

AppStatus is the status of a module's per-module health component, .app.main (ADR-007): the module's overall health plus its process-level version, uptime, memory and CPU figures.

Field Type Required Meaning
appStartCounter integer AppStartCounter counts the module process's starts on this device, persisted across restarts. Published only by sys today - the legacy exception to the shared-name rule recorded on NameApp; no other module sets it.
cpuSystemCounter integer CpuSystemCounter is cumulative kernel-mode CPU time, in scheduler ticks (jiffies).
cpuUserCounter integer CpuUserCounter is cumulative user-mode CPU time, in scheduler ticks (jiffies).
memAlloc integer yes MemAlloc is heap bytes currently allocated.
memNumGC integer yes MemNumGC is the number of completed garbage collections.
memSys integer yes MemSys is bytes of memory obtained from the OS.
memTotalAlloc integer yes MemTotalAlloc is cumulative heap bytes allocated since process start.
status integer (enum) Status is the module's overall health on the telemetry axis (never the config-update axis). Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.
uptime integer yes Uptime is seconds since process start.
version string yes Version is the algol version string.

auth

AuthStatus is the status of the bus's auth callout, nats.auth.main (RFC-034 D10): the key registry's counts and the connections decided since process start.

Field Type Required Meaning
admitted integer yes Admitted counts connections admitted since process start.
bound integer yes Bound is how many of those are bound to a key in the registry.
expected integer yes Expected is the number of module ids in the bus's --module set.
rejected integer yes Rejected counts connections rejected since process start; the reason is a nats log line.
userKeys integer yes UserKeys is the number of enrolled user keys - a person's key, as opposed to a module's; the boot's root key is not counted.

authz

AuthzStatus is what the configurer's decision point has decided, cfg.authz.main (adr/rfc-035-device-authorization.md D12).

Field Type Required Meaning
refused integer yes Refused counts the requests the decision point refused since process start. A refusal is a whole operation that did not happen; a filter-addressed write that acted on part of what it matched is not one, and is reported to its caller as skipped instead.
roles integer yes Roles is the number of configured roles in service - defined, applied and enabled. A gauge: a role deleted or disabled takes it down again.

bcunit

BcUnitStatus is the status of one board-controller Modbus connector, bc.bcunit.: its register-operation counters, cumulative since process start.

Field Type Required Meaning
rrcount integer yes RrCount counts single-register reads.
rrdurationcounter number yes RrDurationCounter is cumulative seconds spent in single-register reads.
rrerror integer yes RrError counts single-register reads that failed.
rrscount integer yes RrsCount counts multi-register reads.
rrsdurationcounter number yes RrsDurationCounter is cumulative seconds spent in multi-register reads.
rrserror integer yes RrsError counts multi-register reads that failed.
wrcount integer yes WrCount counts write-register operations.
wrdurationcounter number yes WrDurationCounter is cumulative seconds spent writing registers.
wrerror integer yes WrError counts write-register operations that failed.

bridge

BridgeStatus is a bridge's health, sys.bridge.: the traffic crossing the bridge interface itself, which is the sum over its ports rather than any one of them.

Field Type Required Meaning
bytesRxCounter integer BytesRxCounter is cumulative bytes received on the interface.
bytesTxCounter integer BytesTxCounter is cumulative bytes transmitted on the interface.
dropsRxCounter integer DropsRxCounter is cumulative received packets dropped, typically because no buffer was free.
dropsTxCounter integer DropsTxCounter is cumulative outbound packets dropped before transmission.
errorsRxCounter integer ErrorsRxCounter is cumulative receive errors the driver reported. Rising alongside traffic points at the link - cabling, signal, a duplex mismatch - where drops point at the host not keeping up.
errorsTxCounter integer ErrorsTxCounter is cumulative transmit errors the driver reported.
interfaceName string InterfaceName is the kernel device the counters were read from, so a reader can tell which device a config resolved to. Absent with the counters.
packetsRxCounter integer PacketsRxCounter is cumulative packets received.
packetsTxCounter integer PacketsTxCounter is cumulative packets transmitted.
status integer (enum) yes Status is the connection's health: DISABLED while disabled and inactive, WAIT while activating, OK once active, ERROR when the configuration and the live connection disagree - an enabled profile that is not up (the activation failed, or the link went down), or a disabled one that still is. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.

bytesreader

BytesReaderStatus is the status of the serial frame reader, .bytesreader.main: its read/frame flow and failure counters, cumulative since process start unless noted.

Field Type Required Meaning
bytesRead integer yes BytesRead counts bytes read.
dataSourceNotFoundErrorCount integer yes DataSourceNotFoundErrorCount counts frames addressed to an unknown data source.
frameCounter integer yes FrameCounter counts frames extracted.
frameDeserializationErrorCount integer yes FrameDeserializationErrorCount counts frames that failed to deserialize.
frameErrorCounter integer yes FrameErrorCounter counts malformed frames.
framesBufferSize integer yes FramesBufferSize is the number of frames currently buffered - a gauge.
inflightFrameCounter integer yes InflightFrameCounter is the number of extracted frames not yet consumed - a gauge.
invalidInputChannelErrorCount integer yes InvalidInputChannelErrorCount counts frames addressed to an unknown input channel.
readCounter integer yes ReadCounter counts reads from the underlying byte stream.

channel

ChannelStatus is the status of one data channel, .channel.: its health, and its frame flow and failure counters, all cumulative since process start.

Field Type Required Meaning
channelFrameEncErrorCounter integer yes ChannelFrameEncErrorCounter counts frames that failed to encode.
channelFrameInCounter integer yes ChannelFrameInCounter counts frames entering the channel.
channelFrameOutCounter integer yes ChannelFrameOutCounter counts frames leaving the channel.
channelFrameProcErrorCounter integer yes ChannelFrameProcErrorCounter counts frames the channel's processors failed on.
channelQueueDepth integer yes ChannelQueueDepth is the number of frames currently queued - a gauge.
channelQueueDropCounter integer yes ChannelQueueDropCounter counts frames dropped because the queue was full.
status integer (enum) yes Status is the channel's health: DISABLED while the channel is configured off, WAIT while its source has not delivered a first frame yet, ERROR while a processor or the encoder is failing or while the source's ingress is, OK once frames are flowing through it. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.

chproc_frameValidator

FrameValidatorStatus is the status of one frame-validator processor, .dsproc_frameValidator. or .chproc_frameValidator.: what it saw and what it refused, cumulative since process start.

Field Type Required Meaning
totalFrames integer yes TotalFrames counts frames seen.
totalInvalidFramesDescriptor integer yes TotalInvalidFramesDescriptor counts frames refused for a descriptor mismatch.
totalInvalidFramesFrequency integer yes TotalInvalidFramesFrequency counts frames refused for a frequency mismatch.
totalInvalidFramesStruct integer yes TotalInvalidFramesStruct counts frames refused for a structural fault.
totalSamples integer yes TotalSamples counts samples seen.
totalValidFrames integer yes TotalValidFrames counts frames that passed validation.

chproc_resampler

ResamplerStatus is the status of one resampler processor, .dsproc_resampler. or .chproc_resampler., whichever resampling strategy the config chose: how much it corrected, cumulative since process start.

Field Type Required Meaning
samples_added integer yes SamplesAdded counts samples inserted to correct drift.
samples_removed integer yes SamplesRemoved counts samples dropped to correct drift.
total_samples integer yes TotalSamples counts samples that passed through.

chronyapp

ChronyAppStatus is the time-synchronization state, chrony.chronyapp.main: the health of the system clock, the NTP-disciplined virtual clock and the PPS reference, plus their numeric readings.

Field Type Required Meaning
ppsStatus integer (enum) yes PpsStatus is OK while the reference is stratum 1 - a local PPS source. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.
stratum integer Stratum is the NTP stratum; absent while chrony reports no system variables.
sysClockOffset number SysClockOffset is the system clock's correction in seconds; absent while chrony cannot be queried.
sysClockStatus integer (enum) yes SysClockStatus is OK while the system clock's correction is under 100 ms. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.
virtClockOffset number VirtClockOffset is the virtual clock's offset in seconds; absent with stratum.
virtClockStatus integer (enum) yes VirtClockStatus is OK while synchronized (stratum above 0) with an offset under 10 ms. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.

cmd

CmdPublisherStatus is the status of the trigger module's command publisher, trigger.cmd.publisher: the outgoing side every command action goes through.

Field Type Required Meaning
lastCmdsHistory integer yes LastCmdsHistory is the number of commands currently tracked in the publisher's minWaitPeriod deduplication history - a gauge; stale entries are pruned as new commands arrive.

dsource

DataSourceStatus is the status of one data source, .dsource.: how many channels it drives and whether its ingress is failing.

Field Type Required Meaning
channels integer yes Channels is the number of data channels the source currently drives.
ingressErrorCounter integer yes IngressErrorCounter counts ingress read errors since process start.
status integer (enum) yes Status is the source's ingress health: WAIT until the first frame arrives, ERROR while reading the source is failing, OK once frames are flowing. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.

dsproc_frameValidator

FrameValidatorStatus is the status of one frame-validator processor, .dsproc_frameValidator. or .chproc_frameValidator.: what it saw and what it refused, cumulative since process start.

Field Type Required Meaning
totalFrames integer yes TotalFrames counts frames seen.
totalInvalidFramesDescriptor integer yes TotalInvalidFramesDescriptor counts frames refused for a descriptor mismatch.
totalInvalidFramesFrequency integer yes TotalInvalidFramesFrequency counts frames refused for a frequency mismatch.
totalInvalidFramesStruct integer yes TotalInvalidFramesStruct counts frames refused for a structural fault.
totalSamples integer yes TotalSamples counts samples seen.
totalValidFrames integer yes TotalValidFrames counts frames that passed validation.

dsproc_resampler

ResamplerStatus is the status of one resampler processor, .dsproc_resampler. or .chproc_resampler., whichever resampling strategy the config chose: how much it corrected, cumulative since process start.

Field Type Required Meaning
samples_added integer yes SamplesAdded counts samples inserted to correct drift.
samples_removed integer yes SamplesRemoved counts samples dropped to correct drift.
total_samples integer yes TotalSamples counts samples that passed through.

ethernet

EthernetStatus is a wired connection's health, sys.ethernet..

Field Type Required Meaning
bytesRxCounter integer BytesRxCounter is cumulative bytes received on the interface.
bytesTxCounter integer BytesTxCounter is cumulative bytes transmitted on the interface.
dropsRxCounter integer DropsRxCounter is cumulative received packets dropped, typically because no buffer was free.
dropsTxCounter integer DropsTxCounter is cumulative outbound packets dropped before transmission.
errorsRxCounter integer ErrorsRxCounter is cumulative receive errors the driver reported. Rising alongside traffic points at the link - cabling, signal, a duplex mismatch - where drops point at the host not keeping up.
errorsTxCounter integer ErrorsTxCounter is cumulative transmit errors the driver reported.
interfaceName string InterfaceName is the kernel device the counters were read from, so a reader can tell which device a config resolved to. Absent with the counters.
packetsRxCounter integer PacketsRxCounter is cumulative packets received.
packetsTxCounter integer PacketsTxCounter is cumulative packets transmitted.
status integer (enum) yes Status is the connection's health: DISABLED while disabled and inactive, WAIT while activating, OK once active, ERROR when the configuration and the live connection disagree - an enabled profile that is not up (the activation failed, or the link went down), or a disabled one that still is. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.

filecache

FileCacheStatus is the artifact cache's totals, sys.filecache.main (RFC-032): how much of the budget is held - by the cache, and by the directory it shares with everything else stored there - and whether the cache is under pressure.

Field Type Required Meaning
cacheArtifacts integer yes CacheArtifacts is how many artifacts are stored, likewise a gauge.
cacheBytes integer yes CacheBytes is the live size of the cache in bytes. A gauge, not a counter: eviction and sweeping make it fall.
cacheEvictionCounter integer yes CacheEvictionCounter counts artifacts removed to make room since process start - the signal that the cache had to shrink to admit something. The two gauges look the same whether the cache is comfortable or thrashing.
dirBytes integer yes DirBytes is the size of the whole non-volatile file directory, which is the number the directory budget is measured against: the cache plus everything else kept there, such as content a file: url names under the managed root. Above cacheBytes by that difference, and the reason a file can be refused for want of room while the cache itself looks small. The cache part of it is live; the rest is as of the last time a file config was applied.

flow

FlowStatus is the measurement lifecycle's state, flower.flow.main: whether a Measurement is currently active.

Field Type Required Meaning
activeMeasurements integer yes ActiveMeasurements is 1 while a Measurement is active, 0 otherwise.

gpsapp

GpsAppStatus is the GPS receiver's state, gps.gpsapp.main: fix health, message recency, satellite counts and the last position solution.

Field Type Required Meaning
addDataErrorCounter integer yes AddDataErrorCounter counts data samples the GPS source failed to ingest.
alt number yes Alt is the last altitude, in meters.
climb number yes Climb is the last climb rate, in meters per second.
frequency number yes Frequency is the navigation rate measured on the position stream, in Hz; 0 while nothing has been measured since the receiver was last configured. The configured rate is the gpsapp config's frequency; this is what the receiver actually delivers.
lat number yes Lat is the last latitude, in degrees.
lon number yes Lon is the last longitude, in degrees.
nSat integer yes NSat is the number of satellites in view, forced to 0 while the satellite-view report is older than 10 seconds.
since2dFix integer yes Since2dFix is seconds since the last 2D fix; -1 never.
since3dFix integer yes Since3dFix is seconds since the last 3D fix; -1 never.
sinceSKY integer yes SinceSKY is seconds since the last satellite-view (SKY) report; -1 never.
sinceTPV integer yes SinceTPV is seconds since the last position (TPV) report; -1 never.
speed number yes Speed is the last ground speed, in meters per second.
status integer (enum) yes Status is the fix health: OK on a 3D fix, WAIT on a 2D fix, ERROR otherwise. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.
track number yes Track is the last course over ground, in degrees.
uSat integer yes USat is the number of satellites used in the solution, forced to 0 while the position report is older than 10 seconds.

gsm

GsmStatus is the status of one GSM connection, sys.gsm.: the connection's health plus the modem's radio and messaging figures.

Field Type Required Meaning
bearers integer Bearers is the number of data bearers the modem currently holds.
bytesRxCounter integer BytesRxCounter is cumulative bytes received on the interface.
bytesTxCounter integer BytesTxCounter is cumulative bytes transmitted on the interface.
dropsRxCounter integer DropsRxCounter is cumulative received packets dropped, typically because no buffer was free.
dropsTxCounter integer DropsTxCounter is cumulative outbound packets dropped before transmission.
errorsRxCounter integer ErrorsRxCounter is cumulative receive errors the driver reported. Rising alongside traffic points at the link - cabling, signal, a duplex mismatch - where drops point at the host not keeping up.
errorsTxCounter integer ErrorsTxCounter is cumulative transmit errors the driver reported.
imei string Imei is the modem's International Mobile Equipment Identity, the 15-digit number identifying the hardware itself. It is independent of the SIM and survives a modem reset, so it says which physical modem every other figure here is about. Absent where the modem reports none, which is the case for a modem that failed before it was fully probed.
interfaceName string InterfaceName is the kernel device the counters were read from, so a reader can tell which device a config resolved to. Absent with the counters.
modemFailedReason integer ModemFailedReason is the modem service's own reason code for a failed modem, passed through untranslated: 0 none, 1 unknown, 2 sim-missing, 3 sim-error, 4 unknown-capabilities, 5 esim-without-profiles. Absent while the modem has not failed. It is the unabridged reading behind a modemFault of other.
modemFault integer (enum) yes ModemFault is why the connection has no usable modem - no modem at all, no SIM, an unreadable SIM, or a SIM waiting to be unlocked. none while the modem and its SIM are healthy, which is the normal value whether or not the link is up. Always reported, including while the connection is down, so an empty SIM tray is distinguishable from a coverage problem. Values: 0=none, 1=noModem, 2=simMissing, 3=simError, 4=simPin, 5=simPuk, 6=networkLock, 7=other.
modemResetCounter integer ModemResetCounter counts modem reset attempts since process start.
modemResetErrCounter integer ModemResetErrCounter counts modem reset attempts that failed.
modemState integer ModemState is the modem's state in ModemManager's MMModemState vocabulary, passed through untranslated: -1 failed, 0 unknown, 1 initializing, 2 locked, 3 disabled, 6 enabled, 7 searching, 8 registered, 10 connecting, 11 connected.
packetsRxCounter integer PacketsRxCounter is cumulative packets received.
packetsTxCounter integer PacketsTxCounter is cumulative packets transmitted.
signalQuality integer SignalQuality is the modem's signal strength in percent (0-100), 0 where the modem reports its reading as stale.
sms_sent_failure integer SmsSentFailure counts SMS send attempts that failed.
sms_sent_success integer SmsSentSuccess counts SMS messages sent successfully since process start.
status integer (enum) yes Status is the connection's health: DISABLED while disabled and inactive, WAIT while activating, OK once active, ERROR when the configuration and the live connection disagree - an enabled profile that is not up (the activation failed, or the link went down), or a disabled one that still is. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.

httpendpoint

HttpEndpointStatus is the request totals of one HTTP endpoint, .httpendpoint., cumulative since process start: one counter per outcome a request addressed to the endpoint can have.

Field Type Required Meaning
accepted integer yes Accepted counts requests answered 202 whose http_request_received event was published.
authnErrors integer yes AuthnErrors counts requests refused 401 because the credential was missing or not accepted.
publishErrors integer yes PublishErrors counts requests refused 503 because the event could not be published.
rateLimited integer yes RateLimited counts requests refused 429 by a rate limit, including the limit on repeated failed authentication.
sinceLastAccepted integer yes SinceLastAccepted is seconds since the endpoint last accepted a request, or -1 while it has accepted none since process start. Refused requests do not reset it, so a sender that has gone silent shows here even while something else keeps failing against the endpoint.
tooLarge integer yes TooLarge counts requests refused 413 because the body exceeded the size limit.
unavailable integer yes Unavailable counts requests refused 503 because the endpoint was not ready to serve, for example while its secret was not yet delivered.

httpserver

HttpServerStatus is the response totals of a module's HTTP server, .httpserver.main, cumulative since process start.

Field Type Required Meaning
notFound integer yes NotFound counts requests answered 404 Not Found.

kubepod

KubePodStatus is the status of one sandboxed pod, sandbox.kubepod..

Field Type Required Meaning
status integer (enum) yes Status is the pod's health as the sandbox derives it from the pod inventory. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.

led

LedStatus is the status of one LED indicator, sys.led.: one field per element the indicator is configured with, carrying the pattern that element is commanded to show.

Field Type Required Meaning
green integer (enum) Green is the green element's commanded pattern. Values: 0=unknown, 1=off, 2=on, 3=blink.
red integer (enum) Red is the red element's commanded pattern. Values: 0=unknown, 1=off, 2=on, 3=blink.
yellow integer (enum) Yellow is the yellow element's commanded pattern. Values: 0=unknown, 1=off, 2=on, 3=blink.

lorastats

LoraStatsStatus is one LoRa device's frame-counter validation totals, chrp.lorastats.D, cumulative since process start.

Field Type Required Meaning
accepted integer yes Accepted counts uplinks accepted by the frame-counter validation.
dropped integer yes Dropped counts uplinks dropped as replays or duplicates.
resets integer yes Resets counts device frame-counter resets observed.
wraps integer yes Wraps counts 16-bit frame-counter wrap-arounds observed.

mdispatcher

MDispatcherStatus is the status of the recorder's measurement dispatcher, .mdispatcher.main.

Field Type Required Meaning
activeSinks integer yes ActiveSinks is the number of sinks currently dispatched to.

netprobe

NetprobeStatus is the health of one connectivity probe, sys.netprobe.: monotonic attempt counters and the recent-outcome mask (RFC-037).

Field Type Required Meaning
interval integer yes Interval is the probe cadence in seconds, echoed from the configuration so one measurement is interpretable on its own.
probeCounter integer yes ProbeCounter counts probe attempts.
rttUsCounter integer yes RttUsCounter is the cumulative round-trip time of successful attempts, in microseconds: the average RTT over any span is its delta divided by successCounter's delta over the same span.
sinceTimestamp integer yes SinceTimestamp is when the current unbroken run of identical attempt outcomes began, as a Unix timestamp in seconds - with the newest mask bit 0 it reads "failing since", with 1 "healthy since". Zero until the first attempt. It makes duration policy stateless in a rule: proc_timestamp().Unix() - sinceTimestamp > 600 is "held for 10 minutes".
status integer (enum) yes Status is the probe's own operability: OK while attempts can be made, ERROR while they cannot even be launched (socket refused, interface unresolvable). A dead but probeable path is OK - that evidence is in the counters, not here - and DISABLED reports a disabled config. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.
successCounter integer yes SuccessCounter counts attempts that succeeded.
successMask string yes SuccessMask is the outcome of the 64 most recent attempts as a bitmask in fixed-width lowercase hex (16 characters): the newest attempt is the lowest bit, 1 means success, and only the low min(probeCounter, 64) bits are valid. Convert with the trigger expression helper hex_int.
timeoutCounter integer yes TimeoutCounter counts attempts that failed by timing out: nothing answered within the configured timeout. Attempts that were refused or could not be launched are the remainder, probeCounter - successCounter - timeoutCounter.

recstorage

RecStorageStatus is the status of the recording storage singleton, .recstorage.main (RFC-015, RFC-017).

Field Type Required Meaning
capacityBytes integer CapacityBytes is the recording filesystem's capacity, in bytes; absent while disk usage cannot be read.
capacityUsage integer CapacityUsage is the whole filesystem's fill, in percent.
classState integer (enum) yes ClassState is the medium classification. Values: 0=unknown, 1=disabled, 2=recognized, 3=foreign, 4=unclaimed, 5=not_writable, 6=allowlist_miss, 7=invalid_config.
compactCounter integer CompactCounter is the number of lifecycle journal compactions; absent while no journal is open.
completedCounter integer yes CompletedCounter is the number of Recordings completed since process start.
completionBacklog integer yes CompletionBacklog is the depth of the completion queue awaiting catalog and export processing.
deletedCounter integer yes DeletedCounter is the number of Recordings retention deleted since process start.
freeBytes integer FreeBytes is the recording filesystem's free space, in bytes; absent while disk usage cannot be read.
mediumId string MediumId identifies the recording medium; absent while unknown.
recordingBytes integer yes RecordingBytes is the total size of the catalogued Recordings, in bytes - a live gauge, like recordingsCataloged.
recordingStatus integer (enum) yes RecordingStatus is the recording activity: DISABLED when off, WAIT while enabled but idle or mid-reconfiguration, OK while a recording is actively running. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.
recordingUsage integer RecordingUsage is the catalogued Recordings' share of the filesystem's capacity, in percent - the quantity the maxRecordingUsage bound compares against, unlike capacityUsage.
recordingsCataloged integer yes RecordingsCataloged is the number of Recordings currently catalogued. A live gauge, not a counter: retention can hold it steady or shrink it. Named to pair with the maxRecordingBytes / maxRecordingUsage config bounds.
status integer (enum) yes Status is the storage health: DISABLED while recstorage is configured off, ERROR while the recording write path is latched on a failure, OK otherwise. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.

remoteconn

RemoteConnStatus is the status of one of the gate's remote NATS connections, gate.remoteconn.: whether the target is connected and how much has flowed to it.

Field Type Required Meaning
authnErrors integer yes AuthnErrors counts times the remote refused this target's credentials at connect - authentication, so the connection never came up and sinceLastConnected stays -1. Its counterpart is authzErrors, which counts a credential the remote accepted publishing on a subject it does not authorize.
authzErrors integer yes AuthzErrors counts publishes the remote refused for this target's credentials - authorization, so the connection is up and it is the subject that was not permitted. Its counterpart is authnErrors below.
bytesIn integer BytesIn counts bytes received.
bytesOut integer BytesOut counts bytes sent.
enabled boolean yes Enabled is whether the target is enabled in its gate config.
msgIn integer MsgIn counts messages received over the connection since it was created. The five connection counters are read off the live connection and are absent while the target is disabled or has no connection.
msgOut integer MsgOut counts messages sent.
msgsBufferSize integer yes MsgsBufferSize is the number of messages buffered for this target while it is not deliverable - a gauge.
msgsDropped integer yes MsgsDropped counts the messages this connection lost since process start: overwritten in its own buffer, or dropped before reaching it while the module was behind.
msgsPublishErr integer yes MsgsPublishErr counts this connection's publishes to the remote that failed, since process start.
reconnects integer Reconnects counts the connection's reconnects.
sinceLastConnected integer yes SinceLastConnected is seconds since the connection was last seen connected, or -1 while it has not been seen connected since process start.
status integer (enum) yes Status is the connection's health: OK connected with no publish failing, WAIT (re)connecting or draining, ERROR disconnected, refused by the remote's permissions, or connected while a publish has failed and none has been acknowledged since, DISABLED while the target is disabled or has no connection object. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.

retxdsource

RetxDsourceStatus is the status of one RET input source, retx.retxdsource.: what the MCU reported for it.

Field Type Required Meaning
mcuFrameCounter integer yes McuFrameCounter counts frames the MCU sent for this source since process start.
mcuFrameTimer integer yes McuFrameTimer is the MCU's timer at the last frame, in microseconds.

runner

RunnerStatus is the status of a module's config command runner, .runner.main: the supervised process's health and lifecycle counters.

Field Type Required Meaning
killCount integer yes KillCount counts processes the runner killed.
reconfigureCount integer yes ReconfigureCount counts reconfigurations applied to the process.
startCount integer yes StartCount counts process starts since module start.
status integer (enum) yes Status is the supervised process's health: OK running, WAIT restarting after an exit, ERROR failed to start, UNKNOWN before the first start. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.

s3upload

S3UploadStatus is the status of one s3upload export profile (RFC-024), published under the profile's config component ref.

Field Type Required Meaning
errorReason integer (enum) ErrorReason is why the last run halted; none while no run has halted. Values: 0=none, 1=absent, 2=readonly, 3=permission, 4=nospace, 5=gone, 6=verify, 7=manifest, 8=unclaimed, 9=foreign, 10=other.
exportState integer (enum) yes ExportState is where the profile's run currently stands. Values: 0=unknown, 1=disabled, 2=absent, 3=notWritable, 4=preparing, 5=exporting, 6=complete, 7=error, 8=unclaimed, 9=foreign, 10=idle.
exported integer Exported is the number of Recordings exported.
failed integer Failed is the number of Recordings whose export failed.
pending integer Pending is the number of Recordings not yet exported and not skipped.
pendingBytes integer PendingBytes is the total size of the pending Recordings, in bytes.
purgedBeforeExport integer PurgedBeforeExport is the number of Recordings retention deleted before they were exported.
runBytesCopied integer RunBytesCopied is the number of bytes the run copied.
runConflicts integer RunConflicts is the number of destination name conflicts the run refused.
runCopyMs integer RunCopyMs is the time the run spent copying, in milliseconds.
runExported integer RunExported is the number of Recordings the run exported.
runFailed integer RunFailed is the number of Recordings the run failed to export.
runFinished integer RunFinished is when the run closed, in Unix seconds; 0 while none has closed.
runId string RunId identifies the current or last run; empty while no run has ever opened.
runSkipped integer RunSkipped is the number of Recordings the run set aside.
runStarted integer RunStarted is when the run opened, in Unix seconds; 0 while no run has opened.
skipped integer Skipped is the number of Recordings the current run set aside.
status integer (enum) yes Status is the profile's health. ERROR while the profile is paused on a permanent failure or export is suspended, DISABLED for a disabled profile, WAIT while a run halted on a medium failure. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.

sink

SinkStatus is the status of one recording sink, .sink.: the Measurement's channels in aggregate.

Field Type Required Meaning
active integer yes Active is the number of channels actively receiving data.
channelTimeSkewMs integer yes ChannelTimeSkewMs is the spread between the oldest and newest active channel's last data, in milliseconds; 0 with fewer than two active channels.
channels integer yes Channels is the number of channels the sink currently holds.
concurrentDrains integer yes ConcurrentDrains is the number of drains in flight across all channels.
dataGap integer yes DataGap is 1 once a data consumer's start predated retained history (RFC-018) - expected when a continuous Measurement resumes after a restart. Latched for the Measurement's lifetime so it survives last-value telemetry compaction.
finishing integer yes Finishing is the number of channels writing their final part.
preStartDropped integer yes PreStartDropped is the number of delivered-but-discarded pre-start batches (seek overshoot, RFC-018).
stale integer yes Stale is the number of channels with nothing arriving.

sinkchannel

SinkChannelStatus is the status of one recording sink channel, .sinkchannel..

Field Type Required Meaning
concurrentDrains integer yes ConcurrentDrains is the number of drains in flight on this channel.
lastTimestamp string yes LastTimestamp is the channel's newest data timestamp, RFC 3339 with nanosecond precision; the zero time while no data has arrived.
status integer (enum) yes Status is where the channel stands, published as its enum index. Values: 0=active, 1=stale, 2=finishing.

store

ConfigStoreStatus is the configuration store's totals, cfg.store.main.

Field Type Required Meaning
pendingConfigs integer yes PendingConfigs is the number of config updates currently awaiting their module's answer - a gauge.
runningConfigs integer yes RunningConfigs is the number of config records the store holds - a gauge.

sysapp

SysAppStatus is the OS update state, sys.sysapp.main: what the device's update service (aktualizr) last reported.

Field Type Required Meaning
updateStatus integer (enum) yes UpdateStatus is the update service's state: UNKNOWN until a check has completed since boot, OK after a completed check, ERROR after a failed one. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.

system

SystemStatus is the host's own telemetry, sys.system.main: whole-device CPU, memory, storage health and filesystem fill, as distinct from any one process.

Field Type Required Meaning
bootCounter integer yes BootCounter counts device boots, persisted across them.
cpuIdleCounter integer yes CpuIdleCounter is cumulative idle time, in scheduler ticks.
cpuSystemCounter integer yes CpuSystemCounter is cumulative kernel-mode CPU time, in scheduler ticks.
cpuTotalCounter integer yes CpuTotalCounter is the sum of all CPU time accounting, in scheduler ticks.
cpuUserCounter integer yes CpuUserCounter is cumulative user-mode CPU time across all cores, in scheduler ticks (jiffies).
cpuWaitCounter integer yes CpuWaitCounter is cumulative I/O-wait time, in scheduler ticks.
diskIoInProgress integer DiskIoInProgress is the number of I/O operations currently in flight - a gauge, not a counter.
diskIoTimeMsCounter integer DiskIoTimeMsCounter is cumulative milliseconds spent doing I/O.
diskReadsCounter integer DiskReadsCounter counts completed reads on the primary storage device. The six disk fields come from one read and are absent together where the device's I/O accounting cannot be read.
diskSectorsReadCounter integer DiskSectorsReadCounter counts sectors read.
diskSectorsWrittenCounter integer DiskSectorsWrittenCounter counts sectors written.
diskWritesCounter integer DiskWritesCounter counts completed writes.
emmcLifeTimeA integer EmmcLifeTimeA is the eMMC's device life time estimate for type A cells (eMMC spec: 0x01 = 0-10% used through 0x0B = over 100%). Absent with EmmcPreEol where the eMMC health cannot be read.
emmcPreEol integer EmmcPreEol is the eMMC's pre-end-of-life indicator (eMMC spec: 1 normal, 2 warning, 3 urgent).
memAvail integer yes MemAvail is memory available for new workloads without swapping, in bytes.
memFree integer yes MemFree is unused physical memory, in bytes.
memTotal integer yes MemTotal is the host's physical memory, in bytes.
runFsAvail integer RunFsAvail is bytes available on the host's /run.
runFsTotal integer RunFsTotal is the host's /run tmpfs capacity in bytes; each filesystem's Total and Avail pair is absent where that mount cannot be statted.
serialNr string yes SerialNr is the serial number of the compute module itself, as the firmware reports it, or "unknown" where it cannot be read. It is not the hostname and not the serial of the carrier board the module is fitted to.
tmpFsAvail integer TmpFsAvail is bytes available on the sys container's /tmp.
tmpFsTotal integer TmpFsTotal is the sys container's own /tmp tmpfs capacity in bytes. This one is not a host filesystem: unless the deployment sets an explicit size it is the container runtime's default, which is a share of physical memory rather than a reservation.
uptime integer yes Uptime is seconds since the host booted.
varAlgolFsAvail integer VarAlgolFsAvail is bytes available on the persistent filesystem backing /var/algol.
varAlgolFsTotal integer VarAlgolFsTotal is the capacity in bytes of the persistent filesystem backing /var/algol - on a Torizon device the eMMC that also carries the OS deployment and the container images. Distinct from the recording and export media, which are separate mounts reported by their own components.
varVolatileFsAvail integer VarVolatileFsAvail is bytes available on the host's /var/volatile.
varVolatileFsTotal integer VarVolatileFsTotal is the host's /var/volatile tmpfs capacity in bytes.

systemdapp

SystemdUnitStatus is the status of one systemd-unit-backed component - sys.systemdscript., sys.systemdapp. or sys.systemdmount.: how often its configuration has been acted on since process start.

Field Type Required Meaning
startCount integer yes StartCount counts unit starts.
updateCount integer yes UpdateCount counts configuration updates applied to the unit.

systemdmount

SystemdUnitStatus is the status of one systemd-unit-backed component - sys.systemdscript., sys.systemdapp. or sys.systemdmount.: how often its configuration has been acted on since process start.

Field Type Required Meaning
startCount integer yes StartCount counts unit starts.
updateCount integer yes UpdateCount counts configuration updates applied to the unit.

systemdscript

SystemdUnitStatus is the status of one systemd-unit-backed component - sys.systemdscript., sys.systemdapp. or sys.systemdmount.: how often its configuration has been acted on since process start.

Field Type Required Meaning
startCount integer yes StartCount counts unit starts.
updateCount integer yes UpdateCount counts configuration updates applied to the unit.

systemdunit

HostUnitStatus is the running state of one host systemd unit algol addresses but did not create, sys.systemdunit. (RFC-039): what systemd says about the unit right now, and how often algol has been asked to act on it.

Field Type Required Meaning
activeSince integer yes ActiveSince is when the unit last entered its active state, as a Unix timestamp in seconds, and zero while it is not active. Uptime over any span is stateless in a rule: proc_timestamp().Unix() - activeSince.
autoRestartCounter integer AutoRestartCounter is how often systemd itself has restarted the unit, from its own NRestarts - the signal that a unit is flapping rather than being restarted by anybody. Absent for a unit type that keeps no such count, and while the unit is not loaded.
loadState string yes LoadState is whether systemd has the unit's definition: loaded, not-found, masked, bad-setting or error.
restartCounter integer yes RestartCounter counts restart commands sent.
startCounter integer yes StartCounter counts start commands algol has sent for this unit since the process started, whether or not systemd acted on them. The three command counters are what distinguishes a unit somebody keeps restarting from one that restarted itself.
status integer (enum) yes Status is the unit's operability: ERROR while it cannot be operated at all - systemd does not have it, or it is masked - and while it sits in the failed state. A unit that is merely stopped is OK, since being stopped is a state it is meant to reach; DISABLED reports a disabled config. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.
stopCounter integer yes StopCounter counts stop commands sent.
unitActive string yes UnitActive is systemd's active state for the unit: active, inactive, failed, activating, deactivating, or reloading.
unitFileState string yes UnitFileState is whether the unit starts at boot: enabled, disabled, static, masked, indirect, generated or transient. Empty where systemd reports none, which is what a unit with no install information gives.
unitSubState string yes UnitSubState is systemd's finer state within UnitActive, whose values depend on the unit type - running, exited or dead for a service, mounted for a mount.

teapot

TeapotStatus is a status for testing purposes only, mirroring event.TeapotPrepared: a registered type that is not a production contract, so the registry and the schema pipeline always have one to exercise.

Field Type Required Meaning
brewState integer yes BrewState is the current brewing phase, published as its enum index.
cupsPoured integer yes CupsPoured is the number of cups poured since process start.
lastBrewMs integer LastBrewMs is the duration of the last completed brew in milliseconds. Absent while no brew has completed.
status integer (enum) yes Status is the teapot's health. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.
waterTempC number yes WaterTempC is the water temperature in degrees Celsius.

trigger

TriggerStatus is the status of one trigger rule, trigger.trigger.: whether the rule is running and how it has fared since the module first saw it.

Field Type Required Meaning
actionFailures integer yes ActionFailures counts fired actions that returned an error.
actionsRun integer yes ActionsRun counts the actions that ran, one per action rather than one per match: a match over a composite of three counts three. A composite is a container and is not counted itself, only the members it runs.
actionsSkipped integer yes ActionsSkipped counts the actions a when or unless condition turned away. A skipped composite counts once, for the group - its members are never reached. A condition that fails to resolve is neither run nor skipped; it is an action error.
exprStoreSize integer ExprStoreSize is the number of entries in the rule's store_set expression state store. Absent for a rule whose matcher is not streamExpr, and while the rule is not running.
matches integer yes Matches counts evaluations that matched.
matchingFailures integer yes MatchingFailures counts evaluations that errored.
status integer (enum) yes Status is the rule's health: OK running, DISABLED disabled, WAIT parked on property resolution, ERROR failed to build. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.

triggerapp

TriggerAppStatus is the trigger module's rule inventory, trigger.triggerapp.main.

Field Type Required Meaning
triggers integer yes Triggers is the number of configured trigger rules.
triggersEnabled integer yes TriggersEnabled is how many of them are enabled.

usbexport

UsbExportStatus is the status of one usbexport export profile (RFC-024), published under the profile's config component ref.

Field Type Required Meaning
destinationCapacityBytes integer DestinationCapacityBytes is the destination filesystem's capacity, in bytes.
destinationFreeBytes integer DestinationFreeBytes is the destination filesystem's free space, in bytes.
destinationId string DestinationId is the configured destination identity acknowledgements are scoped to.
destinationUsage integer DestinationUsage is the destination filesystem's fill, in percent.
errorReason integer (enum) ErrorReason is why the last run halted; none while no run has halted. Values: 0=none, 1=absent, 2=readonly, 3=permission, 4=nospace, 5=gone, 6=verify, 7=manifest, 8=unclaimed, 9=foreign, 10=other.
exportState integer (enum) yes ExportState is where the profile's run currently stands. Values: 0=unknown, 1=disabled, 2=absent, 3=notWritable, 4=preparing, 5=exporting, 6=complete, 7=error, 8=unclaimed, 9=foreign, 10=idle.
exported integer Exported is the number of Recordings exported.
failed integer Failed is the number of Recordings whose export failed.
mediumId string MediumId identifies the medium in the export directory; empty while unknown.
pending integer Pending is the number of Recordings not yet exported and not skipped.
pendingBytes integer PendingBytes is the total size of the pending Recordings, in bytes.
purgedBeforeExport integer PurgedBeforeExport is the number of Recordings retention deleted before they were exported.
runBytesCopied integer RunBytesCopied is the number of bytes the run copied.
runConflicts integer RunConflicts is the number of destination name conflicts the run refused.
runCopyMs integer RunCopyMs is the time the run spent copying, in milliseconds.
runExported integer RunExported is the number of Recordings the run exported.
runFailed integer RunFailed is the number of Recordings the run failed to export.
runFinished integer RunFinished is when the run closed, in Unix seconds; 0 while none has closed.
runId string RunId identifies the current or last run; empty while no run has ever opened.
runSkipped integer RunSkipped is the number of Recordings the run set aside.
runStarted integer RunStarted is when the run opened, in Unix seconds; 0 while no run has opened.
skipped integer Skipped is the number of Recordings the current run set aside.
status integer (enum) yes Status is the profile's health. ERROR while the profile is paused on a permanent failure or export is suspended, DISABLED for a disabled profile, WAIT while a run halted on a medium failure. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.

wlan

WlanStatus is a wireless connection's health, sys.wlan.: whether the profile is up, what the radio is associated with, and the traffic over it.

Field Type Required Meaning
bitrate integer Bitrate is the rate the device is currently using, in kilobits per second. The rate the link negotiated, not the throughput of the traffic over it.
bssid string Bssid is the hardware address of the access point the radio is associated with. Where several access points share one ssid it is what says which of them is carrying the link, so a device that roamed is distinguishable from one that did not.
bytesRxCounter integer BytesRxCounter is cumulative bytes received on the interface.
bytesTxCounter integer BytesTxCounter is cumulative bytes transmitted on the interface.
dropsRxCounter integer DropsRxCounter is cumulative received packets dropped, typically because no buffer was free.
dropsTxCounter integer DropsTxCounter is cumulative outbound packets dropped before transmission.
errorsRxCounter integer ErrorsRxCounter is cumulative receive errors the driver reported. Rising alongside traffic points at the link - cabling, signal, a duplex mismatch - where drops point at the host not keeping up.
errorsTxCounter integer ErrorsTxCounter is cumulative transmit errors the driver reported.
frequency integer Frequency is the channel's centre frequency in MHz, which is also what says the band: about 2400 on 2.4 GHz, about 5000 on 5 GHz.
interfaceName string InterfaceName is the kernel device the counters were read from, so a reader can tell which device a config resolved to. Absent with the counters.
packetsRxCounter integer PacketsRxCounter is cumulative packets received.
packetsTxCounter integer PacketsTxCounter is cumulative packets transmitted.
signalStrength integer SignalStrength is the access point's signal strength in percent (0-100) as NetworkManager reports it. Not a dBm reading, and not convertible to one.
ssid string Ssid is the network the radio is associated with. What the link is actually on, which differs from the profile's ssid while a changed profile has not been applied yet.
status integer (enum) yes Status is the connection's health: DISABLED while disabled and inactive, WAIT while activating, OK once active, ERROR when the configuration and the live connection disagree - an enabled profile that is not up (the activation failed, or the link went down), or a disabled one that still is. Values: -3=DELETED, -2=DISABLED, -1=ERROR, 0=UNKNOWN, 1=OK, 2=WAIT.
wlanFault integer (enum) yes WlanFault is why the connection is not up - the network was not found, the key was refused, no address was obtained, or the wireless device the profile needs is not on the host or cannot be used. The first three are the reason NetworkManager gave for the last activation attempt; deviceUnavailable is read off the devices it knows and their state, and replaces that reason for as long as it holds - a radio that was powered off or switched off reports the radio, not what the last attempt through it failed on. none while nothing failed, which is what a connection that is up, a disabled one and one that was never attempted all report. Always reported, so a network that is out of range is distinguishable from one an operator took down. Values: 0=none, 1=ssidNotFound, 2=authFailed, 3=ipConfigFailed, 4=deviceUnavailable, 5=other.
wlanStateReason integer WlanStateReason is NetworkManager's own reason code for that failure, passed through untranslated (NMDeviceStateReason: 5 ip-config-unavailable, 7 no-secrets, 8-11 supplicant, 15-17 dhcp, 53 ssid-not-found). Absent where there is no such code: while wlanFault is none, and for a fault NetworkManager did not state at all, which is how a missing device is found. It is the unabridged reading behind a wlanFault of other.

Dynamic field sets

Declared free-form (RFC-029 D6): the fields are named by configuration or by the host, so there is no struct and no schema.

Component name Fields named by
bcreg the configured telemetry registers' attribute names