[GCP encoding] Use JSON struct for all common fields and improve performance #41467
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
atoulme
approved these changes
Jul 22, 2025
|
@alexvanboxel please take a look as codeowner |
|
Please @alexvanboxel, can you take a look? Thanks :) |
alexvanboxel
suggested changes
Jul 29, 2025
extension/encoding/googlecloudlogentryencodingextension/log_proto_payload_test.go
Show resolved
Hide resolved
alexvanboxel
approved these changes
Jul 29, 2025
|
@atoulme can you merge this PR now that it is approved? Thank you |
dehaansa
reviewed
Jul 29, 2025
| ) | ||
|
|
||
| var json = jsoniter.ConfigCompatibleWithStandardLibrary | ||
| // See: https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry | ||
| type logEntry struct { |
There was a problem hiding this comment.
Is there a reason to not use the upstream definitions?
There was a problem hiding this comment.
Sorry, what do you mean?
There was a problem hiding this comment.
I understand what you mean now.
There are fields missing from the definitions: app hub and error groups, for example
atoulme
pushed a commit
that referenced
this pull request
Jul 29, 2025
|
Please resolve conflicts |
|
@atoulme conflicts are fixed |
Dylan-M
pushed a commit
to Dylan-M/opentelemetry-collector-contrib
that referenced
this pull request
Aug 5, 2025
This PR transfers ownership of the GCP encoding. My contributions: - open-telemetry#41087 - open-telemetry#41446 - open-telemetry#41467 - open-telemetry#41137
Dylan-M
pushed a commit
to Dylan-M/opentelemetry-collector-contrib
that referenced
this pull request
Aug 5, 2025
…ormance (open-telemetry#41467) #### Description This PR uses a JSON struct now instead of `map[string]any`, as we know what to expect from a GCP log entry. This causes significant performance improvement: ``` goos: linux goarch: amd64 pkg: github.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding/googlecloudlogentryencodingextension cpu: 11th Gen Intel(R) Core(TM) i7-11800H @ 2.30GHz │ old.txt │ new.txt │ │ sec/op │ sec/op vs base │ Test-16 19.907µ ± 3% 6.583µ ± 4% -66.93% (p=0.000 n=10) │ old.txt │ new.txt │ │ B/op │ B/op vs base │ Test-16 13.310Ki ± 0% 5.326Ki ± 0% -59.98% (p=0.000 n=10) │ old.txt │ new.txt │ │ allocs/op │ allocs/op vs base │ Test-16 340.00 ± 0% 90.00 ± 0% -73.53% (p=0.000 n=10) ``` The main goal of using a JSON struct is so that we can use semantic conventions, like mentioned in issue open-telemetry#41087. There are also two breaking changes, since the code implemented before was not working correctly for these cases: - Logs also have now observedTimeUnixNano and flags - If there is an error handling the log, just return the error and empty logs for ALL cases. Before this behavior was inconsistent: either the error was ignored ([here](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/5943f5a933843e6f81bed28a05e2f33d8c1fc485/extension/encoding/googlecloudlogentryencodingextension/extension.go#L86)), or it would stop the logs from being received ([here](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/5943f5a933843e6f81bed28a05e2f33d8c1fc485/extension/encoding/googlecloudlogentryencodingextension/extension.go#L94)) <!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. --> #### Link to tracking issue Relates to open-telemetry#41087 (comment). <!--Describe what testing was performed and which tests were added.--> #### Testing Unit tests fixed. <!--Describe the documentation added.--> #### Documentation N/A.
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 uses a JSON struct now instead of
map[string]any, as we know what to expect from a GCP log entry. This causes significant performance improvement:The main goal of using a JSON struct is so that we can use semantic conventions, like mentioned in issue #41087.
There are also two breaking changes, since the code implemented before was not working correctly for these cases:
Link to tracking issue
Relates to #41087 (comment).
Testing
Unit tests fixed.
Documentation
N/A.