Use overload and deprecate the Logger.emit interface with just logrecord

Author: xrmx

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

@@ -145,10 +145,32 @@ def __init__(
         self._schema_url = schema_url
         self._attributes = attributes
 
+    @overload
+    def emit(
+        self,
+        *,
+        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: ...
+
+    @overload
+    @deprecated(
+        "Logger.emit with record parameter is deprecated since 1.38.0, use the keyword arguments instead."
+    )
+    def emit(
+        self,
+        record: "LogRecord",
+    ) -> None: ...
+
     @abstractmethod
     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,
@@ -169,9 +191,32 @@ class NoOpLogger(Logger):
     All operations are no-op.
     """
 
+    @overload
+    def emit(
+        self,
+        *,
+        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: ...
+
+    @overload
+    @deprecated(
+        "Logger.emit with record parameter is deprecated since 1.38.0, use the keyword arguments instead."
+    )
+    def emit(
+        self,
+        record: "LogRecord",
+    ) -> None: ...
+
+    @abstractmethod
     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,
@@ -216,9 +261,31 @@ def _logger(self) -> Logger:
             return self._real_logger
         return self._noop_logger
 
+    @overload
+    def emit(
+        self,
+        *,
+        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: ...
+
+    @overload
+    @deprecated(
+        "Logger.emit with record parameter is deprecated since 1.38.0, use the keyword arguments instead."
+    )
+    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,

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

@@ -693,9 +693,31 @@ def __init__(
     def resource(self):
         return self._resource
 
+    @overload
+    def emit(
+        self,
+        *,
+        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: ...
+
+    @overload
+    @deprecated(
+        "Logger.emit with record parameter is deprecated since 1.38.0, use the keyword arguments instead."
+    )
+    def emit(
+        self,
+        record: "LogRecord",
+    ) -> None: ...
+
     def emit(
         self,
-        # record is not on the specs and will be deprecated in a followup release
         record: APILogRecord | None = None,
         *,
         timestamp: int | None = None,
@@ -710,6 +732,8 @@ def emit(
         """Emits the :class:`LogData` by associating :class:`LogRecord`
         and instrumentation info.
         """
+        # TODO: add a warning after 1.39.0 for deprecated interface
+
         if not record:
             record = LogRecord(
                 timestamp=timestamp,