Move attribute naming docs from specification #493

jack-berg · 2023-11-07T20:08:35Z

Related to open-telemetry/opentelemetry-specification#3746.

Moves opentelemetry-specification/specification/common/attribute-naming.md and opentelemetry-specification/specification/common/attribute-requirement-level.md to semantic-conventions.

I've attempted to bring the commit history for these files along, but could use an extra set of eyes from @jsuereth, who I believe brought he git history with when seeding this repository.

mx-psi · 2023-11-08T10:22:57Z

I believe this fixes #295 cc @joaopgrassi

joaopgrassi

Thank you!

The links needs to be adapted now, to link to the local files in this repo and use the full link to the spec repo.

docs/general/attribute-naming.md

docs/general/attribute-requirement-level.md

docs/general/attribute-naming.md

docs/general/attribute-requirement-level.md

jack-berg · 2023-11-10T18:01:47Z

FYI @open-telemetry/specs-semconv-maintainers, I believe that when it comes time to merge this, we should preserve the commit history instead of squashing.

docs/general/attribute-requirement-level.md

arminru · 2023-11-14T12:12:10Z

@chalin FYI - see also open-telemetry/opentelemetry-specification#3758 🙂

chalin

LGTM - it doesn't break anything when published to the OTel website ✨

One nit, see inline comment.

docs/general/attribute-requirement-level.md

jack-berg · 2023-11-14T23:01:52Z

Reminder to whoever merges this:

FYI @open-telemetry/specs-semconv-maintainers, I believe that when it comes time to merge this, we should preserve the commit history instead of squashing.

AlexanderWert · 2023-11-15T08:22:53Z

Reminder to whoever merges this:

FYI @open-telemetry/specs-semconv-maintainers, I believe that when it comes time to merge this, we should preserve the commit history instead of squashing.

@arminru @jsuereth Rebase and merge is not enabled for this repository:

Can we enable it temporarily? Or how can we achieve the above otherwise?

chalin · 2023-11-15T20:33:17Z

The commit history remains available in the PR, why impose that on the main branch? For projects that are likely to have a long life it is preferable, IMHO, to keep the main branch's history as clean and terse as possible. (My 2 cents :)

jsuereth · 2023-11-16T14:15:26Z

The commit history remains available in the PR, why impose that on the main branch? For projects that are likely to have a long life it is preferable, IMHO, to keep the main branch's history as clean and terse as possible. (My 2 cents :)

@chalin The goal here is to preserve the previous history from the spec repo for the files that are moved into this repository.

@AlexanderWert I can temporarily enable for this PR.

chalin · 2023-11-16T14:16:33Z

@chalin The goal here is to preserve the previous history from the spec repo for the files that are moved into this repository.

Oh, got it! 👍🏻

jsuereth · 2023-11-16T14:25:30Z

This branch cannot be rebased due to conflicts

@jack-berg do you mind manually rebasing this and push -f on your private branch?

jack-berg · 2023-11-16T16:11:46Z

This branch cannot be rebased due to conflicts

@jack-berg do you mind manually rebasing this and push -f on your private branch?

Done 👍

* Centralize attributes definition Signed-off-by: Bogdan Drutu <[email protected]> * Update specification/common/common.md Co-authored-by: Christian Neumüller <[email protected]> * Update specification/common/common.md Co-authored-by: Christian Neumüller <[email protected]> * Update specification/common/common.md Co-authored-by: Christian Neumüller <[email protected]> * Update specification/common/common.md Co-authored-by: Christian Neumüller <[email protected]> * Update specification/common/common.md Co-authored-by: Christian Neumüller <[email protected]> * Update specification/common/common.md Co-authored-by: Christian Neumüller <[email protected]> * Update specification/overview.md Co-authored-by: Christian Neumüller <[email protected]> Co-authored-by: Christian Neumüller <[email protected]>

* Consistency between Span and Resource attributes * Address feedback * Wording

