f-string magic (#151)

Author: alexmojaki

logfire/_internal/config.py

@@ -156,6 +156,7 @@ def configure(
     fast_shutdown: bool = False,
     scrubbing_patterns: Sequence[str] | None = None,
     scrubbing_callback: ScrubCallback | None = None,
+    inspect_arguments: bool | None = None,
 ) -> None:
     """Configure the logfire SDK.
 
@@ -210,6 +211,9 @@ def configure(
             If it returns `None`, the value is redacted.
             Otherwise, the returned value replaces the matched value.
             The function accepts a single argument of type [`logfire.ScrubMatch`][logfire.ScrubMatch].
+        inspect_arguments: Whether to enable f-string magic.
+            If `None` uses the `LOGFIRE_INSPECT_ARGUMENTS` environment variable.
+            Defaults to `True` if and only if the Python version is at least 3.11.
     """
     GLOBAL_CONFIG.configure(
         base_url=base_url,
@@ -234,6 +238,7 @@ def configure(
         fast_shutdown=fast_shutdown,
         scrubbing_patterns=scrubbing_patterns,
         scrubbing_callback=scrubbing_callback,
+        inspect_arguments=inspect_arguments,
     )
 
 
@@ -337,9 +342,10 @@ def _load_configuration(
         metric_readers: Sequence[MetricReader] | None,
         logfire_api_session: requests.Session | None,
         pydantic_plugin: PydanticPlugin | None,
-        fast_shutdown: bool = False,
-        scrubbing_patterns: Sequence[str] | None = None,
-        scrubbing_callback: ScrubCallback | None = None,
+        fast_shutdown: bool,
+        scrubbing_patterns: Sequence[str] | None,
+        scrubbing_callback: ScrubCallback | None,
+        inspect_arguments: bool | None,
     ) -> None:
         """Merge the given parameters with the environment variables file configurations."""
         param_manager = ParamManager.create(config_dir)
@@ -357,6 +363,11 @@ def _load_configuration(
         self.show_summary = param_manager.load_param('show_summary', show_summary)
         self.data_dir = param_manager.load_param('data_dir', data_dir)
         self.collect_system_metrics = param_manager.load_param('collect_system_metrics', collect_system_metrics)
+        self.inspect_arguments = param_manager.load_param('inspect_arguments', inspect_arguments)
+        if self.inspect_arguments and sys.version_info[:2] <= (3, 8):
+            raise LogfireConfigError(
+                'Inspecting arguments is only supported in Python 3.9+ and only recommended in Python 3.11+.'
+            )
 
         # We save `scrubbing_patterns` and `scrubbing_callback` just so that they can be serialized and deserialized.
         self.scrubbing_patterns = scrubbing_patterns
@@ -425,6 +436,7 @@ def __init__(
         fast_shutdown: bool = False,
         scrubbing_patterns: Sequence[str] | None = None,
         scrubbing_callback: ScrubCallback | None = None,
+        inspect_arguments: bool | None = None,
     ) -> None:
         """Create a new LogfireConfig.
 
@@ -457,6 +469,7 @@ def __init__(
             fast_shutdown=fast_shutdown,
             scrubbing_patterns=scrubbing_patterns,
             scrubbing_callback=scrubbing_callback,
+            inspect_arguments=inspect_arguments,
         )
         # initialize with no-ops so that we don't impact OTEL's global config just because logfire is installed
         # that is, we defer setting logfire as the otel global config until `configure` is called
@@ -490,9 +503,10 @@ def configure(
         metric_readers: Sequence[MetricReader] | None,
         logfire_api_session: requests.Session | None,
         pydantic_plugin: PydanticPlugin | None,
-        fast_shutdown: bool = False,
-        scrubbing_patterns: Sequence[str] | None = None,
-        scrubbing_callback: ScrubCallback | None = None,
+        fast_shutdown: bool,
+        scrubbing_patterns: Sequence[str] | None,
+        scrubbing_callback: ScrubCallback | None,
+        inspect_arguments: bool | None,
     ) -> None:
         with self._lock:
             self._initialized = False
@@ -519,6 +533,7 @@ def configure(
                 fast_shutdown,
                 scrubbing_patterns,
                 scrubbing_callback,
+                inspect_arguments,
             )
             self.initialize()
 

logfire/_internal/config_params.py

@@ -104,6 +104,8 @@ class _DefaultCallback:
 """Set of items that should be excluded from Logfire Pydantic plugin instrumentation."""
 TRACE_SAMPLE_RATE = ConfigParam(env_vars=['LOGFIRE_TRACE_SAMPLE_RATE', 'OTEL_TRACES_SAMPLER_ARG'], allow_file_config=True, default=1.0, tp=float)
 """Default sampling ratio for traces. Can be overridden by the `logfire.sample_rate` attribute of a span."""
+INSPECT_ARGUMENTS = ConfigParam(env_vars=['LOGFIRE_INSPECT_ARGUMENTS'], allow_file_config=True, default=sys.version_info[:2] >= (3, 11), tp=bool)
+"""Whether to enable the f-string magic feature. On by default for Python 3.11 and above."""
 # fmt: on
 
 CONFIG_PARAMS = {
@@ -126,6 +128,7 @@ class _DefaultCallback:
     'pydantic_plugin_record': PYDANTIC_PLUGIN_RECORD,
     'pydantic_plugin_include': PYDANTIC_PLUGIN_INCLUDE,
     'pydantic_plugin_exclude': PYDANTIC_PLUGIN_EXCLUDE,
+    'inspect_arguments': INSPECT_ARGUMENTS,
 }