Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs/collector] Clarify stance with regards to third-party instrumentation #6195

Merged
merged 1 commit into from
Feb 20, 2025
Merged

[docs/collector] Clarify stance with regards to third-party instrumentation #6195

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions content/en/docs/collector/internal-telemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,9 @@ There are currently no metrics specific to `normal` verbosity.
{{% alert title="Note" color="info" %}} The `http_` and `rpc_` metrics come from
instrumentation libraries. Their original names use dots (`.`), but when
exposing internal metrics with Prometheus, they are translated to use
underscores (`_`) to match Prometheus' naming constraints.
underscores (`_`) to match Prometheus' naming constraints. These metrics are not
covered by the maturity levels below since they are not under the Collector SIG
control.

The `otelcol_processor_batch_` metrics are unique to the `batchprocessor`.

Expand All @@ -317,6 +319,10 @@ The Collector logs the following internal events:

## Telemetry maturity levels

The Collector telemetry levels apply to all first-party telemetry produced by
the Collector. Third-party libraries, including those of OpenTelemetry Go, are
not covered by these maturity levels.

### Traces

Tracing instrumentation is still under active development, and changes might be
Expand All @@ -326,10 +332,13 @@ guarantees of backwards compatibility for tracing instrumentation.

### Metrics

The Collector's metrics follow a four-stage lifecycle:
The Collector's first-party metrics follow a four-stage lifecycle:

> Alpha metric → Stable metric → Deprecated metric → Deleted metric

Third-party metrics, including those generated by OpenTelemetry Go
instrumentation libraries, are not covered by these maturity levels.

#### Alpha

Alpha metrics have no stability guarantees. These metrics can be modified or
Expand Down