chore(logging): make log injection config a boolean

Author: mabdinur

ddtrace/_logger.py

@@ -20,6 +20,7 @@ class LogInjectionState(object):
     # Log injection is enabled, but not yet configured
     ENABLED = "true"
     # Log injection is enabled and configured for structured logging
+    # This value is deprecated, but kept for backwards compatibility
     STRUCTURED = "structured"
 
 
@@ -109,17 +110,15 @@ def set_log_formatting():
         handler.setFormatter(logging.Formatter(DD_LOG_FORMAT))
 
 
-def get_log_injection_state(raw_config: Optional[str]) -> str:
+def get_log_injection_state(raw_config: Optional[str]) -> bool:
     """Returns the current log injection state."""
     if raw_config:
         normalized = raw_config.lower().strip()
-        if normalized == LogInjectionState.STRUCTURED:
-            return LogInjectionState.STRUCTURED
-        elif normalized in ("true", "1"):
-            return LogInjectionState.ENABLED
+        if normalized == LogInjectionState.STRUCTURED or normalized in ("true", "1"):
+            return True
         elif normalized not in ("false", "0"):
             logging.warning(
                 "Invalid log injection state '%s'. Expected 'true', 'false', or 'structured'. Defaulting to 'false'.",
                 normalized,
             )
-    return LogInjectionState.DISABLED
+    return False

ddtrace/contrib/internal/logbook/patch.py

@@ -5,7 +5,6 @@
 
 import ddtrace
 from ddtrace import config
-from ddtrace._logger import LogInjectionState
 from ddtrace.contrib.internal.trace_utils import unwrap as _u
 from ddtrace.internal.utils import get_argument_value
 
@@ -27,7 +26,7 @@ def _supported_versions() -> Dict[str, str]:
 
 def _w_process_record(func, instance, args, kwargs):
     # patch logger to include datadog info before logging
-    if config._logs_injection != LogInjectionState.DISABLED:
+    if config._logs_injection:
         record = get_argument_value(args, kwargs, 0, "record")
         record.extra.update(ddtrace.tracer.get_log_correlation_context())
     return func(*args, **kwargs)

ddtrace/contrib/internal/logging/patch.py

@@ -5,7 +5,6 @@
 
 import ddtrace
 from ddtrace import config
-from ddtrace._logger import LogInjectionState
 from ddtrace._logger import set_log_formatting
 from ddtrace.contrib.internal.trace_utils import unwrap as _u
 from ddtrace.internal.constants import LOG_ATTR_ENV
@@ -54,15 +53,13 @@ def __init__(self, trace_id: int, span_id: int, service: str, version: str, env:
 def _w_makeRecord(func, instance, args, kwargs):
     # Get the LogRecord instance for this log
     record = func(*args, **kwargs)
-    if config._logs_injection == LogInjectionState.DISABLED:
-        # log injection is opt-in for non-structured logging
-        return record
-    record.__dict__.update(ddtrace.tracer.get_log_correlation_context())
+    if config._logs_injection:
+        record.__dict__.update(ddtrace.tracer.get_log_correlation_context())
     return record
 
 
 def _w_StrFormatStyle_format(func, instance, args, kwargs):
-    if config._logs_injection != LogInjectionState.ENABLED:
+    if not config._logs_injection:
         return func(*args, **kwargs)
     # The format string "dd.service={dd.service}" expects
     # the record to have a "dd" property which is an object that
@@ -103,7 +100,7 @@ def patch():
     _w(logging.Logger, "makeRecord", _w_makeRecord)
     _w(logging.StrFormatStyle, "_format", _w_StrFormatStyle_format)
 
-    if config._logs_injection == LogInjectionState.ENABLED:
+    if config._logs_injection:
         # Only set the formatter is DD_LOGS_INJECTION is set to True. We do not want to modify
         # unstructured logs if a user has not enabled logs injection.
         # Also, the Datadog log format must be set after the logging module has been patched,

ddtrace/contrib/internal/loguru/patch.py

@@ -5,7 +5,6 @@
 
 import ddtrace
 from ddtrace import config
-from ddtrace._logger import LogInjectionState
 from ddtrace.contrib.internal.trace_utils import unwrap as _u
 
 
@@ -25,12 +24,11 @@ def _supported_versions() -> Dict[str, str]:
 
 
 def _tracer_injection(event_dict):
-    if config._logs_injection == LogInjectionState.DISABLED:
+    if not config._logs_injection:
         # log injection is opt-out for structured logging
         return event_dict
     event_dd_attributes = ddtrace.tracer.get_log_correlation_context()
     event_dict.update(event_dd_attributes)
-
     return event_dd_attributes
 
 

ddtrace/contrib/internal/structlog/patch.py

@@ -4,7 +4,6 @@
 
 import ddtrace
 from ddtrace import config
-from ddtrace._logger import LogInjectionState
 from ddtrace.contrib.internal.trace_utils import unwrap as _u
 from ddtrace.contrib.internal.trace_utils import wrap as _w
 from ddtrace.internal.utils import get_argument_value
@@ -27,9 +26,8 @@ def _supported_versions() -> Dict[str, str]:
 
 
 def _tracer_injection(_, __, event_dict):
-    if config._logs_injection == LogInjectionState.DISABLED:
-        return event_dict
-    event_dict.update(ddtrace.tracer.get_log_correlation_context())
+    if config._logs_injection:
+        event_dict.update(ddtrace.tracer.get_log_correlation_context())
     return event_dict
 
 

ddtrace/settings/_config.py

@@ -17,7 +17,6 @@
 from ddtrace.internal.telemetry import validate_otel_envs
 from ddtrace.internal.utils.cache import cachedmethod
 
-from .._logger import LogInjectionState
 from .._logger import get_log_injection_state
 from ..internal import gitmetadata
 from ..internal.constants import _PROPAGATION_BEHAVIOR_DEFAULT
@@ -365,7 +364,7 @@ def _default_config() -> Dict[str, _ConfigItem]:
             modifier=str,
         ),
         "_logs_injection": _ConfigItem(
-            default=LogInjectionState.STRUCTURED,
+            default=True,
             envs=["DD_LOGS_INJECTION"],
             modifier=get_log_injection_state,
         ),

