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

Keep renamed/removed experimental attributes as deprecated #550

Closed
lmolkova opened this issue Nov 21, 2023 · 4 comments
Closed

Keep renamed/removed experimental attributes as deprecated #550

lmolkova opened this issue Nov 21, 2023 · 4 comments
Assignees
Labels

Comments

@lmolkova
Copy link
Contributor

lmolkova commented Nov 21, 2023

When renaming/removing an attribute, we need to preserve the old name in the yaml.

Currently it disappears, meaning that:

Options:

  1. Never remove an attribute, when renaming always add the old one to deprecated ones
    • we'd also need CI checks to validate
  2. Add build-tools feature to compare list of attributes between semconv vOld and vNew and generate list of removed attributes.
@lmolkova
Copy link
Contributor Author

My preference would be on Option 2 since we need to build validation tooling anyway, so why not automate the whole process.

@lmolkova lmolkova changed the title Keep renamed/removed experimental attributes as deprecated in yaml Keep renamed/removed experimental attributes as deprecated Nov 21, 2023
@AlexanderWert
Copy link
Member

AlexanderWert commented Nov 22, 2023

@lmolkova For HTTP we have (at least for some of them) the deprecated attributes listed in a separate section in the registry: https://opentelemetry.io/docs/specs/semconv/attributes-registry/http/#deprecated-http-attributes

I like to have this documented not only in yaml files (and codegen) but also in the docs.

So how about adopting the same for all attributes that are being removed / renamed / deprecated?

@lmolkova
Copy link
Contributor Author

@AlexanderWert we've been inconsistent with marking them as deprecated.
So either we embrace it and pick option2 or add tooling to ensure we mark removed ones as deprecated (option1).

I agree that having them preserved in the spec (at least for a certain period of time) is great.

@lmolkova
Copy link
Contributor Author

closing in favor of #740

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants