Sign in
OTel

Instance-wide Cloud telemetry write status.

Changed on
get/otel/cloud-telemetry/status

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/otel/cloud-telemetry/status
  • Auth: HTTP bearer

Response

Instance Cloud telemetry write status

can_decommission_local_span_storeboolean required

Whether the console should offer decommission guidance. True only when local_span_store_required is false — the ADR is explicit that the advice must not appear before then.

cloud_primary_projectsinteger required
configuredboolean required

Whether Cloud-primary writes can be used at all on this instance.

dead_lettered_rowsinteger required

Rows that exhausted their retries. Never swept automatically; an operator has to see them.

local_history_untilstring date-time nullable
local_mode_projectsinteger required
local_span_store_reasonstring nullable
local_span_store_requiredboolean required

The derived decommission signal. true means the operator gets zero resource win from removing their local span store, whatever the write modes say.

oldest_unshipped_age_secsinteger nullable

Age of the oldest unshipped span, in seconds. None when the queue is empty — different from zero, and it must not render as zero.

queue_bytesinteger required
queue_depthinteger required

Spans queued for Cloud across all projects.

queue_max_bytesinteger required

The operator-set ceiling, so the depth above is readable against something rather than being a number with no scale.

reasonstring nullable
setup_pathstring nullable
write_suspensionstring nullable

Set while Cloud-primary writes are falling back to local storage.

Changes

  • 4b228ebed583Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1dc3e6788214Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status