-
Notifications
You must be signed in to change notification settings - Fork 57
Move Otel Collector guidelines from to opentelemetry-guidelines.md #318
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
Merged
tigrannajaryan
merged 1 commit into
open-telemetry:main
from
tigrannajaryan:tigran/otel-guidelines
Apr 29, 2026
+39
−22
Merged
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 |
|---|---|---|
| @@ -1,18 +1,47 @@ | ||
| # OpenTelemetry Guidelines | ||
|
|
||
| This document provides guidance for language instrumentation agents that use | ||
| OpAMP. | ||
| This document provides guidance for OpenTelemetry agents that use OpAMP. | ||
|
|
||
| ## Scope | ||
| ## Collector | ||
|
|
||
| This guidance is intended for OpenTelemetry Collector. | ||
|
|
||
| ### Identifying Attributes | ||
|
|
||
| The OpenTelemetry Collector SHOULD specify the following attributes in | ||
| `AgentDescription.identifying_attributes`: | ||
|
|
||
| - `service.name` should be set to the same value that the Agent uses in its own telemetry. | ||
| - `service.namespace` if it is used in the environment where the Agent runs. | ||
| - `service.version` should be set to version number of the Agent build. | ||
| - `service.instance.id` should be set. It may be set equal to the Agent's | ||
| instance uid (equal to ServerToAgent.instance_uid field) or any other value | ||
| that uniquely identifies the Agent in combination with other attributes. | ||
| - any other attributes that are necessary for uniquely identifying the Agent's | ||
| own telemetry. | ||
|
Comment on lines
+20
to
+21
Member
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. Do we still need this given #312? |
||
|
|
||
| These values SHOULD match the values that the Collector uses in the Resource of its | ||
| own telemetry. | ||
|
|
||
| ### Non-identifying Attributes | ||
|
|
||
| The following attributes SHOULD be included in `AgentDescription.non_identifying_attributes`: | ||
|
|
||
| - `os.type`, `os.version` - to describe where the Collector runs. | ||
| - `host.\*` to describe the host the Collector runs on. | ||
| - `cloud.\*` to describe the cloud where the host is located. | ||
| - any other relevant Resource attributes that describe this Collector and the | ||
| environment it runs in. | ||
| - any user-defined attributes that the end user would like to associate with | ||
| this Collector. | ||
|
|
||
| ## SDKs | ||
|
|
||
| This guidance is intended for OpenTelemetry language agents that run as part of an instrumented | ||
| application process. Examples include auto-instrumentation language agents and similar | ||
| instrumentation runtimes built with OpenTelemetry SDKs. | ||
|
|
||
| This guidance does not apply to standalone agents such as the OpenTelemetry | ||
| Collector. | ||
|
|
||
| ## Identifying Attributes | ||
| ### Identifying Attributes | ||
|
|
||
| Language instrumentation agents MUST copy the following OpenTelemetry SDK | ||
| `Resource` attributes into `AgentDescription.identifying_attributes`: | ||
|
|
@@ -24,7 +53,7 @@ Language instrumentation agents MUST copy the following OpenTelemetry SDK | |
| These identifying attributes MUST match the values that the agent uses in the | ||
| Resource of its own telemetry. | ||
|
|
||
| ## Non-identifying Attributes | ||
| ### Non-identifying Attributes | ||
|
|
||
| Language instrumentation agents SHOULD copy all other OpenTelemetry SDK | ||
| `Resource` attributes into `AgentDescription.non_identifying_attributes`, | ||
|
|
||
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
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.