[extension/encoding/awscloudwatchmetricstreams_encoding] Support unmarshalling JSON-formatted CloudWatch Metric Streams #38419
Conversation
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
github-actions
bot
requested review from
atoulme,
dao-jun,
dmitryax,
MovieStoreGuy and
VihasMakwana
axw
reviewed
Mar 6, 2025
axw
reviewed
Mar 7, 2025
There was a problem hiding this comment.
Thanks @constanca-m! Looking good, main concerns are to do with how the tests are implemented.
extension/encoding/awscloudwatchmetricstreamsencodingextension/json_unmarshaler_test.go
Outdated
Show resolved
Hide resolved
extension/encoding/awscloudwatchmetricstreamsencodingextension/json_unmarshaler_test.go
Outdated
Show resolved
Hide resolved
extension/encoding/awscloudwatchmetricstreamsencodingextension/json_unmarshaler.go
Outdated
Show resolved
Hide resolved
Comment on lines
83
to
87
| content, err := os.ReadFile(filesDirectory + "/" + test.metricExpectedFilename) | ||
| require.NoError(t, err) | ||
|
|
||
| expected, err := unmarshallerJSONMetric.UnmarshalMetrics(content) | ||
| require.NoError(t, err) |
There was a problem hiding this comment.
Should we use https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/pkg/golden here? In which case the expected metrics would need to be encoded as YAML.
There was a problem hiding this comment.
I have used json.Compact and changed to YAML for the expected file. Thanks for the suggestions! I think it looks better now.
Co-authored-by: Andrew Wilkins <[email protected]>
axw
approved these changes
Mar 7, 2025
Comment on lines
+89
to
+92
| // joinMetricsFromFile reads the metrics inside the files, | ||
| // and joins them in the format a record expects it to be: | ||
| // each metric is expected to be in 1 line, and every new | ||
| // line marks a new metric |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR implements the translation of JSON-formatted CloudWatch Metric Streams into OpenTelemetry metrics.
It receives a record, and splits that record by each new line. Each of these parts will correspond to a JSON CloudWatch Metric Stream. It then translates this metric into an OpenTelemetry metric. The obtained metrics from the record are returned.
It follows the same logic as https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/awsfirehosereceiver/internal/unmarshaler/cwmetricstream.
Link to tracking issue
Fixes #38407.
Testing
I have added unit tests to:
You can easily read and study what we get to what we return in the
testdata/jsonfiles of the extension.Documentation
The coding comments and the README file should be enough for documentation.