-
Notifications
You must be signed in to change notification settings - Fork 110
Add troubleshooting page for propagating client metadata with EDOT #2057
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
Open
alexandra5000
wants to merge
3
commits into
elastic:main
Choose a base branch
from
alexandra5000:metadata
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
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
81 changes: 81 additions & 0 deletions
81
troubleshoot/ingest/opentelemetry/edot-collector/metadata.md
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 |
---|---|---|
@@ -0,0 +1,81 @@ | ||
--- | ||
navigation_title: Collector doesn’t propagate metadata | ||
description: Learn why the Collector doesn’t extract custom attributes and how to propagate such values using EDOT SDKs. | ||
applies_to: | ||
stack: | ||
serverless: | ||
observability: | ||
product: | ||
edot_collector: ga | ||
products: | ||
- id: cloud-serverless | ||
- id: observability | ||
- id: edot-collector | ||
--- | ||
|
||
# EDOT Collector doesn’t propagate client metadata | ||
|
||
If your EDOT Collector doesn’t propagate metadata like `project_id`, `tenant`, or `environment`, you may be misunderstanding what “client metadata” means in Elastic Distributions of OpenTelemetry (EDOT). | ||
|
||
### What is client metadata | ||
|
||
In the context of the EDOT, client metadata refers to gRPC metadata or HTTP headers that accompany telemetry data sent by clients (usually SDKs) to the Collector. | ||
|
||
For example: | ||
|
||
- Authorization headers | ||
- Trace propagation headers | ||
- `user-agent` strings sent by HTTP clients or EDOT SDKs | ||
|
||
This is transport-level metadata, and not application-level context. | ||
|
||
### What isn’t client metadata | ||
|
||
In this context, client metadata does not include: | ||
|
||
- Custom attributes like `project_id`, `tenant`, or `environment` | ||
- Application business logic fields | ||
- Resource attributes | ||
|
||
## Symptoms | ||
|
||
Expected labels do not appear in Elastic APM or metric data. | ||
|
||
Your collector configuration file, for example `otel-config.yaml`, looks similar to this: | ||
|
||
```yaml | ||
receivers: | ||
otlp: | ||
protocols: | ||
http: | ||
endpoint: "0.0.0.0:4318" | ||
|
||
processors: | ||
resource: | ||
attributes: | ||
- key: project.id | ||
from_context: client_metadata | ||
action: insert | ||
``` | ||
|
||
This will not work, as the Collector doesn't automatically extract such values from headers. | ||
|
||
## Resolution | ||
|
||
If you want to propagate customer IDs or project names into spans or metrics, you must instrument this in your code using one of the SDKs. | ||
|
||
Use `span.set_attribute` in your application code, where OpenTelemetry spans are created. For example: | ||
|
||
```python | ||
from opentelemetry import trace | ||
|
||
tracer = trace.get_tracer(__name__) | ||
|
||
with tracer.start_as_current_span("handle_request") as span: | ||
span.set_attribute("project.id", get_project_id_from_context()) | ||
``` | ||
|
||
## Resources | ||
|
||
- [gRPC metadata documentation](https://grpc.io/docs/guides/concepts/#metadata) | ||
- [OpenTelemetry Protocol (OTLP) overview](https://opentelemetry.io/docs/specs/otlp/) |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.