Fixup Logger.emit signature

Author: xrmx

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

@@ -33,6 +33,8 @@
 .. versionadded:: 1.15.0
 """
 
+from __future__ import annotations
+
 from abc import ABC, abstractmethod
 from logging import getLogger
 from os import environ
@@ -144,7 +146,20 @@ def __init__(
         self._attributes = attributes
 
     @abstractmethod
-    def emit(self, record: "LogRecord") -> None:
+    def emit(
+        self,
+        # record parameter does not match the spec but we'll remove it in a later release
+        record: "LogRecord | None" = None,
+        *,
+        timestamp: int | None = None,
+        observed_timestamp: int | None = None,
+        context: Context | None = None,
+        severity_number: SeverityNumber | None = None,
+        severity_text: str | None = None,
+        body: AnyValue | None = None,
+        attributes: _ExtendedAttributes | None = None,
+        event_name: str | None = None,
+    ) -> None:
         """Emits a :class:`LogRecord` representing a log to the processing pipeline."""
 
 
@@ -154,7 +169,20 @@ class NoOpLogger(Logger):
     All operations are no-op.
     """
 
-    def emit(self, record: "LogRecord") -> None:
+    def emit(
+        self,
+        # record parameter does not match the spec but we'll remove it in a later release
+        record: "LogRecord | None" = None,
+        *,
+        timestamp: int | None = None,
+        observed_timestamp: int | None = None,
+        context: Context | None = None,
+        severity_number: SeverityNumber | None = None,
+        severity_text: str | None = None,
+        body: AnyValue | None = None,
+        attributes: _ExtendedAttributes | None = None,
+        event_name: str | None = None,
+    ) -> None:
         pass
 
 
@@ -188,8 +216,33 @@ def _logger(self) -> Logger:
             return self._real_logger
         return self._noop_logger
 
-    def emit(self, record: LogRecord) -> None:
-        self._logger.emit(record)
+    def emit(
+        self,
+        # record parameter does not match the spec but we'll remove it in a later release
+        record: LogRecord | None = None,
+        *,
+        timestamp: int | None = None,
+        observed_timestamp: int | None = None,
+        context: Context | None = None,
+        severity_number: SeverityNumber | None = None,
+        severity_text: str | None = None,
+        body: AnyValue | None = None,
+        attributes: _ExtendedAttributes | None = None,
+        event_name: str | None = None,
+    ) -> None:
+        if record:
+            self._logger.emit(record)
+        else:
+            self._logger.emit(
+                timestamp=timestamp,
+                observed_timestamp=observed_timestamp,
+                context=context,
+                severity_number=severity_number,
+                severity_text=severity_text,
+                body=body,
+                attributes=attributes,
+                event_name=event_name,
+            )
 
 
 class LoggerProvider(ABC):

opentelemetry-api/tests/logs/test_proxy.py

@@ -34,7 +34,19 @@ def get_logger(
 
 
 class LoggerTest(_logs.NoOpLogger):
-    def emit(self, record: _logs.LogRecord) -> None:
+    def emit(
+        self,
+        record: typing.Optional[_logs.LogRecord] = None,
+        *,
+        timestamp=None,
+        observed_timestamp=None,
+        context=None,
+        severity_number=None,
+        severity_text=None,
+        body=None,
+        attributes=None,
+        event_name=None,
+    ) -> None:
         pass
 
 

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

@@ -619,16 +619,17 @@ def _translate(self, record: logging.LogRecord) -> LogRecord:
             "WARN" if record.levelname == "WARNING" else record.levelname
         )
 
-        logger = get_logger(record.name, logger_provider=self._logger_provider)
-        return LogRecord(
+        # FIXME: what to do with the resource?
+        # logger = get_logger(record.name, logger_provider=self._logger_provider)
+        return dict(
             timestamp=timestamp,
             observed_timestamp=observered_timestamp,
             context=get_current() or None,
             severity_text=level_name,
             severity_number=severity_number,
             body=body,
-            resource=logger.resource,
             attributes=attributes,
+            # resource=logger.resource,
         )
 
     def emit(self, record: logging.LogRecord) -> None:
@@ -639,7 +640,7 @@ def emit(self, record: logging.LogRecord) -> None:
         """
         logger = get_logger(record.name, logger_provider=self._logger_provider)
         if not isinstance(logger, NoOpLogger):
-            logger.emit(self._translate(record))
+            logger.emit(**self._translate(record))
 
     def flush(self) -> None:
         """
@@ -678,11 +679,37 @@ def __init__(
     def resource(self):
         return self._resource
 
-    def emit(self, record: LogRecord):
+    def emit(
+        self,
+        # record is not on the specs and will be deprecated in a followup release
+        record: LogRecord | None = None,
+        *,
+        timestamp: int | None = None,
+        observed_timestamp: int | None = None,
+        context: Context | None = None,
+        severity_text: str | None = None,
+        severity_number: SeverityNumber | None = None,
+        body: AnyValue | None = None,
+        attributes: _ExtendedAttributes | None = None,
+        event_name: str | None = None,
+    ):
         """Emits the :class:`LogData` by associating :class:`LogRecord`
         and instrumentation info.
         """
+        if not record:
+            record = LogRecord(
+                timestamp=timestamp,
+                observed_timestamp=observed_timestamp,
+                context=context,
+                severity_text=severity_text,
+                severity_number=severity_number,
+                body=body,
+                attributes=attributes,
+                event_name=event_name,
+            )
+
         log_data = LogData(record, self._instrumentation_scope)
+
         self._multi_log_record_processor.on_emit(log_data)
 
 

opentelemetry-sdk/tests/test_configurator.py

@@ -113,7 +113,19 @@ def __init__(self, name, resource, processor):
         self.resource = resource
         self.processor = processor
 
-    def emit(self, record):
+    def emit(
+        self,
+        record=None,
+        *,
+        timestamp=None,
+        observed_timestamp=None,
+        context=None,
+        severity_number=None,
+        severity_text=None,
+        body=None,
+        attributes=None,
+        event_name=None,
+    ):
         self.processor.emit(record)