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.

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

[extension/zpages] document unsupported none level #11016

Merged
merged 2 commits into from
Aug 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions extension/zpagesextension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
2 changes: 2 additions & 0 deletions extension/zpagesextension/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Loading