Allow to set instrument_httpx(capture_all=True) via env var (#1295)

Co-authored-by: Alex Hall <[email protected]>

Author: Kludex

logfire/_internal/config_params.py

@@ -104,6 +104,10 @@ class _DefaultCallback:
 """The base URL of the Logfire backend. Primarily for testing purposes."""
 DISTRIBUTED_TRACING = ConfigParam(env_vars=['LOGFIRE_DISTRIBUTED_TRACING'], allow_file_config=True, default=None, tp=bool)
 """Whether to extract incoming trace context. By default, will extract but warn about it."""
+
+# Instrumentation packages parameters
+HTTPX_CAPTURE_ALL = ConfigParam(env_vars=['LOGFIRE_HTTPX_CAPTURE_ALL'], allow_file_config=True, default=False, tp=bool)
+"""Whether to capture all HTTP headers, request and response bodies when using `logfire.instrument_httpx()`"""
 # fmt: on
 
 CONFIG_PARAMS = {
@@ -130,6 +134,8 @@ class _DefaultCallback:
     'inspect_arguments': INSPECT_ARGUMENTS,
     'ignore_no_config': IGNORE_NO_CONFIG,
     'distributed_tracing': DISTRIBUTED_TRACING,
+    # Instrumentation packages parameters
+    'httpx_capture_all': HTTPX_CAPTURE_ALL,
 }
 
 

logfire/_internal/integrations/httpx.py

@@ -12,6 +12,7 @@
 import httpx
 from opentelemetry.trace import NonRecordingSpan, Span, use_span
 
+from logfire._internal.config import GLOBAL_CONFIG
 from logfire._internal.stack_info import warn_at_user_stacklevel
 
 try:
@@ -45,7 +46,7 @@
 def instrument_httpx(
     logfire_instance: Logfire,
     client: httpx.Client | httpx.AsyncClient | None,
-    capture_all: bool,
+    capture_all: bool | None,
     capture_headers: bool,
     capture_request_body: bool,
     capture_response_body: bool,
@@ -76,6 +77,8 @@ def instrument_httpx(
             'The `capture_response_headers` parameter is deprecated. Use `capture_headers` instead.', DeprecationWarning
         )
 
+    capture_all = cast(bool, GLOBAL_CONFIG.param_manager.load_param('httpx_capture_all', capture_all))
+
     should_capture_request_headers = capture_request_headers or capture_headers or capture_all
     should_capture_response_headers = capture_response_headers or capture_headers or capture_all
     should_capture_request_body = capture_request_body or capture_all

logfire/_internal/main.py

@@ -1353,7 +1353,7 @@ def instrument_httpx(
         self,
         client: httpx.Client | httpx.AsyncClient | None = None,
         *,
-        capture_all: bool = False,
+        capture_all: bool | None = None,
         capture_headers: bool = False,
         capture_request_body: bool = False,
         capture_response_body: bool = False,
@@ -1375,6 +1375,7 @@ def instrument_httpx(
             client: The `httpx.Client` or `httpx.AsyncClient` instance to instrument.
                 If `None`, the default, all clients will be instrumented.
             capture_all: Set to `True` to capture all HTTP headers, request and response bodies.
+                By default checks the environment variable `LOGFIRE_HTTPX_CAPTURE_ALL`.
             capture_headers: Set to `True` to capture all HTTP headers.
 
                 If you don't want to capture all headers, you can customize the headers captured. See the

tests/otel_integrations/test_httpx.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import importlib
+import os
 from contextlib import contextmanager
 from typing import Any
 from unittest import mock
@@ -842,6 +843,74 @@ async def test_httpx_client_capture_all(exporter: TestExporter):
     )
 
 
+async def test_httpx_client_capture_all_environment_variable(exporter: TestExporter):
+    with mock.patch.dict(os.environ, {'LOGFIRE_HTTPX_CAPTURE_ALL': 'true'}):
+        with httpx.Client(transport=create_transport()) as client:
+            logfire.instrument_httpx(client)
+            response = client.get('https://example.org:8080/foo')
+            assert response.json() == {'good': 'response'}
+            assert await response.aread() == b'{"good": "response"}'
+
+    assert without_metrics(exporter.exported_spans_as_dict()) == snapshot(
+        [
+            {
+                'name': 'GET',
+                'context': {'trace_id': 1, 'span_id': 1, 'is_remote': False},
+                'parent': None,
+                'start_time': 1000000000,
+                'end_time': 2000000000,
+                'attributes': {
+                    'http.method': 'GET',
+                    'http.request.method': 'GET',
+                    'http.url': 'https://example.org:8080/foo',
+                    'url.full': 'https://example.org:8080/foo',
+                    'http.host': 'example.org',
+                    'server.address': 'example.org',
+                    'network.peer.address': 'example.org',
+                    'net.peer.port': 8080,
+                    'server.port': 8080,
+                    'network.peer.port': 8080,
+                    'logfire.span_type': 'span',
+                    'logfire.msg': 'GET example.org/foo',
+                    'http.request.header.host': ('example.org:8080',),
+                    'http.request.header.accept': ('*/*',),
+                    'http.request.header.accept-encoding': ('gzip, deflate, zstd',),
+                    'http.request.header.connection': ('keep-alive',),
+                    'http.request.header.user-agent': ('python-httpx/0.28.1',),
+                    'http.status_code': 200,
+                    'http.response.status_code': 200,
+                    'http.flavor': '1.1',
+                    'network.protocol.version': '1.1',
+                    'http.response.header.host': ('example.org:8080',),
+                    'http.response.header.accept': ('*/*',),
+                    'http.response.header.accept-encoding': ('gzip, deflate, zstd',),
+                    'http.response.header.connection': ('keep-alive',),
+                    'http.response.header.user-agent': ('python-httpx/0.28.1',),
+                    'http.response.header.traceparent': ('00-00000000000000000000000000000001-0000000000000001-01',),
+                    'http.target': '/foo',
+                },
+            },
+            {
+                'name': 'Reading response body',
+                'context': {'trace_id': 1, 'span_id': 3, 'is_remote': False},
+                'parent': {'trace_id': 1, 'span_id': 1, 'is_remote': False},
+                'start_time': 3000000000,
+                'end_time': 4000000000,
+                'attributes': {
+                    'code.filepath': 'test_httpx.py',
+                    'code.function': 'test_httpx_client_capture_all_environment_variable',
+                    'code.lineno': 123,
+                    'logfire.msg_template': 'Reading response body',
+                    'logfire.msg': 'Reading response body',
+                    'logfire.span_type': 'span',
+                    'http.response.body.text': '{"good": "response"}',
+                    'logfire.json_schema': '{"type":"object","properties":{"http.response.body.text":{"type":"object"}}}',
+                },
+            },
+        ]
+    )
+
+
 async def test_httpx_client_no_capture_empty_body(exporter: TestExporter):
     async with httpx.AsyncClient(transport=create_transport()) as client:
         logfire.instrument_httpx(client, capture_request_body=True)