chore: move utilities to subpackage #3
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR refactors OpenTelemetry utility functions by moving them from the main gotel package into a new dedicated otelutils subpackage, improving code organization and modularity.
- Introduces the
otelutilspackage with reusable OpenTelemetry utility functions - Updates all references in existing code to use the new package location
- Maintains backward compatibility by properly exporting all moved functions
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| utils.go | Removes OpenTelemetry-specific utility functions that were moved to otelutils package, retaining only general-purpose utilities |
| tracer.go | Updates import to reference otelutils.UserVisibilityAttribute from the new package |
| provider.go | Removes UserVisibilityAttribute declaration (now in otelutils) and unused attribute import |
| otelutils/utils_test.go | Updates package declaration to otelutils to match the new package location |
| otelutils/utils.go | Creates new package containing all OpenTelemetry utility functions moved from main package |
| middleware.go | Updates all function calls to use otelutils package prefix for SplitHostPort, NewTelemetryHeaders, and SetSpanHeaderAttributes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,158 @@ | |||
| // Package otelutils contain reusable utilities for OpenTelemetry attributes. | |||
There was a problem hiding this comment.
The package comment has a grammatical error. It should be "contains" instead of "contain" since "Package otelutils" is singular.
Suggested fix:
// Package otelutils contains reusable utilities for OpenTelemetry attributes.
Suggested change
| // Package otelutils contain reusable utilities for OpenTelemetry attributes. | |
| // Package otelutils contains reusable utilities for OpenTelemetry attributes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request refactors OpenTelemetry-related utility functions by moving them from the main
gotelpackage into a new dedicated package,otelutils. This improves code organization and separation of concerns. All usages of these utilities in the tracing middleware have been updated to reference the new package.Refactoring and code organization:
otelutilspackage containing reusable OpenTelemetry utility functions, includingSetSpanHeaderAttributes,NewTelemetryHeaders,IsSensitiveHeader,MaskString, andSplitHostPort. This moves them out of the maingotelpackage for better modularity.utils.goin thegotelpackage, as they are now provided byotelutils.middleware.goto useotelutilsfor OpenTelemetry utilities.Middleware usage updates:
middleware.goto use the newotelutilspackage, ensuring correct references throughout the tracing middleware. [1] [2] [3] [4] [5]Testing updates:
otelutils/utils_test.goand updated its package declaration to match the new package.