Sign in
OTel

A project's Cloud telemetry write mode and fidelity.

Changed on
get/otel/cloud-telemetry/projects/{project_id}

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/projects/{project_id}
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Project ID

Response

Project Cloud telemetry settings

analytics_write_mode'local' | 'cloud' required

Per-project destination for analytics and metrics writes (ADR-043 §1).

attribute_allowliststring[] required
cloud_write_mode_availableboolean required

Whether write_mode = cloud could be set right now.

false is the normal state on an unlinked instance and must render as onboarding, not as an error.

dead_lettered_spansinteger required

Spans this instance accepted for this project and gave up on delivering.

The instance-wide card only shows a count; this route is already scoped to one project, so it can say why without exposing another tenant's failures.

delivery_failingboolean required

Whether delivery to Temps Cloud is failing for this project now: spans that already failed an attempt are still being retried.

This, not dead_lettered_spans, is what decides whether the console shows an alert. Dead letters are a permanent record of a past loss and stay non-zero after the instance recovers; an alert driven by them tells a healthy instance it is broken, forever.

delivery_failing_sincestring date-time nullable

When the oldest span still being retried reached this instance.

delivery_failure_actionstring nullable

What the operator has to do to end the failure, when it is something they can fix — today, re-enrolling after Cloud rejected the credential.

delivery_failure_errorstring nullable

Why the most recent attempt failed, while delivery_failing.

delivery_failure_setup_pathstring nullable
delivery_gaps_truncatedboolean required

Whether older delivery gaps exist beyond the ones listed. Their spans are still counted in dead_lettered_spans, so a client can say how many older undelivered spans the list leaves out rather than presenting it as complete.

effective_reason'operator' | 'cloud_disconnected' | 'quota_exhausted' | 'credential_rejected' | 'queue_overflow_spill' | 'cloud_recovered'

Why an interval opened.

effective_reason_messagestring nullable
effective_write_mode'local' | 'cloud' required

Per-project destination for span writes.

fidelity'metered' | 'queryable' required

Per-project fidelity tier for the optional Temps Cloud telemetry mirror.

last_dead_letter_atstring date-time nullable
last_dead_letter_errorstring nullable

The reason the most recent give-up gave, if there is one.

Delivery metadata only — this instance's own bounded error string. It is never the span payload, and this field must not become a place one appears.

project_idinteger required
queued_spansinteger required

Spans queued for Cloud for this project and not yet acknowledged.

reasonstring nullable

The single most relevant missing prerequisite, when cloud_write_mode_available is false.

retrying_spansinteger required

Spans that failed at least one attempt and are still being retried.

setup_pathstring nullable
write_mode'local' | 'cloud' required

Per-project destination for span writes.

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

    • 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

    • 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 required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 1dc3e6788214Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required 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

    • 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

    • 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