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

Disambiguate attribute deprecation #582

Closed
lmolkova opened this issue Dec 5, 2023 · 4 comments · Fixed by #588
Closed

Disambiguate attribute deprecation #582

lmolkova opened this issue Dec 5, 2023 · 4 comments · Fixed by #588
Assignees

Comments

@lmolkova
Copy link
Contributor

lmolkova commented Dec 5, 2023

There are currently two ways to deprecate at attribute:

  1. By setting stability to deprecated
    - id: status_code
      brief: 'Deprecated, use `http.response.status_code` instead.'
      stability: deprecated
      ....
  2. By providing deprecated: description property
    - id: status_code
      deprecated: "use `http.response.status_code` instead."

The first approach is problematic: once attribute is deprecated it's no longer possible to know what was the stability at deprecation time.
It's problematic for code generation:

  • I want to separate experimental and stable attributes into different artifacts (or packages) based on stability level - I no longer know where to put deprecated ones (where they used to be)
  • I want to drop deprecated attributes that were experimental at deprecation time and only keep ones that were stable at deprecation time - I'm not able to do it.

Related to #551

@lmolkova
Copy link
Contributor Author

lmolkova commented Dec 5, 2023

Proposal:

  • only use the 2nd way in semconv defined here
  • change build-tools to remove stability: deprecated option
  • use deprecated: str property in jinja templates to check deprecation status (Support codegen by namespace build-tools#243 introduces a helper method)

@arminru
Copy link
Member

arminru commented Dec 12, 2023

+1 on your proposal, sounds like the ideal solution to me

cc @open-telemetry/build-tools-approvers

@lmolkova
Copy link
Contributor Author

lmolkova commented Dec 15, 2023

reopening since open-telemetry/build-tools#244 is not merged

@lmolkova lmolkova reopened this Dec 15, 2023
@github-actions github-actions bot added the Stale label Feb 7, 2024
@joaopgrassi joaopgrassi removed the Stale label Feb 14, 2024
@joaopgrassi
Copy link
Member

I merged open-telemetry/build-tools#244 now.

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

Successfully merging a pull request may close this issue.

3 participants