Skip to content

Commit 43341d7

Browse files
authored
Adjust deprecation warning in LogRecord to also use deprecated decorator (#4664)
* Adjust deprecation warning in LogRecord to also use deprecated decorator * fix
1 parent 9426d6d commit 43341d7

File tree

3 files changed

+12
-2
lines changed

3 files changed

+12
-2
lines changed

opentelemetry-api/src/opentelemetry/_logs/_internal/__init__.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@
3939
from time import time_ns
4040
from typing import Optional, cast, overload
4141

42+
from typing_extensions import deprecated
43+
4244
from opentelemetry._logs.severity import SeverityNumber
4345
from opentelemetry.context.context import Context
4446
from opentelemetry.environment_variables import _OTEL_PYTHON_LOGGER_PROVIDER
@@ -73,6 +75,9 @@ def __init__(
7375
) -> None: ...
7476

7577
@overload
78+
@deprecated(
79+
"LogRecord init with `trace_id`, `span_id`, and/or `trace_flags` is deprecated since 1.35.0. Use `context` instead."
80+
)
7681
def __init__(
7782
self,
7883
*,

opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@
2727
from time import time_ns
2828
from typing import Any, Callable, Tuple, Union, cast, overload # noqa
2929

30+
from typing_extensions import deprecated
31+
3032
from opentelemetry._logs import Logger as APILogger
3133
from opentelemetry._logs import LoggerProvider as APILoggerProvider
3234
from opentelemetry._logs import LogRecord as APILogRecord
@@ -209,6 +211,9 @@ def __init__(
209211
): ...
210212

211213
@overload
214+
@deprecated(
215+
"LogRecord init with `trace_id`, `span_id`, and/or `trace_flags` is deprecated since 1.35.0. Use `context` instead." # noqa: E501
216+
)
212217
def __init__(
213218
self,
214219
timestamp: int | None = None,
@@ -242,7 +247,7 @@ def __init__( # pylint:disable=too-many-locals
242247
):
243248
if trace_id or span_id or trace_flags:
244249
warnings.warn(
245-
"LogRecord init with `trace_id`, `span_id`, and/or `trace_flags` is deprecated. Use `context` instead.",
250+
"LogRecord init with `trace_id`, `span_id`, and/or `trace_flags` is deprecated since 1.35.0. Use `context` instead.",
246251
LogDeprecatedInitWarning,
247252
stacklevel=2,
248253
)

opentelemetry-sdk/tests/logs/test_log_record.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ def test_log_record_deprecated_init_warning(self):
164164
self.assertEqual(len(cw), 1)
165165
self.assertIsInstance(cw[-1].message, LogDeprecatedInitWarning)
166166
self.assertIn(
167-
"LogRecord init with `trace_id`, `span_id`, and/or `trace_flags` is deprecated. Use `context` instead.",
167+
"LogRecord init with `trace_id`, `span_id`, and/or `trace_flags` is deprecated since 1.35.0. Use `context` instead.",
168168
str(cw[-1].message),
169169
)
170170

0 commit comments

Comments
 (0)