Merge branch 'main' into fix-logs-warning

Author: xrmx

CHANGELOG.md

@@ -28,6 +28,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#4597](https://github.com/open-telemetry/opentelemetry-python/pull/4597))
 - sdk: use context instead of trace_id,span_id for initializing LogRecord
   ([#4653](https://github.com/open-telemetry/opentelemetry-python/pull/4653))
+- Rename LogRecordProcessor.emit to on_emit
+  ([#4648](https://github.com/open-telemetry/opentelemetry-python/pull/4648))
 - Logging API hide std_to_otel function to convert python logging severity to otel severity
   ([#4649](https://github.com/open-telemetry/opentelemetry-python/pull/4649))
 

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

@@ -352,7 +352,7 @@ class LogRecordProcessor(abc.ABC):
     """
 
     @abc.abstractmethod
-    def emit(self, log_data: LogData):
+    def on_emit(self, log_data: LogData):
         """Emits the `LogData`"""
 
     @abc.abstractmethod
@@ -396,9 +396,9 @@ def add_log_record_processor(
         with self._lock:
             self._log_record_processors += (log_record_processor,)
 
-    def emit(self, log_data: LogData) -> None:
+    def on_emit(self, log_data: LogData) -> None:
         for lp in self._log_record_processors:
-            lp.emit(log_data)
+            lp.on_emit(log_data)
 
     def shutdown(self) -> None:
         """Shutdown the log processors one by one"""
@@ -470,8 +470,8 @@ def _submit_and_wait(
         for future in futures:
             future.result()
 
-    def emit(self, log_data: LogData):
-        self._submit_and_wait(lambda lp: lp.emit, log_data)
+    def on_emit(self, log_data: LogData):
+        self._submit_and_wait(lambda lp: lp.on_emit, log_data)
 
     def shutdown(self):
         self._submit_and_wait(lambda lp: lp.shutdown)
@@ -675,7 +675,7 @@ def emit(self, record: LogRecord):
         and instrumentation info.
         """
         log_data = LogData(record, self._instrumentation_scope)
-        self._multi_log_record_processor.emit(log_data)
+        self._multi_log_record_processor.on_emit(log_data)
 
 
 class LoggerProvider(APILoggerProvider):

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

@@ -112,7 +112,7 @@ def __init__(self, exporter: LogExporter):
         self._exporter = exporter
         self._shutdown = False
 
-    def emit(self, log_data: LogData):
+    def on_emit(self, log_data: LogData):
         if self._shutdown:
             _logger.warning("Processor is already shutdown, ignoring call")
             return
@@ -186,7 +186,7 @@ def __init__(
             "Log",
         )
 
-    def emit(self, log_data: LogData) -> None:
+    def on_emit(self, log_data: LogData) -> None:
         return self._batch_processor.emit(log_data)
 
     def shutdown(self):

opentelemetry-sdk/tests/logs/test_export.py

@@ -353,7 +353,7 @@ def test_emit_call_log_record(self):
         logger.addHandler(LoggingHandler(logger_provider=provider))
 
         logger.error("error")
-        self.assertEqual(log_record_processor.emit.call_count, 1)
+        self.assertEqual(log_record_processor.on_emit.call_count, 1)
         log_record_processor.shutdown()
 
     def test_with_multiple_threads(self):  # pylint: disable=no-self-use
@@ -368,7 +368,7 @@ def test_with_multiple_threads(self):  # pylint: disable=no-self-use
 
         def bulk_emit(num_emit):
             for _ in range(num_emit):
-                batch_processor.emit(EMPTY_LOG)
+                batch_processor.on_emit(EMPTY_LOG)
 
         total_expected_logs = 0
         with ThreadPoolExecutor(max_workers=69) as executor:
@@ -409,10 +409,10 @@ def test_logging_lib_not_invoked_in_batch_log_record_emit(self):  # pylint: disa
         # If `emit` calls logging.log then this test will throw a maximum recursion depth exceeded exception and fail.
         try:
             with self.assertNoLogs(sdk_logger, logging.NOTSET):
-                processor.emit(EMPTY_LOG)
+                processor.on_emit(EMPTY_LOG)
             processor.shutdown()
             with self.assertNoLogs(sdk_logger, logging.NOTSET):
-                processor.emit(EMPTY_LOG)
+                processor.on_emit(EMPTY_LOG)
         finally:
             sdk_logger.removeHandler(handler)
 

opentelemetry-sdk/tests/logs/test_handler.py

@@ -384,7 +384,7 @@ class FakeProcessor(LogRecordProcessor):
     def __init__(self):
         self.log_data_emitted = []
 
-    def emit(self, log_data: LogData):
+    def on_emit(self, log_data: LogData):
         self.log_data_emitted.append(log_data)
 
     def shutdown(self):

opentelemetry-sdk/tests/logs/test_multi_log_processor.py

@@ -38,7 +38,7 @@ def __init__(self, exporter, logs_list):
         self._log_list = logs_list
         self._closed = False
 
-    def emit(self, log_data):
+    def on_emit(self, log_data):
         if self._closed:
             return
         self._log_list.append(
@@ -118,9 +118,9 @@ def test_on_emit(self):
         for mock in mocks:
             multi_log_record_processor.add_log_record_processor(mock)
         record = self.make_record()
-        multi_log_record_processor.emit(record)
+        multi_log_record_processor.on_emit(record)
         for mock in mocks:
-            mock.emit.assert_called_with(record)
+            mock.on_emit.assert_called_with(record)
         multi_log_record_processor.shutdown()
 
     def test_on_shutdown(self):