Skip to content

Add prototyping requirement for significant changes #2502

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

lmolkova
Copy link
Contributor

@lmolkova lmolkova commented Jul 9, 2025

Semantic conventions are intended to provide practical guidance for instrumentation authors and clear documentation for end users on what to expect and how to interpret telemetry. Semantic conventions are not a product on their own; they are only useful when adopted by instrumentations.

Based on past experience, it’s not possible to define realistic conventions without first instrumenting a few libraries, components, or technologies.

This is a proposal to require instrumentation implementations or prototypes for substantial changes to semantic conventions regardless of stability level.

While this may seem like a significant change to the documented process, it aligns with current practice. Looking at the changelog, most changes in recent months (or years?) have been driven by new instrumentation development (e.g., CI/CD metrics, CLI spans, GenAI conventions, .NET runtime metrics and connection spans), refactoring of existing instrumentation (e.g., k8s, system conventions), or stabilization efforts (e.g., database), and in most cases were accompanied by an existing instrumentation or prototypes.

@github-project-automation github-project-automation bot moved this from Untriaged to Needs More Approval in Semantic Conventions Triage Jul 9, 2025
@joaopgrassi joaopgrassi added Skip Changelog Label to skip the changelog check editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. docs labels Jul 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. Skip Changelog Label to skip the changelog check
Projects
Status: Needs More Approval
Development

Successfully merging this pull request may close these issues.

7 participants