-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Internal telemetry config options for OTLP export #5986
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -179,6 +179,69 @@ Note that the `tracer_provider` section there corresponds to `traces` here. | |||||||||||||||||||||||||
[kitchen-sink-config]: | ||||||||||||||||||||||||||
https://github.com/open-telemetry/opentelemetry-configuration/blob/main/examples/kitchen-sink.yaml | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
### Self-monitoring | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
The Collector can be configured to push its own telemetry to an | ||||||||||||||||||||||||||
[OTLP receiver](https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/otlpreceiver) | ||||||||||||||||||||||||||
and send the data through configured pipelines. In the following example, the | ||||||||||||||||||||||||||
Collector is configured to push metrics, traces, and logs every 10s using OTLP | ||||||||||||||||||||||||||
gRPC to `localhost:14317`: | ||||||||||||||||||||||||||
chalin marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
```yaml | ||||||||||||||||||||||||||
receivers: | ||||||||||||||||||||||||||
otlp/internal: | ||||||||||||||||||||||||||
protocols: | ||||||||||||||||||||||||||
grpc: | ||||||||||||||||||||||||||
endpoint: localhost:14317 | ||||||||||||||||||||||||||
exporters: | ||||||||||||||||||||||||||
debug: | ||||||||||||||||||||||||||
service: | ||||||||||||||||||||||||||
pipelines: | ||||||||||||||||||||||||||
metrics: | ||||||||||||||||||||||||||
receivers: [otlp/internal] | ||||||||||||||||||||||||||
exporters: [debug] | ||||||||||||||||||||||||||
traces: | ||||||||||||||||||||||||||
receivers: [otlp/internal] | ||||||||||||||||||||||||||
exporters: [debug] | ||||||||||||||||||||||||||
telemetry: | ||||||||||||||||||||||||||
metrics: | ||||||||||||||||||||||||||
readers: | ||||||||||||||||||||||||||
- periodic: | ||||||||||||||||||||||||||
interval: 10000 | ||||||||||||||||||||||||||
exporter: | ||||||||||||||||||||||||||
otlp: | ||||||||||||||||||||||||||
protocol: grpc/protobuf | ||||||||||||||||||||||||||
endpoint: http://localhost:14317 | ||||||||||||||||||||||||||
traces: | ||||||||||||||||||||||||||
processors: | ||||||||||||||||||||||||||
- batch: | ||||||||||||||||||||||||||
exporter: | ||||||||||||||||||||||||||
otlp: | ||||||||||||||||||||||||||
protocol: grpc/protobuf | ||||||||||||||||||||||||||
endpoint: http://localhost:14317 | ||||||||||||||||||||||||||
logs: | ||||||||||||||||||||||||||
processors: | ||||||||||||||||||||||||||
- batch: | ||||||||||||||||||||||||||
exporter: | ||||||||||||||||||||||||||
otlp: | ||||||||||||||||||||||||||
protocol: grpc/protobuf | ||||||||||||||||||||||||||
endpoint: http://localhost:14317 | ||||||||||||||||||||||||||
``` | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
{{% alert title="Caution" color="warning" %}} | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
When self-monitoring, the Collector collects its own telemetry and sends it to | ||||||||||||||||||||||||||
the desired backend for analysis. This can be a risky practice. If the Collector | ||||||||||||||||||||||||||
is underperforming, its self-monitoring capability could be impacted. As a | ||||||||||||||||||||||||||
result, the self-monitored telemetry might not reach the backend in time for | ||||||||||||||||||||||||||
critical analysis. | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Moreover, sending internal telemetry through the Collector's own pipelines can | ||||||||||||||||||||||||||
create a continuous loop of spans, metric points, or logs, putting undue strain | ||||||||||||||||||||||||||
on the Collector's performance. This setup should not be used in production. | ||||||||||||||||||||||||||
Comment on lines
+233
to
+241
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
{{% /alert %}} | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
## Types of internal telemetry | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
The OpenTelemetry Collector aims to be a model of observable service by clearly | ||||||||||||||||||||||||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, could we link to docs page, maybe docs/collector/configuration/#receivers. That page links out to the repo's receiver folder.
@theletterf @tiffany76 @open-telemetry/docs-approvers WDYT?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good to me, but I think @jade-guiton-dd's comment below is worth addressing first. This PR's content was purposely removed from the page in a previous PR, and there's been no call to add it back.