…ributes (#2614)

Resolves #2752. This aligns log SDK and API concepts which have diverged after the merged of #2676. This PR brings alignment to the log API and SDK, and in brings the log signal into alignment with tracing and metrics where there is conceptual overlap. There shouldn't be any new concepts introduced here. - Rename `../logs/logging-library-sdk.md` to `../logs/sdk.md` - Remove wording from SDK that implies that an API doesn't exist, like [this](https://github.com/open-telemetry/opentelemetry-specification/blame/main/specification/logs/logging-library-sdk.md#L60-L62). - Move [How to Create Log4j Style Appender](https://github.com/open-telemetry/opentelemetry-specification/blame/main/specification/logs/logging-library-sdk.md#L219) to `api.md` since it describes an API use case. - Move [Implicit / Explicit Context Injection](https://github.com/open-telemetry/opentelemetry-specification/blame/main/specification/logs/logging-library-sdk.md#L270-L288) sections to `api.md` since they describe API level considerations. - Rename Logger [create](https://github.com/open-telemetry/opentelemetry-specification/blame/main/specification/logs/api.md#L133) method to be emit, to align with SDK concept of `LogRecordProcessor#onEmit(..)`. - Rename `LogProcessor`, `LogExporter` to `LogRecordProcessor`, `LogRecordExporter`. - Fill in various SDK level TODOs related to shutdown and flushing. The language from these was taken directly from the metrics / tracing SDK - no new concepts were introduced.

* Define semantic conventions yaml for non-otlp conventions Signed-off-by: Bogdan Drutu <[email protected]> * Update semantic_conventions/trace/exporter/exporter.yaml Co-authored-by: Christian Neumüller <[email protected]> * Update semantic_conventions/scope/exporter/exporter.yaml Co-authored-by: Joao Grassi <[email protected]> * Rename otel to otel_span Signed-off-by: Bogdan Drutu <[email protected]> Signed-off-by: Bogdan Drutu <[email protected]> Co-authored-by: Christian Neumüller <[email protected]> Co-authored-by: Joao Grassi <[email protected]>

Fixes #2860 Adds log attribute limit configuration. These new environment variables bring more consistency between spans and logs.

…y (#3270)

…braries (#3289) Based on discussion in semconv stability WG Closes #3283 ## Changes Clarifies that attribute requirement levels apply to instrumentation. And that, because users can transform their telemetry in a number of ways (e.g. metric views, span processors, and collector transformations), these requirement levels cannot be relied on by telemetry consumers. --------- Co-authored-by: Liudmila Molkova <[email protected]> Co-authored-by: Bogdan Drutu <[email protected]>

- Contributes to open-telemetry/opentelemetry.io#2429 - This is part of an effort to normalize links, for improved link checking on the OTel website

…` (and `source.*`/`destination.*`) (#3402)

…k.*` and align definitions with ECS (#3426)

…espacing under `http.*` (#3355)

…l namespaces (#3507) The @open-telemetry/technical-committee discussed and decided to keep the existing recommendations but clarify them and explain the purpose.

@svrnm

- Followup changes for open-telemetry/opentelemetry.io#2793 - There are only changes to Hugo front matter - Adds `likeTitle`s for "Compatibility" pages - Adds aliases for pages that have moved or were renamed - Related: open-telemetry/opentelemetry.io#3013 -- the `compatibility/openmetrics` spec page is in the list because it was renamed /cc @svrnm @cartermp

Fixes open-telemetry#454 Related to #3337 As the Messaging SIG merged its last OTEP 222, we will be adding operations that require Links after Span creation, taking a direct route with `AddLink()`, albeit without any of the new members suggested in #3337, e.g. `timestamp` (to be discussed in a separate issue). ``` AddLink(spanContext, attributes /* optional */) ```

…h `network.(peer|local).(address|port)`. (#3713) Co-authored-by: Armin Ruech <[email protected]>

jack-berg requested review from a team November 7, 2023 20:08

github-actions bot assigned reyang Nov 7, 2023

jack-berg mentioned this pull request Nov 7, 2023

Move attribute documents to semantic-conventions repository open-telemetry/opentelemetry-specification#3758

Merged

joaopgrassi reviewed Nov 8, 2023

View reviewed changes

docs/general/attribute-naming.md Outdated Show resolved Hide resolved

docs/general/attribute-requirement-level.md Outdated Show resolved Hide resolved

trask reviewed Nov 8, 2023

View reviewed changes

mx-psi linked an issue Nov 9, 2023 that may be closed by this pull request

Should we move common attribute documents from the spec repo to this repo? #295

Closed

mx-psi approved these changes Nov 9, 2023

View reviewed changes

joaopgrassi approved these changes Nov 10, 2023

View reviewed changes

docs/general/attribute-requirement-level.md Outdated Show resolved Hide resolved

AlexanderWert approved these changes Nov 10, 2023

View reviewed changes

AlexanderWert force-pushed the move-attribute-naming branch from ad88f48 to 374f379 Compare November 10, 2023 21:06

jsuereth reviewed Nov 10, 2023

View reviewed changes

docs/general/attribute-requirement-level.md Show resolved Hide resolved

pyohannes approved these changes Nov 13, 2023

View reviewed changes

arminru approved these changes Nov 14, 2023

View reviewed changes

chalin approved these changes Nov 14, 2023

View reviewed changes

docs/general/attribute-requirement-level.md Show resolved Hide resolved

jsuereth approved these changes Nov 16, 2023

View reviewed changes

jack-berg force-pushed the move-attribute-naming branch from b8c43b6 to 2ef0aca Compare November 16, 2023 16:10

bogdandrutu and others added 3 commits November 16, 2023 12:49

DocFX sanity check (open-telemetry#742)

79b2dbb

Consistency between Span and Resource attributes (open-telemetry#777)

9889823

* Consistency between Span and Resource attributes * Address feedback * Wording

tigrannajaryan and others added 24 commits November 16, 2023 12:49

Use consistent file name for data-model.md (#2586)

74f3371

Add note to Hugo front matter (#2651)

33db445

Define net.sock attributes and clarify logical net.peer|host.name att…

c5d59f7

…ributes (#2614)

Add log attribute limit configuration (#2861)

89bc678

Fixes #2860 Adds log attribute limit configuration. These new environment variables bring more consistency between spans and logs.

Mark Attribute naming conventions as stable. (#3220)

ffa06eb

Rename Optional attribute requirement level to Opt-In (#3228)

b33dfd2

Proofread of attribute requirement levels in preparation for stabilit…

0f18a4a

…y (#3270)

Attribute requirement level follow-up edits (#3293)

96adc36

Mark attribute requirement levels as stable (#3368)

aa255bd

Use path, not external URL, for link into glossary (#3375)

8126e5d

- Contributes to open-telemetry/opentelemetry.io#2429 - This is part of an effort to normalize links, for improved link checking on the OTel website

BREAKING: Replace net.peer.*/net.host.* with client.*/`server.*…

103ee5e

…` (and `source.*`/`destination.*`) (#3402)

BREAKING: Rename remaining network attributes from net.* to `networ…

97c72d7

…k.*` and align definitions with ECS (#3426)

BREAKING: Introduce common url.* attributes, and improve use of nam…

ce84b13

…espacing under `http.*` (#3355)

Explain why custom attributes are not recommended to be placed in Ote…

9da901e

…l namespaces (#3507) The @open-telemetry/technical-committee discussed and decided to keep the existing recommendations but clarify them and explain the purpose.

Remove local stubs of semantic conventions. (#3711)

5f720e7

Rename/replace (client|server).socket.(address|port) attributes wit…

32d5330

…h `network.(peer|local).(address|port)`. (#3713) Co-authored-by: Armin Ruech <[email protected]>

Remove files to keep

fbfaa76

Move attribute documents

85eda4f

Format with prettier

1cc6967

jsuereth force-pushed the move-attribute-naming branch from 2ef0aca to 1cc6967 Compare November 16, 2023 17:49

jsuereth merged commit 48d3348 into open-telemetry:main Nov 16, 2023
8 checks passed

jack-berg mentioned this pull request Nov 28, 2023

Generalize attribute naming recommendations open-telemetry/opentelemetry-specification#3746

Closed

arminru mentioned this pull request Dec 15, 2023

Staging the 1.24.0 release #613

Merged

jack-berg mentioned this pull request Jan 11, 2024

Support maps and heterogeneous arrays as attribute values open-telemetry/opentelemetry-specification#2888

Closed

joaopgrassi mentioned this pull request Mar 21, 2024

[chore] Move metric requirement levels doc from spec #830

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move attribute naming docs from specification #493

Move attribute naming docs from specification #493

jack-berg commented Nov 7, 2023 •

edited by arminru

Loading

mx-psi commented Nov 8, 2023

joaopgrassi left a comment

jack-berg commented Nov 10, 2023

arminru commented Nov 14, 2023

chalin left a comment

jack-berg commented Nov 14, 2023

AlexanderWert commented Nov 15, 2023

chalin commented Nov 15, 2023

jsuereth commented Nov 16, 2023

chalin commented Nov 16, 2023

jsuereth commented Nov 16, 2023

jack-berg commented Nov 16, 2023

Move attribute naming docs from specification #493

Move attribute naming docs from specification #493

Conversation

jack-berg commented Nov 7, 2023 • edited by arminru Loading

mx-psi commented Nov 8, 2023

joaopgrassi left a comment

Choose a reason for hiding this comment

jack-berg commented Nov 10, 2023

arminru commented Nov 14, 2023

chalin left a comment

Choose a reason for hiding this comment

jack-berg commented Nov 14, 2023

AlexanderWert commented Nov 15, 2023

chalin commented Nov 15, 2023

jsuereth commented Nov 16, 2023

chalin commented Nov 16, 2023

jsuereth commented Nov 16, 2023

jack-berg commented Nov 16, 2023

jack-berg commented Nov 7, 2023 •

edited by arminru

Loading