forked from open-telemetry/opentelemetry-collector
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[confmap] Encode string-like map keys (open-telemetry#10137)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description Our check for determining whether a map key can be encoded as a string is too restrictive and doesn't into account types which are essentially aliases for the string type and don't implement `UnmarshalText`. I encountered this while trying to call `(confmap.Conf).Marshal(*otelcol.Config)` when the config includes a Prometheus receiver, which includes the [LabelName type](https://github.com/prometheus/common/blob/main/model/labels.go#L98) that does not implement an unmarshaling method. We can't guarantee that all types will implement this, and [Go's print formatters check](https://github.com/golang/go/blob/master/src/fmt/print.go#L803) whether `(reflect.Value).Kind()` equals `reflect.String`, so I think this will be an overall more robust approach. <!--Describe what testing was performed and which tests were added.--> #### Testing I added two test cases to demonstrate when we will hit this case. --------- Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
- Loading branch information
1 parent
54d6b6b
commit 6044416
Showing
3 changed files
with
54 additions
and
4 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Use this changelog template to create an entry for release notes. | ||
|
||
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
change_type: bug_fix | ||
|
||
# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver) | ||
component: confmap | ||
|
||
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
note: Support string-like types as map keys when marshaling | ||
|
||
# One or more tracking issues or pull requests related to the change | ||
issues: [10137] | ||
|
||
# (Optional) One or more lines of additional information to render under the primary note. | ||
# These lines will be padded with 2 spaces and then inserted directly into the document. | ||
# Use pipe (|) for multiline entries. | ||
subtext: | ||
|
||
# Optional: The change log or logs in which this entry should be included. | ||
# e.g. '[user]' or '[user, api]' | ||
# Include 'user' if the change is relevant to end users. | ||
# Include 'api' if there is a change to a library API. | ||
# Default: '[user]' | ||
change_logs: [api] |
This file contains 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
This file contains 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