Skip to content

Define the OBI v1 telemetry contract #1759

@MrAlias

Description

@MrAlias

As part of v1.0, OBI needs an explicit decision about which emitted telemetry is stable.

Today, telemetry behavior exists in code, tests, and docs, but the v1 release needs a clear contract for what users can rely on across future releases.

Goal

Define and document the emitted telemetry surface that is part of the OBI v1 compatibility contract.

Scope

This should cover at least:

  • which spans and metrics are part of the stable v1 surface
  • which names, attributes, and units are stable
  • what telemetry remains experimental or outside the v1 contract
  • known caveats or limitations that must be documented for v1

This issue is broader than telemetry schema adoption alone.

Tasks

  • Define which emitted telemetry is stable at v1
  • Define which names, attributes, units, and semantics are part of the v1 contract
  • Identify telemetry that remains experimental or outside the v1 contract
  • Document known telemetry limitations that are acceptable for v1
  • Align or explicitly relate this work to telemetry schema work
  • Publish the resulting telemetry contract in the appropriate user-facing location(s)
  • Link the published contract from the v1.0 release epic

Related

Acceptance Criteria

  • The emitted telemetry that is stable at v1 is explicitly documented
  • Experimental or out-of-contract telemetry is clearly distinguished
  • Known telemetry caveats for v1 are documented
  • Maintainers agree this defines the telemetry compatibility baseline for v1.0

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions