open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify that Trace/Meter are associated with Instrumentation Scope (#2276) 

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on https://github.com/open-telemetry/opentelemetry-specification/issues/2203

Instead of renaming instrumentation library to instrumentation scope everywhere
this PR suggests targetted editing of wording of the Trace/Meter obtaining API
to allow not just instrumentation library but other instrumentation scopes to be
used as a parameter.

This change does not force renaming of API parameters and is not a breaking change.
We consider it a clarification of usage to match the intent that we had for the "name"
field.

If this PR is accepted there will be a follow up PR that will suggest to rename
InstrumentationLibrary* messages in OTLP proto to InstrumentationScope* message.
Such a change will not be a breaking change for the OTLP wire format and is acceptable.

If this PR is accepted we will also close https://github.com/open-telemetry/opentelemetry-specification/pull/1236
since it will be no longer necessary. The logger name will be recorded as the
instrumentation scope. This clarification will be a follow up PR that clarifies the
behavior in https://github.com/open-telemetry/oteps/blob/main/text/logs/0150-logging-library-sdk.md
This commit is contained in:
Tigran Najaryan 2022-02-15 11:34:11 -05:00 committed by Josh Suereth
parent c948e38726
commit 132fd6aa14
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
specification/common/attribute-naming.md
View File

@ -148,8 +148,8 @@ Attribute names that start with `otel.` are reserved to be defined by
OpenTelemetry specification. These are typically used to express OpenTelemetry OpenTelemetry specification. These are typically used to express OpenTelemetry
concepts in formats that don't have a corresponding concept. concepts in formats that don't have a corresponding concept.
For example, the `otel.library.name` attribute is used to record the For example, the `otel.scope.name` attribute is used to record the
instrumentation library name, which is an OpenTelemetry concept that is natively instrumentation scope name, which is an OpenTelemetry concept that is natively
represented in OTLP, but does not have an equivalent in other telemetry formats represented in OTLP, but does not have an equivalent in other telemetry formats
and protocols. and protocols.