cli/command: un-export ResourceAttributesEnvvar, DockerCliAttributePrefix #5881
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
…efix These utility functions were added in 8890a1c, and are all related to OTEL. The ResourceAttributesEnvvar const defines the "OTEL_RESOURCE_ATTRIBUTES" environment-variable to use, which is part of the [OpenTelemetry specification], so should be considered a well-known env-var, and not up to us to define a const for. These code-changes were not yet included in a release, so we don't have to deprecate. This patch: - Moves the utility functions to the telemetry files, so that all code related to OpenTelemetry is together. - Un-exports the ResourceAttributesEnvvar to reduce our public API. - Un-exports the DockerCliAttributePrefix to reduce depdency on cli/command in CLI-plugins, but adds a TODO to move telemetry-related code to a common (internal) package. - Deprecates the cli-plugins/manager.ResourceAttributesEnvvar const. This const has no known consumers, so we could skip deprecation, but just in case some codebase uses this. [OpenTelemetry specification]: https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#general-sdk-configuration Signed-off-by: Sebastiaan van Stijn <[email protected]>
Signed-off-by: Sebastiaan van Stijn <[email protected]>
thaJeztah
added
status/2-code-review
kind/refactor
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #5881 +/- ##
==========================================
+ Coverage 59.31% 59.34% +0.02%
==========================================
Files 353 354 +1
Lines 29735 29735
==========================================
+ Hits 17637 17645 +8
+ Misses 11117 11108 -9
- Partials 981 982 +1 🚀 New features to boost your workflow:
|
thaJeztah
added
the
impact/go-sdk
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
relates to:
cli/command: un-export ResourceAttributesEnvvar, DockerCliAttributePrefix
These utility functions were added in 8890a1c,
and are all related to OTEL. The ResourceAttributesEnvvar const defines
the "OTEL_RESOURCE_ATTRIBUTES" environment-variable to use, which is part
of the OpenTelemetry specification, so should be considered a well-known
env-var, and not up to us to define a const for. These code-changes were not
yet included in a release, so we don't have to deprecate.
This patch:
to OpenTelemetry is together.
in CLI-plugins, but adds a TODO to move telemetry-related code to a common
(internal) package.
const has no known consumers, so we could skip deprecation, but just in
case some codebase uses this.
cli-plugins/manager: move OTEL-related code to separate file
- Human readable description for the release notes
- A picture of a cute animal (not mandatory but encouraged)