Skip to content

Commit fee11bb

Browse files
hectorhdzghectorhdzg
committed
Rename several classes from Log to LogRecord
1 parent 59baf31 commit fee11bb

File tree

23 files changed

+171
-171
lines changed

23 files changed

+171
-171
lines changed

‎docs/conf.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,8 @@
132132
"py:class",
133133
"opentelemetry.proto.collector.metrics.v1.metrics_service_pb2.ExportMetricsServiceRequest",
134134
),
135-
("py:class", "opentelemetry.sdk._logs._internal.export.LogExporter"),
136-
("py:class", "opentelemetry.sdk._logs._internal.export.LogExportResult"),
135+
("py:class", "opentelemetry.sdk._logs._internal.export.LogRecordExporter"),
136+
("py:class", "opentelemetry.sdk._logs._internal.export.LogRecordExportResult"),
137137
(
138138
"py:class",
139139
"opentelemetry.proto.collector.logs.v1.logs_service_pb2.ExportLogsServiceRequest",

‎exporter/opentelemetry-exporter-otlp-proto-common/src/opentelemetry/exporter/otlp/proto/common/_internal/_log_encoder/__init__.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@
3030
ResourceLogs,
3131
ScopeLogs,
3232
)
33-
from opentelemetry.sdk._logs import LogData
33+
from opentelemetry.sdk._logs import LogRecordData
3434

3535

36-
def encode_logs(batch: Sequence[LogData]) -> ExportLogsServiceRequest:
36+
def encode_logs(batch: Sequence[LogRecordData]) -> ExportLogsServiceRequest:
3737
return ExportLogsServiceRequest(resource_logs=_encode_resource_logs(batch))
3838

3939

40-
def _encode_log(log_data: LogData) -> PB2LogRecord:
40+
def _encode_log(log_data: LogRecordData) -> PB2LogRecord:
4141
span_id = (
4242
None
4343
if log_data.log_record.span_id == 0
@@ -65,7 +65,7 @@ def _encode_log(log_data: LogData) -> PB2LogRecord:
6565
)
6666

6767

68-
def _encode_resource_logs(batch: Sequence[LogData]) -> List[ResourceLogs]:
68+
def _encode_resource_logs(batch: Sequence[LogRecordData]) -> List[ResourceLogs]:
6969
sdk_resource_logs = defaultdict(lambda: defaultdict(list))
7070

7171
for sdk_log in batch:

‎exporter/opentelemetry-exporter-otlp-proto-common/tests/test_log_encoder.py‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
from opentelemetry.proto.resource.v1.resource_pb2 import (
4646
Resource as PB2Resource,
4747
)
48-
from opentelemetry.sdk._logs import LogData, LogLimits
48+
from opentelemetry.sdk._logs import LogRecordData, LogRecordLimits
4949
from opentelemetry.sdk._logs import LogRecord as SDKLogRecord
5050
from opentelemetry.sdk.resources import Resource as SDKResource
5151
from opentelemetry.sdk.util.instrumentation import InstrumentationScope
@@ -83,8 +83,8 @@ def test_dropped_attributes_count(self):
8383
)
8484

