Skip to content

Add more restrictive typing to Log body field #4185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Sep 30, 2024
Merged

Add more restrictive typing to Log body field #4185

Changes from 2 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
48413a2
Add more restrictive custom Any type to LogRecord body field
Ali-Alnosairi Sep 12, 2024
200170d
Rename custom "Any" type to "OtelAny"
Ali-Alnosairi Sep 12, 2024
ff2a0bf
Rename the custom Any union to "AnyValue"
Ali-Alnosairi Sep 13, 2024
ae7b32a
Merge branch 'main' into add_custom_any_type
Ali-Alnosairi Sep 13, 2024
33c0254
Replace AnyValue type to opentelemetry.util.types
Ali-Alnosairi Sep 16, 2024
826e913
Merge branch 'main' into add_custom_any_type
Ali-Alnosairi Sep 17, 2024
a09c449
Merge branch 'main' into add_custom_any_type
lzchen Sep 18, 2024
c5fbc9c
Merge branch 'open-telemetry:main' into add_custom_any_type
Ali-Alnosairi Sep 23, 2024
6fdb6d4
Align AnyValue type definition with OpenTelemetry specification
Ali-Alnosairi Sep 23, 2024
398c9ba
Apply suggestions from code review
xrmx Sep 24, 2024
0bd9fcc
Merge branch 'main' into add_custom_any_type
ocelotl Sep 30, 2024
0396498
Merge branch 'main' into add_custom_any_type
ocelotl Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import warnings
from os import environ
from time import time_ns
from typing import Any, Callable, Optional, Tuple, Union # noqa
from typing import Callable, Dict, List, Optional, Tuple, Union # noqa

from opentelemetry._logs import Logger as APILogger
from opentelemetry._logs import LoggerProvider as APILoggerProvider
Expand Down Expand Up @@ -69,6 +69,10 @@ class LogDroppedAttributesWarning(UserWarning):

warnings.simplefilter("once", LogDroppedAttributesWarning)

OtelAny = Union[
str, bool, int, float, bytes, List["OtelAny"], Dict[str, "OtelAny"], None
]


class LogLimits:
"""This class is based on a SpanLimits class in the Tracing module.
Expand Down Expand Up @@ -179,7 +183,7 @@ def __init__(
trace_flags: Optional[TraceFlags] = None,
severity_text: Optional[str] = None,
severity_number: Optional[SeverityNumber] = None,
body: Optional[Any] = None,
body: Optional[OtelAny] = None,
resource: Optional[Resource] = None,
attributes: Optional[Attributes] = None,
limits: Optional[LogLimits] = _UnsetLogLimits,
Expand Down Expand Up @@ -381,8 +385,8 @@ def add_log_record_processor(
def _submit_and_wait(
self,
func: Callable[[LogRecordProcessor], Callable[..., None]],
*args: Any,
**kwargs: Any,
*args: OtelAny,
**kwargs: OtelAny,
):
futures = []
for lp in self._log_record_processors:
Expand Down