Commit Graph

13 Commits

Author SHA1 Message Date
Tigran Najaryan 132fd6aa14 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
2023-11-16 12:50:59 -05:00
Tigran Najaryan 22b6b073e3 Prohibit usage of retired names in semantic conventions (#2191)
* Prohibit usage of retired names in semantic conventions

This change adds a prohibition clause that requires that no old
metric or attribute name is used for a new attribute.

This is important to ensure reversibility of schema transformation
(converting from a new version to an old version of schema).

Without this restriction the following is possible:

Schema version 1. Attribute A exists.
Schema version 2. Attribute A is renamed to B. Appropriate schema file is created.
Schema version 3. Attribute A is introduced (a completely different new attribute).

Now attempting to go from Version 3 to version 1 is impossible since it requires
renaming B to A (for the change in version 2), but a different attribute A already exists.

* Fix based on comments

* Add changelog entry

Co-authored-by: Carlos Alberto Cortez <calberto.cortez@gmail.com>
2023-11-16 12:50:59 -05:00
Patrice Chalin 70eaeee2aa Ensure all ToCs are generated using markdown-toc (#2146) 2023-11-16 12:50:59 -05:00
Jakub Malinowski c37549e1d8 Rename Metrics labels to attributes (#1775) 2023-11-16 12:50:59 -05:00
Jack Berg d445ea5eec Move attribute documents 2023-11-16 12:50:59 -05:00
Josh Suereth e3352d43bc Remove local stubs of semantic conventions. (#3711) 2023-11-16 12:50:59 -05:00
Tigran Najaryan bd2b51a249 Explain why custom attributes are not recommended to be placed in Otel namespaces (#3507)
The @open-telemetry/technical-committee discussed and decided to keep the
existing recommendations but clarify them and explain the purpose.
2023-11-16 12:50:59 -05:00
Liudmila Molkova cc85702f85 BREAKING: Introduce common `url.*` attributes, and improve use of namespacing under `http.*` (#3355) 2023-11-16 12:50:59 -05:00
Josh Suereth 6b6cba749a Mark Attribute naming conventions as stable. (#3220) 2023-11-16 12:50:59 -05:00
Tigran Najaryan 1637677327 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
2023-11-16 12:50:59 -05:00
Tigran Najaryan 14280a41ae Prohibit usage of retired names in semantic conventions (#2191)
* Prohibit usage of retired names in semantic conventions

This change adds a prohibition clause that requires that no old
metric or attribute name is used for a new attribute.

This is important to ensure reversibility of schema transformation
(converting from a new version to an old version of schema).

Without this restriction the following is possible:

Schema version 1. Attribute A exists.
Schema version 2. Attribute A is renamed to B. Appropriate schema file is created.
Schema version 3. Attribute A is introduced (a completely different new attribute).

Now attempting to go from Version 3 to version 1 is impossible since it requires
renaming B to A (for the change in version 2), but a different attribute A already exists.

* Fix based on comments

* Add changelog entry

Co-authored-by: Carlos Alberto Cortez <calberto.cortez@gmail.com>
2023-11-16 12:50:59 -05:00
Patrice Chalin 537b07fcd6 Ensure all ToCs are generated using markdown-toc (#2146) 2023-11-16 12:50:59 -05:00
Jakub Malinowski dcf74c311a Rename Metrics labels to attributes (#1775) 2023-11-16 12:50:59 -05:00