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

Move to io.opentelemetry.semconv package #13

Merged
merged 2 commits into from
Aug 31, 2023

Conversation

jack-berg
Copy link
Member

@jack-berg jack-berg commented Aug 30, 2023

Related to #5, #2.

  • SemanticAttributes now lives in a package which doesn't include *.trace.*, which is accurate given that includes attributes used across signals.
  • ResourceAttributes lives in the same package as SemanticAttributes because the additional level to the package hierarchy serves no value.
  • The package includes v1 to give allow us to make breaking changes to the code generation logic as discussed in comment. We are still publishing an -alpha artifact, so we are allowed to make breaking changes to the code generation logic, but I figure its best to keep the package change churn to a minimum, so trying to get us close to the structure we are likely to use when we publish a stable artifact. Discussed in a comment and decided to optimistically omit v1 from the package name. If later we need to make breaking changes after we release a stable version, we can skip to include v2 in the package name.
  • The downside of this set of changes is that the package change will be a breaking change vs. the existing io.opentelemetry:opentelemetry-semconv artifact. I think that's fine tho and we can publish deprecation warnings that point to the new classes in io.opentelemetry:opentelemetry-semconv before deleting.

@jack-berg jack-berg requested a review from a team August 30, 2023 17:05
@trask
Copy link
Member

trask commented Aug 30, 2023

  • The package includes v1 to give allow us to make breaking changes to the code generation logic as discussed in comment.

what do you think of being optimistic and not including the v1 in the package name, and only adding v2 in the future if needed?

@jack-berg
Copy link
Member Author

The package includes v1 to give allow us to make breaking changes to the code generation logic as discussed in #2 (comment).

what do you think of being optimistic and not including the v1 in the package name, and only adding v2 in the future if needed?

I'm fine with that too. Was hoping this PR would spur that conversation 🙂

@jack-berg jack-berg changed the title Move to io.opentelemetry.semconv.v1 package Move to io.opentelemetry.semconv package Aug 31, 2023
@jack-berg jack-berg merged commit d76b068 into open-telemetry:main Aug 31, 2023
11 checks passed
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 this pull request may close these issues.

3 participants