Skip to content

Commit cdac4c1

Browse files
committed
Add deprecated classes back
1 parent 77535d0 commit cdac4c1

File tree

5 files changed

+63
-2
lines changed

5 files changed

+63
-2
lines changed

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@
1313
# limitations under the License.
1414

1515
from opentelemetry.sdk._logs._internal import (
16+
LogDroppedAttributesWarning,
1617
Logger,
1718
LoggerProvider,
1819
LoggingHandler,
20+
LogLimits,
1921
LogRecordDroppedAttributesWarning,
2022
LogRecordLimits,
2123
LogRecordProcessor,
@@ -24,12 +26,14 @@
2426
)
2527

2628
__all__ = [
27-
"LogRecordDroppedAttributesWarning",
2829
"Logger",
2930
"LoggerProvider",
3031
"LoggingHandler",
32+
"LogLimits",
3133
"LogRecordLimits",
3234
"LogRecordProcessor",
35+
"LogDroppedAttributesWarning",
36+
"LogRecordDroppedAttributesWarning",
3337
"ReadableLogRecord",
3438
"ReadWriteLogRecord",
3539
]

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
from time import time_ns
2929
from typing import Any, Callable, Tuple, Union, cast, overload # noqa
3030

31+
from typing_extensions import deprecated
32+
3133
from opentelemetry._logs import Logger as APILogger
3234
from opentelemetry._logs import LoggerProvider as APILoggerProvider
3335
from opentelemetry._logs import (
@@ -79,6 +81,13 @@ class LogRecordDroppedAttributesWarning(UserWarning):
7981
warnings.simplefilter("once", LogRecordDroppedAttributesWarning)
8082

8183

84+
@deprecated(
85+
"Use LogRecordDroppedAttributesWarning. Since logs are not stable yet this WILL be removed in future releases."
86+
)
87+
class LogDroppedAttributesWarning(LogRecordDroppedAttributesWarning):
88+
pass
89+
90+
8291
class LogRecordLimits:
8392
"""This class is based on a SpanLimits class in the Tracing module.
8493
@@ -159,6 +168,13 @@ def _from_env_if_absent(
159168
return value
160169

161170

171+
@deprecated(
172+
"Use LogRecordLimits. Since logs are not stable yet this WILL be removed in future releases."
173+
)
174+
class LogLimits(LogRecordLimits):
175+
pass
176+
177+
162178
@dataclass(frozen=True)
163179
class ReadableLogRecord:
164180
"""Readable LogRecord should be kept exactly in-sync with ReadWriteLogRecord, only difference is the frozen=True param."""

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

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
from os import environ, linesep
2121
from typing import IO, Callable, Optional, Sequence
2222

23+
from typing_extensions import deprecated
24+
2325
from opentelemetry.context import (
2426
_SUPPRESS_INSTRUMENTATION_KEY,
2527
attach,
@@ -56,6 +58,14 @@ class LogRecordExportResult(enum.Enum):
5658
FAILURE = 1
5759

5860

61+
@deprecated(
62+
"Use LogRecordExportResult. Since logs are not stable yet this WILL be removed in future releases."
63+
)
64+
class LogExportResult(enum.Enum):
65+
SUCCESS = 0
66+
FAILURE = 1
67+
68+
5969
class LogRecordExporter(abc.ABC):
6070
"""Interface for exporting logs.
6171
Interface to be implemented by services that want to export logs received
@@ -83,6 +93,13 @@ def shutdown(self):
8393
"""
8494

8595

96+
@deprecated(
97+
"Use LogRecordExporter. Since logs are not stable yet this WILL be removed in future releases."
98+
)
99+
class LogExporter(LogRecordExporter):
100+
pass
101+
102+
86103
class ConsoleLogRecordExporter(LogRecordExporter):
87104
"""Implementation of :class:`LogRecordExporter` that prints log records to the
88105
console.
@@ -111,6 +128,13 @@ def shutdown(self):
111128
pass
112129

113130

131+
@deprecated(
132+
"Use ConsoleLogRecordExporter. Since logs are not stable yet this WILL be removed in future releases."
133+
)
134+
class ConsoleLogExporter(ConsoleLogRecordExporter):
135+
pass
136+
137+
114138
class SimpleLogRecordProcessor(LogRecordProcessor):
115139
"""This is an implementation of LogRecordProcessor which passes
116140
received logs directly to the configured LogRecordExporter, as soon as they are emitted.

opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/export/in_memory_log_exporter.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
import threading
1616
import typing
1717

18-
from opentelemetry.sdk._logs._internal import ReadableLogRecord
18+
from typing_extensions import deprecated
19+
20+
from opentelemetry.sdk._logs import ReadableLogRecord
1921
from opentelemetry.sdk._logs.export import (
2022
LogRecordExporter,
2123
LogRecordExportResult,
@@ -54,3 +56,10 @@ def export(
5456

5557
def shutdown(self) -> None:
5658
self._stopped = True
59+
60+
61+
@deprecated(
62+
"Use InMemoryLogRecordExporter. Since logs are not stable yet this WILL be removed in future releases."
63+
)
64+
class InMemoryLogExporter(InMemoryLogRecordExporter):
65+
pass

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,30 @@
1414

1515
from opentelemetry.sdk._logs._internal.export import (
1616
BatchLogRecordProcessor,
17+
ConsoleLogExporter,
1718
ConsoleLogRecordExporter,
19+
LogExporter,
20+
LogExportResult,
1821
LogRecordExporter,
1922
LogRecordExportResult,
2023
SimpleLogRecordProcessor,
2124
)
2225

2326
# The point module is not in the export directory to avoid a circular import.
2427
from opentelemetry.sdk._logs._internal.export.in_memory_log_exporter import (
28+
InMemoryLogExporter,
2529
InMemoryLogRecordExporter,
2630
)
2731

2832
__all__ = [
2933
"BatchLogRecordProcessor",
34+
"ConsoleLogExporter",
3035
"ConsoleLogRecordExporter",
36+
"LogExporter",
3137
"LogRecordExporter",
38+
"LogExportResult",
3239
"LogRecordExportResult",
3340
"SimpleLogRecordProcessor",
41+
"InMemoryLogExporter",
3442
"InMemoryLogRecordExporter",
3543
]

0 commit comments

Comments
 (0)