opentelemetry-exporter-otlp-proto-common: permit to serialize null values in logs #4400
+68
−7
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
lzchen
approved these changes
Jan 27, 2025
xrmx
commented
Jan 28, 2025
...xporter-otlp-proto-common/src/opentelemetry/exporter/otlp/proto/common/_internal/__init__.py
Outdated
Show resolved
Hide resolved
…metry/exporter/otlp/proto/common/_internal/__init__.py
lmolkova
reviewed
Jan 28, 2025
| @@ -66,7 +66,11 @@ def _encode_resource(resource: Resource) -> PB2Resource: | |||
| return PB2Resource(attributes=_encode_attributes(resource.attributes)) | |||
|
|
|||
|
|
|||
| def _encode_value(value: Any) -> PB2AnyValue: | |||
| def _encode_value( | |||
| value: Any, allow_null: bool = False | |||
There was a problem hiding this comment.
is there a need for allow_null = False? could we allow nulls for everything?
There was a problem hiding this comment.
_encode_value is used via _encode_key_value by _encode_attributes that is used also by the metrics and trace encoders and did not want to change their behavior.
There was a problem hiding this comment.
A couple of thoughts:
- I'd imagine complex attributes on logs/events would also be prone to the same problem. It'd be nice to allow log attributes to have null values. So I think we should allow log attributes to have null values inside complex payloads.
- [minor] Allowing null values would not be a breaking change (it was not allowed before so nobody could add a null attribute), so I still wonder if additional logic is necessary.
There was a problem hiding this comment.
What do you mean with complex attributes? _encode_value is recursive so we are handling null values nested in arrays and maps.
There was a problem hiding this comment.
I mean not just the body, but also logrecord attributes
exporter/opentelemetry-exporter-otlp-proto-common/tests/test_log_encoder.py
Show resolved
Hide resolved
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 fixes logs encoding to work with body if it is a mapping with null keys.
Fixes #4279
Fixes #4392
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Does This PR Require a Contrib Repo Change?
Checklist: