logs: introduce LogAttributes type #4342
Open
+23
−19
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
xrmx
added
the
Approve Public API check
aabmass
approved these changes
Dec 10, 2024
lmolkova
reviewed
Dec 14, 2024
| @@ -273,7 +273,7 @@ def get_logger( | |||
| instrumenting_library_version: str = "", | |||
| logger_provider: Optional[LoggerProvider] = None, | |||
| schema_url: Optional[str] = None, | |||
| attributes: Optional[Attributes] = None, | |||
| attributes: LogAttributes = None, | |||
There was a problem hiding this comment.
any reason not to have them as Optional like other params?
There was a problem hiding this comment.
They are, it's just that it's not repeated :)
LogAttributes = Optional[Mapping[str, "AnyValue"]]
There was a problem hiding this comment.
Yeah, but that's not really common. This usually leads to a wrong type inside the function, because you usually want different logic between None (default), and the actual type.
Kludex
suggested changes
Dec 24, 2024
| @@ -273,7 +273,7 @@ def get_logger( | |||
| instrumenting_library_version: str = "", | |||
| logger_provider: Optional[LoggerProvider] = None, | |||
| schema_url: Optional[str] = None, | |||
| attributes: Optional[Attributes] = None, | |||
| attributes: LogAttributes = None, | |||
There was a problem hiding this comment.
Yeah, but that's not really common. This usually leads to a wrong type inside the function, because you usually want different logic between None (default), and the actual type.
Logs attribute accepts AnyValue as AttributeValue add a type to describe that and start using it.
xrmx
force-pushed
the
logs-attributes-typing
branch
from
66ec409 to
57a6fb3
Compare
Kludex
approved these changes
Dec 24, 2024
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
Logs attribute accepts AnyValue as AttributeValue add a type to describe that and start using it.
Fixes #4315
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: