search

open-telemetry / semantic-conventions-java

Java generated classes for semantic conventions
Apache License 2.0
14 stars 17 forks source link

Develop strategy for deprecating / removing experimental semantic conventions #6

Closed jack-berg closed 6 months ago

jack-berg commented 1 year ago

We currently maintain many outdated attributes with @Deprecated annotations and previously agreed that this is unsustainable.

For stable semantic conventions, we should obviously retain attributes indefinitely, even if they undergo allowed renames via schema transformation rules.

However, for experimental conventions, we should develop some procedure for end-of-lifing attributes as the conventions churn.

Once we develop this strategy, we should consider removing all current attributes marked as deprecated.

breedx-splk commented 10 months ago

I think as long as the prior @Deprecated version indicates what the new thing is called or what the user should use instead, then it should be safe to remove these.

Can't the "procedure" to remove these just be a simple as removing them after a release cycle has passed?

EDIT: Ok, I think I understand now -- the process suggested here is intended to help automate initiation of the deprecation itself.

lmolkova commented 10 months ago

Created generalized issue in the semconv repo - https://github.com/open-telemetry/semantic-conventions/issues/550 Python has the same problem and it'd be great to have language-agnostic solution

jack-berg commented 6 months ago

This is resolved. See https://github.com/open-telemetry/semantic-conventions-java/issues/50#issuecomment-1998332270 for a full summary of the strategy.