Skip to content

First stab at documenting the art of defining semantic conventions#1707

Merged
lmolkova merged 15 commits intoopen-telemetry:mainfrom
lmolkova:how-to-contribute-new-conventions
Jan 31, 2025
Merged

First stab at documenting the art of defining semantic conventions#1707
lmolkova merged 15 commits intoopen-telemetry:mainfrom
lmolkova:how-to-contribute-new-conventions

Conversation

@lmolkova
Copy link
Copy Markdown
Member

@lmolkova lmolkova commented Dec 20, 2024

A lot of todos, which I'd like to tackle in follow up PRs (hopefully with the help of others)

Merge requirement checklist

@lmolkova lmolkova requested review from a team as code owners December 20, 2024 22:27
@lmolkova lmolkova requested a review from Copilot December 20, 2024 22:28
@lmolkova lmolkova added the Skip Changelog Label to skip the changelog check label Dec 20, 2024
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

docs/general/how-to-define-semantic-conventions.md:69

  • The phrase 'are involved into instrumentation efforts' should be 'are involved in instrumentation efforts'.
are involved into instrumentation efforts, and are committed to be the point of contact for

Comment thread docs/general/how-to-define-semantic-conventions.md Outdated
Copy link
Copy Markdown
Member

@joaopgrassi joaopgrassi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great start!

Comment thread docs/general/how-to-define-semantic-conventions.md Outdated
Comment thread docs/general/how-to-define-semantic-conventions.md
Comment thread docs/general/how-to-define-semantic-conventions.md Outdated
Comment thread docs/general/how-to-define-semantic-conventions.md Outdated
Comment thread docs/general/how-to-define-semantic-conventions.md Outdated
Comment thread docs/general/how-to-define-semantic-conventions.md Outdated
Copy link
Copy Markdown
Contributor

@braydonk braydonk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor grammar feedback

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
@lmolkova lmolkova force-pushed the how-to-contribute-new-conventions branch from 2afb348 to 6f90089 Compare December 27, 2024 22:31
@trisch-me
Copy link
Copy Markdown
Contributor

While I’m not opposed to this PR and appreciate the idea of having a clear path for defining semantic conventions, I would like to raise a concern about donation of ECS into Otel, where we still have a significant number of new namespaces / new fields to be added to the Otel and this could potentially slow down the merger. Should we consider establishing a short-circuit path to streamline the donation process?

Comment thread docs/general/how-to-define-semantic-conventions.md
@lmolkova
Copy link
Copy Markdown
Member Author

lmolkova commented Jan 3, 2025

@trisch-me This PR outlines path to success and best practices. Most of the language used there is non-normative.
And it's something we already practice when reviewing changes - we already ask to define conventions for signals along with the attributes.

@lmolkova lmolkova force-pushed the how-to-contribute-new-conventions branch from d91704c to abecb36 Compare January 3, 2025 01:25
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread docs/general/how-to-define-semantic-conventions.md Outdated
Comment thread docs/general/how-to-define-semantic-conventions.md Outdated
Comment thread docs/general/how-to-define-semantic-conventions.md Outdated
Comment thread docs/general/how-to-define-semantic-conventions.md Outdated
Copy link
Copy Markdown
Contributor

@jsuereth jsuereth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great first step!!!

Comment thread docs/general/how-to-define-semantic-conventions.md Outdated
@lmolkova lmolkova merged commit fa19325 into open-telemetry:main Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Skip Changelog Label to skip the changelog check

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

9 participants