Skip to content
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

Is it possible to rename "instrumentation library" to "instrumentation scope" everywhere? #2203

Closed
13 tasks done
tigrannajaryan opened this issue Dec 6, 2021 · 6 comments
Closed
13 tasks done
Assignees
Labels
area:api Cross language API specification issue area:sdk Related to the SDK spec:logs Related to the specification/logs directory spec:metrics Related to the specification/metrics directory spec:trace Related to the specification/trace directory

Comments

@tigrannajaryan
Copy link
Member

tigrannajaryan commented Dec 6, 2021

This initially came from a discussion about introducing Logger Name.

While discussing the issue during the spec SIG meeting we came to a conclusion that the intent for "instrumentation library" was actually to have an "instrumentation scope".

The "instrumentation library" is currently used throughout the spec API and SDK. We want to explore if it is possible to rename "instrumentation library" to "instrumentation scope" without breaking existing stability guarantees.

Note: this should be only done if it is not a breaking change. We must continue honouring our stability guarantees.

Places to check:

In this spec:

@tigrannajaryan tigrannajaryan added area:api Cross language API specification issue area:sdk Related to the SDK spec:metrics Related to the specification/metrics directory spec:logs Related to the specification/logs directory spec:trace Related to the specification/trace directory labels Dec 6, 2021
@tigrannajaryan tigrannajaryan changed the title Rename "instrumentation library" to "instrumentation scope" everywhere Is it possible to rename "instrumentation library" to "instrumentation scope" everywhere? Dec 6, 2021
This was referenced Dec 6, 2021
@dyladan
Copy link
Member

dyladan commented Dec 7, 2021

From some of the discussions linked here, its clear that there is still some confusion about what the instrumentation library is, but renaming it to instrumentation scope doesn't clear up that confusion. In my opinion this change is just changing one term for another, more confusing, term. I have a few problems with this. First, it seems that the proposal in the logging discussion actually seeks to not only change the name, but to expand the meaning of the field. The instrumentation library is the library which is performing the instrumentation itself, not the target of the instrumentation. In some cases, the logger name may also be the same, but it may also not be. Second, this may not be breaking in the API surface, but it would definitely be breaking in the export pipeline, requiring exporters and receivers to be changed to use the new name. I don't believe the benefits of changing the name now outweigh the pain of switching the name everywhere.

@tigrannajaryan
Copy link
Member Author

First, it seems that the proposal in the logging discussion actually seeks to not only change the name, but to expand the meaning of the field.

This is not entirely correct. It does not seek to expand the meaning of the field. It seeks to fix the broken description and naming of the field. The initial idea and intent of the field is not correctly reflected neither in the current name of the field nor in its current description. At least this is the takeaway I have from the Spec SIG discussion we had 2 weeks ago.

@bogdandrutu is the person who originally suggested the concept of the "component", later renamed to "instrumentation library". In the spec SIG meeting he suggested that we need to revive the original meaning and fix the name. I think it is worth exploring this idea, but I am not sure we will be able to, it may be too late now. Bogdan, you may want to chime in.

To be clear: I am not strongly advocating for this change myself and can be convinced that we shouldn't do it.

@tigrannajaryan
Copy link
Member Author

Update: this would be a breaking change for JS: open-telemetry/opentelemetry-js#2656
Technically this is sufficient to conclude that we cannot make this project-wide change anymore. I don't think we can allow some of the SDKs to use "instrumentation library" and some others "instrumentation scope" as the name of the same concept. That would be confusing and IMO is wrong.

If so, then we are forced to conclude that the renaming is not possible, we have to keep "instrumentation library" as the name of the concept, unless someone else has a suggestion on how we can make it possible.

@dyladan
Copy link
Member

dyladan commented Dec 7, 2021

@bogdandrutu is the person who originally suggested the concept of the "component", later renamed to "instrumentation library". In the spec SIG meeting he suggested that we need to revive the original meaning and fix the name. I think it is worth exploring this idea, but I am not sure we will be able to, it may be too late now. Bogdan, you may want to chime in.

It was my understanding that component referred to the library being instrumented like mysql. InstrumentationLibrary refers to the library which is doing the instrumenting like otel-autoinstrumentation-mysql. In some cases where a library instruments itself (native instrumentations), they may have the same value, but component and InstrumenatationLibrary are not the same thing.

@tigrannajaryan
Copy link
Member Author

Multiple SDKs reported that this would be a breaking change. We cannot move forward with this.
I am closing this issue as it appears to be a dead end. The change of the name of the "instrumentation library" concept is not possible.