8585
@staticmethod
86-
def _get_sdk_log_data() -> List[LogData]:
87-
log1 = LogData(
86+
def _get_sdk_log_data() -> List[LogRecordData]:
87+
log1 = LogRecordData(
8888
log_record=SDKLogRecord(
8989
timestamp=1644650195189786880,
9090
observed_timestamp=1644650195189786881,
@@ -105,7 +105,7 @@ def _get_sdk_log_data() -> List[LogData]:
105105
),
106106
)
107107

108-
log2 = LogData(
108+
log2 = LogRecordData(
109109
log_record=SDKLogRecord(
110110
timestamp=1644650249738562048,
111111
observed_timestamp=1644650249738562049,
@@ -123,7 +123,7 @@ def _get_sdk_log_data() -> List[LogData]:
123123
),
124124
)
125125

126-
log3 = LogData(
126+
log3 = LogRecordData(
127127
log_record=SDKLogRecord(
128128
timestamp=1644650427658989056,
129129
observed_timestamp=1644650427658989057,
@@ -139,7 +139,7 @@ def _get_sdk_log_data() -> List[LogData]:
139139
instrumentation_scope=None,
140140
)
141141

142-
log4 = LogData(
142+
log4 = LogRecordData(
143143
log_record=SDKLogRecord(
144144
timestamp=1644650584292683008,
145145
observed_timestamp=1644650584292683009,
@@ -160,7 +160,7 @@ def _get_sdk_log_data() -> List[LogData]:
160160
),
161161
)
162162

163-
log5 = LogData(
163+
log5 = LogRecordData(
164164
log_record=SDKLogRecord(
165165
timestamp=1644650584292683009,
166166
observed_timestamp=1644650584292683010,
@@ -178,7 +178,7 @@ def _get_sdk_log_data() -> List[LogData]:
178178
),
179179
)
180180

181-
log6 = LogData(
181+
log6 = LogRecordData(
182182
log_record=SDKLogRecord(
183183
timestamp=1644650584292683022,
184184
observed_timestamp=1644650584292683022,
@@ -201,7 +201,7 @@ def _get_sdk_log_data() -> List[LogData]:
201201
),
202202
)
203203

204-
log7 = LogData(
204+
log7 = LogRecordData(
205205
log_record=SDKLogRecord(
206206
timestamp=1644650584292683033,
207207
observed_timestamp=1644650584292683033,
@@ -225,7 +225,7 @@ def _get_sdk_log_data() -> List[LogData]:
225225
),
226226
)
227227

228-
log8 = LogData(
228+
log8 = LogRecordData(
229229
log_record=SDKLogRecord(
230230
timestamp=1644650584292683044,
231231
observed_timestamp=1644650584292683044,
@@ -543,8 +543,8 @@ def get_test_logs(
543543
return sdk_logs, pb2_service_request
544544

545545
@staticmethod
546-
def _get_test_logs_dropped_attributes() -> List[LogData]:
547-
log1 = LogData(
546+
def _get_test_logs_dropped_attributes() -> List[LogRecordData]:
547+
log1 = LogRecordData(
548548
log_record=SDKLogRecord(
549549
timestamp=1644650195189786880,
550550
trace_id=89564621134313219400156819398935297684,
@@ -555,14 +555,14 @@ def _get_test_logs_dropped_attributes() -> List[LogData]:
555555
body="Do not go gentle into that good night. Rage, rage against the dying of the light",
556556
resource=SDKResource({"first_resource": "value"}),
557557
attributes={"a": 1, "b": "c", "user_id": "B121092"},
558-
limits=LogLimits(max_attributes=1),
558+
limits=LogRecordLimits(max_attributes=1),
559559
),
560560
instrumentation_scope=InstrumentationScope(
561561
"first_name", "first_version"
562562
),
563563
)
564564

565-
log2 = LogData(
565+
log2 = LogRecordData(
566566
log_record=SDKLogRecord(
567567
timestamp=1644650249738562048,
568568
trace_id=0,

‎exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/_log_exporter/__init__.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@
2828
from opentelemetry.proto.collector.logs.v1.logs_service_pb2_grpc import (
2929
LogsServiceStub,
3030
)
31-
from opentelemetry.sdk._logs import LogData
31+
from opentelemetry.sdk._logs import LogRecordData
3232
from opentelemetry.sdk._logs import LogRecord as SDKLogRecord
33-
from opentelemetry.sdk._logs.export import LogExporter, LogExportResult
33+
from opentelemetry.sdk._logs.export import LogRecordExporter, LogRecordExportResult
3434
from opentelemetry.sdk.environment_variables import (
3535
OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE,
3636
OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE,
@@ -44,10 +44,10 @@
4444

4545

4646
class OTLPLogExporter(
47-
LogExporter,
48-
OTLPExporterMixin[SDKLogRecord, ExportLogsServiceRequest, LogExportResult],
47+
LogRecordExporter,
48+
OTLPExporterMixin[SDKLogRecord, ExportLogsServiceRequest, LogRecordExportResult],
4949
):
50-
_result = LogExportResult
50+
_result = LogRecordExportResult
5151
_stub = LogsServiceStub
5252

5353
def __init__(
@@ -103,11 +103,11 @@ def __init__(
103103
)
104104

105105
def _translate_data(
106-
self, data: Sequence[LogData]
106+
self, data: Sequence[LogRecordData]
107107
) -> ExportLogsServiceRequest:
108108
return encode_logs(data)
109109

110-
def export(self, batch: Sequence[LogData]) -> LogExportResult:
110+
def export(self, batch: Sequence[LogRecordData]) -> LogRecordExportResult:
111111
return self._export(batch)
112112

113113
def shutdown(self, timeout_millis: float = 30_000, **kwargs) -> None:

‎exporter/opentelemetry-exporter-otlp-proto-grpc/tests/logs/test_otlp_logs_exporter.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
from opentelemetry.proto.resource.v1.resource_pb2 import (
4040
Resource as OTLPResource,
4141
)
42-
from opentelemetry.sdk._logs import LogData, LogRecord
42+
from opentelemetry.sdk._logs import LogRecordData, LogRecord
4343
from opentelemetry.sdk.environment_variables import (
4444
OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE,
4545
OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE,
@@ -59,7 +59,7 @@
5959
class TestOTLPLogExporter(TestCase):
6060
def setUp(self):
6161
self.exporter = OTLPLogExporter()
62-
self.log_data_1 = LogData(
62+
self.log_data_1 = LogRecordData(
6363
log_record=LogRecord(
6464
timestamp=int(time.time() * 1e9),
6565
trace_id=2604504634922341076776623263868986797,
@@ -75,7 +75,7 @@ def setUp(self):
7575
"first_name", "first_version"
7676
),
7777
)
78-
self.log_data_2 = LogData(
78+
self.log_data_2 = LogRecordData(
7979
log_record=LogRecord(
8080
timestamp=int(time.time() * 1e9),
8181
trace_id=2604504634922341076776623263868986799,
@@ -91,7 +91,7 @@ def setUp(self):
9191
"second_name", "second_version"
9292
),
9393
)
94-
self.log_data_3 = LogData(
94+
self.log_data_3 = LogRecordData(
9595
log_record=LogRecord(
9696
timestamp=int(time.time() * 1e9),
9797
trace_id=2604504634922341076776623263868986800,
@@ -106,7 +106,7 @@ def setUp(self):
106106
"third_name", "third_version"
107107
),
108108
)
109-
self.log_data_4 = LogData(
109+
self.log_data_4 = LogRecordData(
110110
log_record=LogRecord(
111111
timestamp=int(time.time() * 1e9),
112112
trace_id=0,
@@ -121,7 +121,7 @@ def setUp(self):
121121
"fourth_name", "fourth_version"
122122
),
123123
)
124-
self.log_data_5 = LogData(
124+
self.log_data_5 = LogRecordData(
125125
log_record=LogRecord(
126126
timestamp=int(time.time() * 1e9),
127127
trace_id=2604504634922341076776623263868986801,

‎exporter/opentelemetry-exporter-otlp-proto-grpc/tests/test_otlp_exporter_mixin.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161

6262

6363
# The below tests use this test SpanExporter and Spans, but are testing the
64-
# underlying behavior in the mixin. A MetricExporter or LogExporter could
64+
# underlying behavior in the mixin. A MetricExporter or LogRecordExporter could
6565
# just as easily be used.
6666
class OTLPSpanExporterForTesting(
6767
SpanExporter,

‎exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/_log_exporter/__init__.py‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@
3232
from opentelemetry.exporter.otlp.proto.http._common import (
3333
_is_retryable,
3434
)
35-
from opentelemetry.sdk._logs import LogData
35+
from opentelemetry.sdk._logs import LogRecordData
3636
from opentelemetry.sdk._logs.export import (
37-
LogExporter,
38-
LogExportResult,
37+
LogRecordExporter,
38+
LogRecordExportResult,
3939
)
4040
from opentelemetry.sdk.environment_variables import (
4141
OTEL_EXPORTER_OTLP_CERTIFICATE,
@@ -65,7 +65,7 @@
6565
_MAX_RETRYS = 6
6666

6767

68-
class OTLPLogExporter(LogExporter):
68+
class OTLPLogExporter(LogRecordExporter):
6969
def __init__(
7070
self,
7171
endpoint: Optional[str] = None,
@@ -156,17 +156,17 @@ def _export(self, serialized_data: bytes, timeout_sec: float):
156156
)
157157
return resp
158158

159-
def export(self, batch: Sequence[LogData]) -> LogExportResult:
159+
def export(self, batch: Sequence[LogRecordData]) -> LogRecordExportResult:
160160
if self._shutdown:
161161
_logger.warning("Exporter already shutdown, ignoring batch")
162-
return LogExportResult.FAILURE
162+
return LogRecordExportResult.FAILURE
163163

164164
serialized_data = encode_logs(batch).SerializeToString()
165165
deadline_sec = time() + self._timeout
166166
for retry_num in range(_MAX_RETRYS):
167167
resp = self._export(serialized_data, deadline_sec - time())
168168
if resp.ok:
169-
return LogExportResult.SUCCESS
169+
return LogRecordExportResult.SUCCESS
170170
# multiplying by a random number between .8 and 1.2 introduces a +/20% jitter to each backoff.
171171
backoff_seconds = 2**retry_num * random.uniform(0.8, 1.2)
172172
if (
@@ -179,15 +179,15 @@ def export(self, batch: Sequence[LogData]) -> LogExportResult:
179179
resp.status_code,
180180
resp.text,
181181
)
182-
return LogExportResult.FAILURE
182+
return LogRecordExportResult.FAILURE
183183
_logger.warning(
184184
"Transient error %s encountered while exporting logs batch, retrying in %.2fs.",
185185
resp.reason,
186186
backoff_seconds,
187187
)
188188
sleep(backoff_seconds)
189189
# Not possible to reach here but the linter is complaining.
190-
return LogExportResult.FAILURE
190+
return LogRecordExportResult.FAILURE
191191

192192
def force_flush(self, timeout_millis: float = 10_000) -> bool:
193193
"""Nothing is buffered in this exporter, so this method does nothing."""

‎exporter/opentelemetry-exporter-otlp-proto-http/tests/test_proto_log_exporter.py‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@
3838
from opentelemetry.proto.collector.logs.v1.logs_service_pb2 import (
3939
ExportLogsServiceRequest,
4040
)
41-
from opentelemetry.sdk._logs import LogData
41+
from opentelemetry.sdk._logs import LogRecordData
4242
from opentelemetry.sdk._logs import LogRecord as SDKLogRecord
43-
from opentelemetry.sdk._logs.export import LogExportResult
43+
from opentelemetry.sdk._logs.export import LogRecordExportResult
4444
from opentelemetry.sdk.environment_variables import (
4545
OTEL_EXPORTER_OTLP_CERTIFICATE,
4646
OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE,
@@ -217,7 +217,7 @@ def export_log_and_deserialize(log):
217217
return log_records
218218

219219
def test_exported_log_without_trace_id(self):
220-
log = LogData(
220+
log = LogRecordData(
221221
log_record=SDKLogRecord(
222222
timestamp=1644650195189786182,
223223
trace_id=0,
@@ -244,7 +244,7 @@ def test_exported_log_without_trace_id(self):
244244
self.fail("No log records found")
245245

246246
def test_exported_log_without_span_id(self):
247-
log = LogData(
247+
log = LogRecordData(
248248
log_record=SDKLogRecord(
249249
timestamp=1644650195189786360,
250250
trace_id=89564621134313219400156819398935297696,
@@ -271,8 +271,8 @@ def test_exported_log_without_span_id(self):
271271
self.fail("No log records found")
272272

273273
@staticmethod
274-
def _get_sdk_log_data() -> List[LogData]:
275-
log1 = LogData(
274+
def _get_sdk_log_data() -> List[LogRecordData]:
275+
log1 = LogRecordData(
276276
log_record=SDKLogRecord(
277277
timestamp=1644650195189786880,
278278
trace_id=89564621134313219400156819398935297684,
@@ -289,7 +289,7 @@ def _get_sdk_log_data() -> List[LogData]:
289289
),
290290
)
291291

292-
log2 = LogData(
292+
log2 = LogRecordData(
293293
log_record=SDKLogRecord(
294294
timestamp=1644650249738562048,
295295
trace_id=0,
@@ -306,7 +306,7 @@ def _get_sdk_log_data() -> List[LogData]:
306306
),
307307
)
308308

309-
log3 = LogData(
309+
log3 = LogRecordData(
310310
log_record=SDKLogRecord(
311311
timestamp=1644650427658989056,
312312
trace_id=271615924622795969659406376515024083555,
@@ -321,7 +321,7 @@ def _get_sdk_log_data() -> List[LogData]:
321321
instrumentation_scope=None,
322322
)
323323

324-
log4 = LogData(
324+
log4 = LogRecordData(
325325
log_record=SDKLogRecord(
326326
timestamp=1644650584292683008,
327327
trace_id=212592107417388365804938480559624925555,
@@ -347,7 +347,7 @@ def test_2xx_status_code(self, mock_otlp_metric_exporter):
347347
"""
348348

349349
self.assertEqual(
350-
OTLPLogExporter().export(MagicMock()), LogExportResult.SUCCESS
350+
OTLPLogExporter().export(MagicMock()), LogRecordExportResult.SUCCESS
351351
)
352352

353353
@patch.object(Session, "post")
@@ -363,7 +363,7 @@ def test_retry_timeout(self, mock_post):
363363
# Set timeout to 1.5 seconds
364364
self.assertEqual(
365365
exporter.export(self._get_sdk_log_data()),
366-
LogExportResult.FAILURE,
366+
LogRecordExportResult.FAILURE,
367367
)
368368
after = time.time()
369369
# First call at time 0, second at time 1, then an early return before the second backoff sleep b/c it would exceed timeout.

0 commit comments

Comments
 (0)