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

Add metric requirement level to yaml #132

Open
jamesmoessis opened this issue Jan 31, 2023 · 2 comments
Open

Add metric requirement level to yaml #132

jamesmoessis opened this issue Jan 31, 2023 · 2 comments
Labels
enhancement New feature or request semconv/model Related to the data model or YAML format of the semantic convention generator semconv Related to the semantic convention generator.

Comments

@jamesmoessis
Copy link
Contributor

jamesmoessis commented Jan 31, 2023

This stems from open-telemetry/opentelemetry-specification#2972 and https://github.com/open-telemetry/opentelemetry-specification/pull/3158/files

"The HTTP metrics semantic convention spec should provide clarity "what is considered a compliant implementation", e.g. "an implementation is considered compliant if it has implemented all of the metrics described by this spec"

The work required in build-tools is:

  • Add a field to the metrics semconv yaml (should this also be for traces?)
  • Decide where this will be rendered in markdown (most likely the metrics table makes sense) + write it into the markdown renderer
@jamesmoessis
Copy link
Contributor Author

cc @trask @reyang

@Oberon00
Copy link
Member

Oberon00 commented Mar 13, 2023

should this also be for traces

I don't think this applies to traces. For traces, we have required attributes, but either you track a certain operation or not. We can't say "if you are not creating HTTP spans, then you are not compliant". Either you have an HTTP instrumentation enabled. Then it hopefully creates spans following HTTP conventions. Or you don't, then that's fine as well.

I.e. in traces, the policy is (I think; maybe it should be spelled out somewhere in the spec): "you either set no attribute of a group, or you if you set any attribute, you must fulfill all the attribute requirements."

@Oberon00 Oberon00 added enhancement New feature or request semconv Related to the semantic convention generator. semconv/model Related to the data model or YAML format of the semantic convention generator labels Apr 25, 2023
@lmolkova lmolkova changed the title YAML should define if metric is required to be considered a compliant implementation Add metric requirement level to yaml Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request semconv/model Related to the data model or YAML format of the semantic convention generator semconv Related to the semantic convention generator.
Projects
Status: Improve YAML Schema
Development

No branches or pull requests

2 participants