tigrannajaryan added a commit to tigrannajaryan/opentelemetry-specification that referenced this issue Jan 19, 2022
This is a slightly different take on open-telemetry#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 open-telemetry#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
tigrannajaryan added a commit to tigrannajaryan/opentelemetry-specification that referenced this issue Jan 19, 2022
This is a slightly different take on open-telemetry#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 open-telemetry#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
tigrannajaryan added a commit to tigrannajaryan/opentelemetry-specification that referenced this issue Jan 19, 2022
This is a slightly different take on open-telemetry#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 open-telemetry#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
tigrannajaryan added a commit to tigrannajaryan/opentelemetry-specification that referenced this issue Feb 7, 2022
This is a slightly different take on open-telemetry#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 open-telemetry#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
tigrannajaryan added a commit to tigrannajaryan/opentelemetry-specification that referenced this issue Feb 7, 2022
This is a slightly different take on open-telemetry#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 open-telemetry#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
tigrannajaryan added a commit to tigrannajaryan/opentelemetry-specification that referenced this issue Feb 9, 2022
This is a slightly different take on open-telemetry#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 open-telemetry#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
tigrannajaryan added a commit to tigrannajaryan/opentelemetry-specification that referenced this issue Feb 14, 2022
This is a slightly different take on open-telemetry#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 open-telemetry#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
tigrannajaryan added a commit that referenced this issue Feb 14, 2022
This is a slightly different take on #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 #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
carlosalberto pushed a commit that referenced this issue Feb 15, 2022
…2276)

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on #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 #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
@tigrannajaryan
Copy link
Member Author

tigrannajaryan commented Feb 15, 2022

We eventually went with #2276

ChengJinbao added a commit to ChengJinbao/opentelemetry-specification that referenced this issue Nov 16, 2022
…2276)

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on open-telemetry/opentelemetry-specification#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 open-telemetry/opentelemetry-specification#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
jack-berg pushed a commit to jack-berg/semantic-conventions that referenced this issue Nov 7, 2023
…2276)

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on open-telemetry/opentelemetry-specification#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 open-telemetry/opentelemetry-specification#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
AlexanderWert pushed a commit to jack-berg/semantic-conventions that referenced this issue Nov 10, 2023
…2276)

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on open-telemetry/opentelemetry-specification#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 open-telemetry/opentelemetry-specification#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
jack-berg pushed a commit to jack-berg/semantic-conventions that referenced this issue Nov 16, 2023
…2276)

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on open-telemetry/opentelemetry-specification#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 open-telemetry/opentelemetry-specification#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
jack-berg pushed a commit to jack-berg/semantic-conventions that referenced this issue Nov 16, 2023
…2276)

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on open-telemetry/opentelemetry-specification#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 open-telemetry/opentelemetry-specification#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
jsuereth pushed a commit to jack-berg/semantic-conventions that referenced this issue Nov 16, 2023
…2276)

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on open-telemetry/opentelemetry-specification#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 open-telemetry/opentelemetry-specification#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
jsuereth pushed a commit to jack-berg/semantic-conventions that referenced this issue Nov 16, 2023
…2276)

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on open-telemetry/opentelemetry-specification#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 open-telemetry/opentelemetry-specification#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
jsuereth pushed a commit to open-telemetry/semantic-conventions that referenced this issue Nov 16, 2023
…2276)

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on open-telemetry/opentelemetry-specification#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 open-telemetry/opentelemetry-specification#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
jsuereth pushed a commit to open-telemetry/semantic-conventions that referenced this issue Nov 16, 2023
…2276)

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on open-telemetry/opentelemetry-specification#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 open-telemetry/opentelemetry-specification#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
joaopgrassi pushed a commit to dynatrace-oss-contrib/semantic-conventions that referenced this issue Jan 10, 2024
…2276)

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on open-telemetry/opentelemetry-specification#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 open-telemetry/opentelemetry-specification#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
joaopgrassi pushed a commit to dynatrace-oss-contrib/semantic-conventions that referenced this issue Jan 10, 2024
…2276)

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on open-telemetry/opentelemetry-specification#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 open-telemetry/opentelemetry-specification#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
pyohannes pushed a commit to pyohannes/semantic-conventions that referenced this issue Jan 17, 2024
…2276)

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on open-telemetry/opentelemetry-specification#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 open-telemetry/opentelemetry-specification#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
pyohannes pushed a commit to pyohannes/semantic-conventions that referenced this issue Jan 17, 2024
…2276)

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on open-telemetry/opentelemetry-specification#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 open-telemetry/opentelemetry-specification#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
joaopgrassi pushed a commit to dynatrace-oss-contrib/semantic-conventions that referenced this issue Mar 21, 2024
…2276)

* Clarify that Trace/Meter are associated with Instrumentation Scope

This is a slightly different take on open-telemetry/opentelemetry-specification#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 open-telemetry/opentelemetry-specification#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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:api Cross language API specification issue area:sdk Related to the SDK spec:logs Related to the specification/logs directory spec:metrics Related to the specification/metrics directory spec:trace Related to the specification/trace directory
Projects
None yet
Development

No branches or pull requests

3 participants