From 5c1c5a57601b902d0b1d371d3ed2db9d430011da Mon Sep 17 00:00:00 2001 From: Alex Boten <223565+codeboten@users.noreply.github.com> Date: Fri, 30 Aug 2024 07:42:56 -0700 Subject: [PATCH] [extension/zpages] document unsupported none level (#11016) Fix #10965 --------- Signed-off-by: Alex Boten <223565+codeboten@users.noreply.github.com> Co-authored-by: Pablo Baeyens --- extension/zpagesextension/README.md | 10 ++++++++++ extension/zpagesextension/metadata.yaml | 2 ++ 2 files changed, 12 insertions(+) diff --git a/extension/zpagesextension/README.md b/extension/zpagesextension/README.md index 60a5a5a1f25..5231e420ab2 100644 --- a/extension/zpagesextension/README.md +++ b/extension/zpagesextension/README.md @@ -5,6 +5,7 @@ | ------------- |-----------| | Stability | [beta] | | Distributions | [core], [contrib], [k8s] | +| Warnings | [The zPages extension is incompatible with `service::telemetry::traces::level` set to `none`](#warnings) | | Issues | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector?query=is%3Aissue%20is%3Aopen%20label%3Aextension%2Fzpages%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector/issues?q=is%3Aopen+is%3Aissue+label%3Aextension%2Fzpages) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector?query=is%3Aissue%20is%3Aclosed%20label%3Aextension%2Fzpages%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector/issues?q=is%3Aclosed+is%3Aissue+label%3Aextension%2Fzpages) | [beta]: https://github.com/open-telemetry/opentelemetry-collector#beta @@ -76,3 +77,12 @@ example They also allow you to quickly examine error samples Example URL: http://localhost:55679/debug/tracez + +## Warnings + +This extension registers a SpanProcessor to record all the spans created inside +the Collector. This depends on a TracerProvider that supports +the SDK methods RegisterSpanProcessor and UnregisterSpanProcessor. Setting +`service::telemetry::traces::level` to `none` configures a No-Op +TracerProvider that does not support these methods, and therefore the zPages +extension cannot work in this mode. diff --git a/extension/zpagesextension/metadata.yaml b/extension/zpagesextension/metadata.yaml index 8c379cb238a..8c150b3f7f8 100644 --- a/extension/zpagesextension/metadata.yaml +++ b/extension/zpagesextension/metadata.yaml @@ -6,3 +6,5 @@ status: stability: beta: [extension] distributions: [core, contrib, k8s] + warnings: + - The zPages extension is incompatible with `service::telemetry::traces::level` set to `none` \ No newline at end of file