Clarify telemetry library resource attributes #494
Conversation
Co-Authored-By: Wolfgang Ziegler <[email protected]>
arminru
requested review from
bogdandrutu,
c24t,
carlosalberto,
iredelmeier,
jmacd,
reyang,
SergeyKanzhelev,
tedsuo,
tigrannajaryan and
yurishkuro
as code owners
arminru
force-pushed
the
clarify-library-name
branch
from
2b59403 to
b9314ea
Compare
arminru
force-pushed
the
clarify-library-name
branch
from
b9314ea to
523c97f
Compare
|
|
||
| If another SDK, like a fork or a vendor-provided implementation, is used, `telemetry.sdk.name` | ||
| MUST be set to the fully-qualified class or module name of that SDK's main entry point | ||
| or another suitable identifier depending on the language. |
There was a problem hiding this comment.
Nit: I wonder if we should recommend fully-qualified name if we ourselves don't use it. Not a big deal, works either way for me.
There was a problem hiding this comment.
That's fine I think, given that the default SDK will be the most commonly used one out there it deserves a special status.
I defined a hard-coded string for the OpenTelemetry default SDK in order to have a single uniform value across all language implementations. This makes it easier in case someone wants to build handling around that in a backend.
| **Description:** Telemetry library information. | ||
| **Description:** The SDK used to produce telemetry data. | ||
|
|
||
| If the default OpenTelemetry SDK provided by the OpenTelemetry project is used, |
There was a problem hiding this comment.
Wait, if the instrumentation adapter is used - will it be the name of the adapter than?
There was a problem hiding this comment.
@SergeyKanzhelev Please clarify what you mean by instrumentation adapter, this term is completely new to me.
Do you refer to any of the things defined in our glossary (https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/glossary.md) or something else?
|
@SergeyKanzhelev @yurishkuro please let us know if your concerns are addressed. |
| **Description:** The telemetry SDK used to capture data recorded by the instrumentation libraries. | ||
|
|
||
| If the default OpenTelemetry SDK provided by the OpenTelemetry project is used, | ||
| `telemetry.sdk.name` MUST be set to `opentelemetry`. |
There was a problem hiding this comment.
What is responsible for setting mandatory resource attributes? Is the default SDK required to set these values? I think it's unclear where the responsibility lies for a lot of these things. A sentence or two of clarification would be very helpful.
There was a problem hiding this comment.
Good point! I rephrased it accordingly.
|
@open-telemetry/specs-approvers are we ready to merge this? :) |
|
Please merge. |
* Clarify telemetry library resource attributes * Fix typo Co-Authored-By: Wolfgang Ziegler <[email protected]> * Clarify non-default SDK name * `opentelemetry-sdk` -> `opentelemetry` * Refine description * Clarify responsibilities Co-authored-by: Wolfgang Ziegler <[email protected]>
Resolves #484.
I renamed the attributes since calling them just
libraryis highly ambiguous as we realized in the last SIG spec meeting.By introducing a nested set of keys in
telemetry.sdk.*, we could neatly introduce something liketelemetry.api.*in future if we also want to keep track of the OpenTelemetry API version being used. This is, however, out of scope of this PR since this is only to clarify the current intention of the status quo.I defined a hard-coded string for the OpenTelemetry default SDK in order to have a single uniform value across all language implementations. This makes it easier in case someone wants to build handling around that in a backend.