tests/contrib/logging/test_tracer_logging.py

@@ -5,7 +5,11 @@
 
 
 # example: '2022-06-10 21:49:26,010 CRITICAL [ddtrace] [test.py:15] - ddtrace critical log\n'
-LOG_PATTERN = r"^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2},\d{3} \w{1,} \[\S{1,}\] \[\w{1,}.\w{2}:\d{1,}\] - .{1,}$"
+# example: '2025-07-16 16:27:02,708 CRITICAL [ddtrace] [test.py:8] [dd.service=ddtrace_subprocess_dir
+#           dd.env= dd.version= dd.trace_id=0 dd.span_id=0] - ddtrace critical log\n'
+LOG_PATTERN = (
+    r"^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2},\d{3} \w{1,} \[\S{1,}\] \[\w{1,}\.\w{2}:\d{1,}\]( \[.*\])? - .{1,}$"
+)
 
 
 def assert_log_files(test_directory, test_log_file, total_file_count):
@@ -246,7 +250,7 @@ def test_warn_logs_can_go_to_file(run_python_code_in_subprocess, ddtrace_run_pyt
     ]:
         out, err, status, pid = run_in_subprocess(code, env=env)
         assert status == 0, err
-        assert err == b"warning log\n", err.decode()
+        assert b"warning log\n" in err, err.decode()
         assert out == b"", out.decode()
         with open(log_file) as file:
             first_line = file.readline()

tests/contrib/starlette/test_starlette.py

@@ -520,7 +520,7 @@ def test_incorrect_patching(run_python_code_in_subprocess):
     out, err, status, _ = run_python_code_in_subprocess(code)
     assert status == 0, err
     assert out == b"", err
-    assert err == b"datadog context not present in ASGI request scope, trace middleware may be missing\n"
+    assert b"datadog context not present in ASGI request scope, trace middleware may be missing\n" in err, err
 
 
 # Ignoring span link attributes until values are

tests/tracer/test_settings.py

@@ -2,7 +2,6 @@
 
 import pytest
 
-from ddtrace._logger import LogInjectionState
 from ddtrace.settings import HttpConfig
 from ddtrace.settings import IntegrationConfig
 from ddtrace.settings._config import Config
@@ -14,20 +13,24 @@ class TestConfig(BaseTestCase):
     def test_logs_injection(self):
         with self.override_env(dict(DD_LOGS_INJECTION="True")):
             config = Config()
-            self.assertEqual(config._logs_injection, LogInjectionState.ENABLED)
+            self.assertEqual(config._logs_injection, True)
 
         with self.override_env(dict(DD_LOGS_INJECTION="FALSE")):
             config = Config()
-            self.assertEqual(config._logs_injection, LogInjectionState.DISABLED)
+            self.assertEqual(config._logs_injection, False)
+
+        with self.override_env(dict(DD_LOGS_INJECTION="structured")):
+            config = Config()
+            self.assertEqual(config._logs_injection, False)
 
         with self.override_env(dict(), replace_os_env=True):
             config = Config()
-            self.assertEqual(config._logs_injection, LogInjectionState.STRUCTURED)
+            self.assertEqual(config._logs_injection, True)
 
         with self.override_env(dict(DD_LOGS_INJECTION="nonsense")):
             # If the value is not recognized, it should default to DISABLED
             config = Config()
-            self.assertEqual(config._logs_injection, LogInjectionState.DISABLED)
+            self.assertEqual(config._logs_injection, False)
 
     def test_service(self):
         # If none is provided the default should be ``None``