chore(telemetry): improve redaction of telemetry error logs

Author: dubloom

ddtrace/internal/telemetry/writer.py

@@ -17,6 +17,7 @@
 
 from ddtrace.internal.endpoints import endpoint_collection
 from ddtrace.internal.logger import get_logger
+from ddtrace.internal.packages import is_user_code
 from ddtrace.internal.utils.http import get_connection
 from ddtrace.settings._agent import config as agent_config
 from ddtrace.settings._telemetry import config
@@ -523,42 +524,49 @@ def add_log(self, level, message, stack_trace="", tags=None):
             # Logs are hashed using the message, level, tags, and stack_trace. This should prevent duplicatation.
             self._logs.add(data)
 
-    def add_integration_error_log(self, msg: str, exc: BaseException) -> None:
+    def add_error_log(self, msg: str, exc: BaseException) -> None:
         if config.LOG_COLLECTION_ENABLED:
             stack_trace = self._format_stack_trace(exc)
+
             self.add_log(
                 TELEMETRY_LOG_LEVEL.ERROR,
                 msg,
                 stack_trace=stack_trace if stack_trace is not None else "",
             )
 
     def _format_stack_trace(self, exc: BaseException) -> Optional[str]:
-        exc_type, exc_value, exc_traceback = type(exc), exc, exc.__traceback__
-        if exc_traceback:
-            tb = traceback.extract_tb(exc_traceback)
-            formatted_tb = ["Traceback (most recent call last):"]
-            for filename, lineno, funcname, srcline in tb:
-                if self._should_redact(filename):
-                    formatted_tb.append("  <REDACTED>")
-                    formatted_tb.append("    <REDACTED>")
-                else:
-                    relative_filename = self._format_file_path(filename)
-                    formatted_line = f'  File "{relative_filename}", line {lineno}, in {funcname}\n    {srcline}'
-                    formatted_tb.append(formatted_line)
-            if exc_type:
-                formatted_tb.append(f"{exc_type.__module__}.{exc_type.__name__}: {exc_value}")
-            return "\n".join(formatted_tb)
-
-        return None
-
-    def _should_redact(self, filename: str) -> bool:
-        return "ddtrace" not in filename
+        exc_type, _, exc_traceback = type(exc), exc, getattr(exc, "__traceback__", None)
+
+        if not exc_traceback:
+            return None
+
+        tb = traceback.extract_tb(exc_traceback)
+        formatted_tb = ["Traceback (most recent call last):"]
+        for filename, lineno, funcname, srcline in tb:
+            if is_user_code(filename):
+                formatted_tb.append("  <REDACTED>")
+                formatted_tb.append("    <REDACTED>")
+            else:
+                relative_filename = self._format_file_path(filename)
+                formatted_line = f'  File "{relative_filename}", line {lineno}, in {funcname}\n    {srcline}'
+                formatted_tb.append(formatted_line)
+        if exc_type:
+            formatted_tb.append(f"{exc_type.__module__}.{exc_type.__name__}: <REDACTED>")
+        return "\n".join(formatted_tb)
 
     def _format_file_path(self, filename: str) -> str:
         try:
-            return os.path.relpath(filename, start=self.CWD)
+            if "site-packages" in filename:
+                return filename.split("site-packages", 1)[1].lstrip("/")
+            elif "lib/python" in filename:
+                return (
+                    filename.split("lib/python", 1)[1].split("/", 1)[1]
+                    if "/" in filename.split("lib/python", 1)[1]
+                    else "python_stdlib"
+                )
+            return "<REDACTED>"
         except ValueError:
-            return filename
+            return "<REDACTED>"
 
     def add_gauge_metric(
         self, namespace: TELEMETRY_NAMESPACE, name: str, value: float, tags: Optional[MetricTagType] = None

tests/telemetry/test_writer.py

@@ -1089,12 +1089,14 @@ def test_otel_config_telemetry(test_agent_session, run_python_code_in_subprocess
     assert tags == [["config_opentelemetry:otel_logs_exporter"]]
 
 
-def test_add_integration_error_log(mock_time, telemetry_writer, test_agent_session):
+def test_add_error_log(mock_time, telemetry_writer, test_agent_session):
     """Test add_integration_error_log functionality with real stack trace"""
     try:
-        raise ValueError("Test exception")
-    except ValueError as e:
-        telemetry_writer.add_integration_error_log("Test error message", e)
+        import json
+
+        json.loads("{invalid: json,}")
+    except Exception as e:
+        telemetry_writer.add_error_log("Test error message", e)
         telemetry_writer.periodic(force_flush=True)
 
         log_events = test_agent_session.get_events("logs")
@@ -1110,9 +1112,14 @@ def test_add_integration_error_log(mock_time, telemetry_writer, test_agent_sessi
         stack_trace = log_entry["stack_trace"]
         expected_lines = [
             "Traceback (most recent call last):",
-            "  <REDACTED>",
-            "    <REDACTED>",
-            "builtins.ValueError: Test exception",
+            "<REDACTED>",  # User code gets redacted
+            '  File "json/__init__.py',
+            "    return _default_decoder.decode(s)",
+            '  File "json/decoder.py"',
+            "    obj, end = self.raw_decode(s, idx=_w(s, 0).end())",
+            '  File "json/decoder.py"',
+            "    obj, end = self.scan_once(s, idx)",
+            "json.decoder.JSONDecodeError: <REDACTED>",
         ]
         for expected_line in expected_lines:
             assert expected_line in stack_trace
@@ -1127,7 +1134,7 @@ def test_add_integration_error_log_with_log_collection_disabled(mock_time, telem
         try:
             raise ValueError("Test exception")
         except ValueError as e:
-            telemetry_writer.add_integration_error_log("Test error message", e)
+            telemetry_writer.add_error_log("Test error message", e)
             telemetry_writer.periodic(force_flush=True)
 
             log_events = test_agent_session.get_events("logs", subprocess=True)
@@ -1137,17 +1144,22 @@ def test_add_integration_error_log_with_log_collection_disabled(mock_time, telem
 
 
 @pytest.mark.parametrize(
-    "filename, is_redacted",
+    "filename, result",
     [
-        ("/path/to/file.py", True),
-        ("/path/to/ddtrace/contrib/flask/file.py", False),
-        ("/path/to/dd-trace-something/file.py", True),
+        ("/path/to/file.py", "<REDACTED>"),
+        ("/path/to/ddtrace/contrib/flask/file.py", "<REDACTED>"),
+        ("/path/to/lib/python3.13/site-packages/ddtrace/_trace/tracer.py", "ddtrace/_trace/tracer.py"),
+        ("/path/to/lib/python3.13/site-packages/requests/api.py", "requests/api.py"),
+        (
+            "/path/to/[email protected]/3.13.1/Frameworks/Python.framework/Versions/3.13/lib/python3.13/json/__init__.py",
+            "json/__init__.py",
+        ),
     ],
 )
-def test_redact_filename(filename, is_redacted):
+def test_redact_filename(filename, result):
     """Test file redaction logic"""
     writer = TelemetryWriter(is_periodic=False)
-    assert writer._should_redact(filename) == is_redacted
+    assert writer._format_file_path(filename) == result
 
 
 def test_telemetry_writer_multiple_sources_config(telemetry_writer, test_agent_session):