Skip to main content

api.NodeResourceMetricsSnapshot

api.NodeResourceMetricsSnapshot API schema defining 2 fields, including connection state and samples.

connection_statestring
samples object[]
  • Array [
  • cpu_percentnumber
    disk_capacity_bytesinteger
    disk_percentnumber
    disk_used_bytesinteger
    memory_capacity_bytesinteger
    memory_percentnumber
    memory_used_bytesinteger
    process_usage object

    ProcessUsage is the edge agent process-level gauges carried from the heartbeat. It is nil when the edge predates the field (an older edge): the process series are then omitted rather than reported as a misleading zero, while a present-but-zero reading (a genuinely idle process) still serializes. It reproduces the OTLP process.cpu.utilization / process.memory.usage series.

    cpu_utilizationnumber

    CPUUtilization is the process CPU utilization ratio (0-1 per core, clamped to the CPU count), matching process.cpu.utilization.

    memory_used_bytesinteger

    MemoryUsedBytes is the process resident set size (RSS) in bytes, matching process.memory.usage.

    timestampstring
  • ]
  • api.NodeResourceMetricsSnapshot
    {
    "connection_state": "string",
    "samples": [
    {
    "cpu_percent": 0,
    "disk_capacity_bytes": 0,
    "disk_percent": 0,
    "disk_used_bytes": 0,
    "memory_capacity_bytes": 0,
    "memory_percent": 0,
    "memory_used_bytes": 0,
    "process_usage": {
    "cpu_utilization": 0,
    "memory_used_bytes": 0
    },
    "timestamp": "string"
    }
    ]
    }