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

Reconsider using constraints #293

Open
lmolkova opened this issue Mar 5, 2024 · 1 comment
Open

Reconsider using constraints #293

lmolkova opened this issue Mar 5, 2024 · 1 comment
Labels
cleanup Refactorings, etc, that don't add new features or fix bugs. semconv/model Related to the data model or YAML format of the semantic convention generator

Comments

@lmolkova
Copy link
Contributor

lmolkova commented Mar 5, 2024

constraints allows to formalize that at least one of attributes should be present.

We're getting away from this approach in semconv and usually define an attribute that's always available. Otherwise we use requirement level and notes mechanism to clarify when/how attributes should be populated.

As a result, we use constraints in a very few places in the semconv and it would be great to

  • check if we need them there. If we do, we should consider improving markdown rendering (now they appear as See below in the Requirement Level and conflict with ReqLevel on the attribute.
  • or remove them from the yaml schema and tooling.
@lmolkova lmolkova added semconv/model Related to the data model or YAML format of the semantic convention generator cleanup Refactorings, etc, that don't add new features or fix bugs. labels Mar 12, 2024
@jsuereth
Copy link
Contributor

We had a mini discussion of this in a smaller group. Given the usage of constraints right now, we'd like to take the following actions:

  • Remove all constraints from YAML (schema says their is only "any_of").
  • Any-of can migrate to Conditiionally-Required with a note on all attributes.

Additionally, we may want to re-evaluate "any_of" as we think the quality of telemetry in an any_of scenario may be poor for end-users.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Refactorings, etc, that don't add new features or fix bugs. semconv/model Related to the data model or YAML format of the semantic convention generator
Projects
Status: Clean up YAML schema
Development

No branches or pull requests

2 participants