Move Otel Collector guidelines from to opentelemetry-guidelines.md#318
Move Otel Collector guidelines from to opentelemetry-guidelines.md#318tigrannajaryan wants to merge 1 commit intoopen-telemetry:mainfrom
Conversation
|
@open-telemetry/collector-approvers please review. |
| - os.\* to describe where the Agent runs. | ||
| - host.\* to describe the host the Agent runs on. | ||
| - cloud.\* to describe the cloud where the host is located. | ||
| - any other relevant Resource attributes that describe this Agent and the |
There was a problem hiding this comment.
I kept these as generic recommendations. There is also slightly specific requirements for the Collector in opentelemetry-guidelines.md.
I am not sure how to best differentiate the too, but I felt like some generic recommendations are still useful to have in this file.
| - 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. |
There was a problem hiding this comment.
I suggest we copy something similar to "The combination of identifying attributes SHOULD be sufficient to uniquely identify the Agent's own telemetry in the destination system to which the Agent sends its own telemetry" in this document as well.
There is already something similar for service.name, but I'm especially worried about service.instance.id, which as-is is very easy to interpret as "put in whatever random instance UID the OpAMP extension decided on, regardless of the Collector's service.instance.id".
Honestly, I'd argue the wording for SDKs is clearer and stronger: "These identifying attributes MUST match the values that the agent uses in the Resource of its own telemetry." Maybe it can be reused for the Collector as well.
There was a problem hiding this comment.
Added "These values SHOULD match the values that the Collector uses in the Resource of its
own telemetry.", which mirrors the spec wording.
tigrannajaryan
force-pushed
the
tigran/otel-guidelines
branch
from
d23746b to
d30e287
Compare
Continuation of open-telemetry#312 This brings Otel Collector guidelines from specification.md to the opentelemetry-guidelines.md where we want all Otel-related guidelines to be.
tigrannajaryan
force-pushed
the
tigran/otel-guidelines
branch
from
d30e287 to
d6eb803
Compare
| - any other attributes that are necessary for uniquely identifying the Agent's | ||
| own telemetry. |
|
|
||
| - `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. |
There was a problem hiding this comment.
This also goes against #312... Shouldn't this be non-identifying attribute?
There was a problem hiding this comment.
I am not sure I follow. Why is this against #312?
There was a problem hiding this comment.
service.version isn't listed in the set of required identifying attributes. Why do we recommend to set it there for the collector?
5 participants
Continuation of #312
This brings Otel Collector guidelines from specification.md to the opentelemetry-guidelines.md where we want all Otel-related guidelines to be.