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

Rename go.opentelemetry.io/contrib/processors/baggage/baggagetrace #5808

Closed
MrAlias opened this issue Jun 26, 2024 · 2 comments · Fixed by #5824
Closed

Rename go.opentelemetry.io/contrib/processors/baggage/baggagetrace #5808

MrAlias opened this issue Jun 26, 2024 · 2 comments · Fixed by #5824
Labels
Milestone

Comments

@MrAlias
Copy link
Contributor

MrAlias commented Jun 26, 2024

  • The go.opentelemetry.io/contrib/processors/baggage/baggagetrace package sits on the go.opentelemetry.io/contrib/processors/* prefix. This package prefix will need to be used for log processors as well.
  • The baggagetrace package name is not descriptive of the functionality it provides. A name indicating the package provides a SpanProcessor that will copy baggage values into a span should be used instead.

Proposal

  1. Copy the package to a new package under the new processors/span directory
  • Use processors/span and not processors/trace as this is for a SpanProcessor
  1. Rename the package to one of:
  • go.opentelemetry.io/contrib/processors/span/bagcp
  • go.opentelemetry.io/contrib/processors/span/bagcopy
  • go.opentelemetry.io/contrib/processors/span/baggagecp
  • go.opentelemetry.io/contrib/processors/span/baggagecopy
  1. Deprecate go.opentelemetry.io/contrib/processors/baggage/baggagetrace in favor of the new package.
@dmathieu
Copy link
Member

I would go for go.opentelemetry.io/contrib/processors/span/baggagecopy. The long import path shouldn't matter much (and we have longer ones), and it's the clearest name.

@MrAlias
Copy link
Contributor Author

MrAlias commented Jun 27, 2024

May not be ideal to split on type. There may be the case where a baggage span processor and log processor are needed.

Instead: go.opentelemetry.io/contrib/processors/baggagecopy and then have NewSpanProcessor and add in the future NewLogProcessor.

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

Successfully merging a pull request may close this issue.

3 participants