change to StructlogHandler, updates

Author: JWinermaSplunk

instrumentation/opentelemetry-instrumentation-structlog/src/opentelemetry/instrumentation/structlog/__init__.py

@@ -137,7 +137,7 @@ def std_to_otel(levelno: int) -> SeverityNumber:
     return _STD_TO_OTEL[levelno]
 
 
-class OpenTelemetryProcessor:
+class StructlogHandler:
     """
     A structlog processor that translates structlog events into OpenTelemetry LogRecords.
 
@@ -255,7 +255,7 @@ def _translate(self, event_dict: dict) -> LogRecord:
         attributes = self._get_attributes(event_dict)
 
         # Get the current OTel context (includes trace context and baggage)
-        context = get_current() or None
+        context = get_current()
 
         return LogRecord(
             timestamp=timestamp,
@@ -286,7 +286,7 @@ class StructlogInstrumentor(BaseInstrumentor):
     """
     An instrumentor for the structlog logging library.
 
-    This instrumentor adds an OpenTelemetryProcessor to the structlog processor
+    This instrumentor adds an StructlogHandler to the structlog processor
     chain, enabling automatic emission of structlog events as OpenTelemetry logs.
 
     Example:
@@ -305,21 +305,35 @@ def instrumentation_dependencies(self) -> Collection[str]:
 
     def _instrument(self, **kwargs):
         """
-        Add the OpenTelemetryProcessor to structlog's processor chain.
+        Add the StructlogHandler to structlog's processor chain.
+
+        The handler is inserted before the last processor in the current chain.
+        This assumes the last processor is a renderer (e.g. ConsoleRenderer,
+        JSONRenderer). The handler must run before rendering so it receives the
+        raw event dict rather than a formatted string.
+
+        If your chain does not end with a renderer, or has post-processing steps
+        after the renderer, configure the chain manually instead of relying on
+        auto-instrumentation:
+
+            structlog.configure(processors=[
+                structlog.stdlib.add_log_level,
+                StructlogHandler(logger_provider=provider),
+                structlog.dev.ConsoleRenderer(),
+            ])
 
         Args:
             logger_provider: Optional LoggerProvider to use.
         """
         # Create the OTel processor
         logger_provider = kwargs.get("logger_provider")
-        processor = OpenTelemetryProcessor(logger_provider=logger_provider)
+        processor = StructlogHandler(logger_provider=logger_provider)
 
         # Get current structlog configuration
         config = structlog.get_config()
         current_processors = list(config.get("processors", []))
 
-        # Insert the OTel processor before the last processor (typically the renderer)
-        # This ensures we capture the event before it's formatted
+        # Insert before the last processor, assumed to be the renderer.
         if current_processors:
             insert_position = len(current_processors) - 1
         else:
@@ -335,7 +349,7 @@ def _instrument(self, **kwargs):
 
     def _uninstrument(self, **kwargs):
         """
-        Remove the OpenTelemetryProcessor from structlog's processor chain.
+        Remove the StructlogHandler from structlog's processor chain.
         """
         if StructlogInstrumentor._processor is None:
             return
@@ -344,10 +358,10 @@ def _uninstrument(self, **kwargs):
         config = structlog.get_config()
         current_processors = list(config.get("processors", []))
 
-        # Remove all OpenTelemetryProcessor instances
+        # Remove all StructlogHandler instances
         new_processors = [
             p for p in current_processors
-            if not isinstance(p, OpenTelemetryProcessor)
+            if not isinstance(p, StructlogHandler)
         ]
 
         # Reconfigure structlog

instrumentation/opentelemetry-instrumentation-structlog/src/opentelemetry/instrumentation/structlog/package.py

@@ -13,4 +13,4 @@
 # limitations under the License.
 
 
-_instruments = ("structlog ~= 21.1",)
+_instruments = ("structlog >= 21.1",)

instrumentation/opentelemetry-instrumentation-structlog/src/opentelemetry/instrumentation/structlog/version.py

@@ -13,5 +13,3 @@
 # limitations under the License.
 
 __version__ = "0.59b0.dev"
-
-_instruments = ("structlog ~= 21.1",)

instrumentation/opentelemetry-instrumentation-structlog/tests/test_structlog.py

@@ -18,7 +18,7 @@
 
 from opentelemetry._logs import SeverityNumber
 from opentelemetry.instrumentation.structlog import (
-    OpenTelemetryProcessor,
+    StructlogHandler,
     StructlogInstrumentor,
 )
 from opentelemetry.sdk._logs import LoggerProvider
@@ -28,8 +28,8 @@
 from opentelemetry.trace import TraceFlags
 
 
-class TestOpenTelemetryProcessor(TestBase):
-    """Tests for the OpenTelemetryProcessor class."""
+class TestStructlogHandler(TestBase):
+    """Tests for the StructlogHandler class."""
 
     def setUp(self):
         super().setUp()
@@ -41,7 +41,7 @@ def setUp(self):
         )
 
         # Configure structlog with OTel processor
-        self.processor = OpenTelemetryProcessor(
+        self.processor = StructlogHandler(
             logger_provider=self.logger_provider
         )
         structlog.configure(
@@ -285,7 +285,7 @@ def test_flush(self):
 
         mock_provider = Mock()
         mock_provider.force_flush = Mock()
-        processor = OpenTelemetryProcessor(logger_provider=mock_provider)
+        processor = StructlogHandler(logger_provider=mock_provider)
 
         processor.flush()
 
@@ -340,9 +340,9 @@ def test_instrument_adds_processor(self):
         new_processors = structlog.get_config()["processors"]
         self.assertEqual(len(new_processors), initial_count + 1)
 
-        # Check that an OpenTelemetryProcessor is in the chain
+        # Check that a StructlogHandler is in the chain
         has_otel_processor = any(
-            isinstance(p, OpenTelemetryProcessor) for p in new_processors
+            isinstance(p, StructlogHandler) for p in new_processors
         )
         self.assertTrue(has_otel_processor)
 
@@ -361,7 +361,7 @@ def test_uninstrument_removes_processor(self):
         # Verify processor was added
         config_after_instrument = structlog.get_config()["processors"]
         has_otel = any(
-            isinstance(p, OpenTelemetryProcessor) for p in config_after_instrument
+            isinstance(p, StructlogHandler) for p in config_after_instrument
         )
         self.assertTrue(has_otel)
 
@@ -371,7 +371,7 @@ def test_uninstrument_removes_processor(self):
         # Verify processor was removed
         config_after_uninstrument = structlog.get_config()["processors"]
         has_otel = any(
-            isinstance(p, OpenTelemetryProcessor) for p in config_after_uninstrument
+            isinstance(p, StructlogHandler) for p in config_after_uninstrument
         )
         self.assertFalse(has_otel)
 
@@ -401,10 +401,7 @@ def test_custom_logger_provider(self):
         custom_provider = LoggerProvider()
         custom_exporter = InMemoryLogRecordExporter()
         custom_provider.add_log_record_processor(
-            LoggingHandler(
-                level=0,
-                logger_provider=custom_provider,
-            )
+            SimpleLogRecordProcessor(custom_exporter)
         )
 
         structlog.configure(