Skip to main content

api.PipelineMetricSample

api.PipelineMetricSample API schema defining 8 fields, including bytes input, bytes output, execution id, and 5 more.

bytes_input object

BytesInput / BytesOutput are the pipeline.bytes.volume distributions (bytes) for the input and output stages.

countinteger
p95number
sumnumber

seconds for durations, bytes for volume

bytes_output object
countinteger
p95number
sumnumber

seconds for durations, bytes for volume

execution_idstring
orchestration_errorsinteger

OrchestrationErrors is the pipeline.orchestration.errors count over the batch interval.

pipeline_idstring
readiness object

Readiness is the pipeline.readiness.duration distribution (seconds).

countinteger
p95number
sumnumber

seconds for durations, bytes for volume

stages object[]

Stages carries per-stage throughput and latency, keyed by component_type (input / processor / output) -- the only per-point dimension kept.

  • Array [
  • component_typestring

    ComponentType is the pipeline stage: "input", "processor", or "output".

    errorsinteger
    latency object

    Latency is the stage latency distribution (seconds).

    countinteger
    p95number
    sumnumber

    seconds for durations, bytes for volume

    receivedinteger

    Received / Sent / Errors are message counts over the batch interval.

    sentinteger
  • ]
  • timestampstring

    Timestamp is the collection time on the edge (NOT arrival time), so a reconnect catch-up flush renders in the correct window rather than collapsing into a spike.

    api.PipelineMetricSample
    {
    "bytes_input": {
    "count": 0,
    "p95": 0,
    "sum": 0
    },
    "bytes_output": {
    "count": 0,
    "p95": 0,
    "sum": 0
    },
    "execution_id": "string",
    "orchestration_errors": 0,
    "pipeline_id": "string",
    "readiness": {
    "count": 0,
    "p95": 0,
    "sum": 0
    },
    "stages": [
    {
    "component_type": "string",
    "errors": 0,
    "latency": {
    "count": 0,
    "p95": 0,
    "sum": 0
    },
    "received": 0,
    "sent": 0
    }
    ],
    "timestamp": "string"
    }