Release v4.17.0 (#1603)

Author: alexmojaki

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release Notes
 
+## [v4.17.0] (2026-01-07)
+
+* `logfire.instrument_surrealdb` by @alexmojaki in [#1573](https://github.com/pydantic/logfire/pull/1573)
+* feat(config): allow custom Views in MetricOptions by @cyberksh in [#1552](https://github.com/pydantic/logfire/pull/1552)
+* Handle unpicklable configuration in `ProcessPoolExecutor` patch #1556 by @pipinstalled in [#1567](https://github.com/pydantic/logfire/pull/1567)
+* Maintain original LLM request context when logging the streaming response by @yiphei in [#1566](https://github.com/pydantic/logfire/pull/1566)
+* Add note about `write_token` permission in `logfire projects` commands by @Viicos in [#1545](https://github.com/pydantic/logfire/pull/1545)
+
 ## [v4.16.0] (2025-12-04)
 
 * Support OpenTelemetry 1.39.0, drop support for earlier versions, stop using the OTel events API/SDK by @alexmojaki in [#1562](https://github.com/pydantic/logfire/pull/1562)
@@ -985,3 +993,4 @@ First release from new repo!
 [v4.15.0]: https://github.com/pydantic/logfire/compare/v4.14.2...v4.15.0
 [v4.15.1]: https://github.com/pydantic/logfire/compare/v4.15.0...v4.15.1
 [v4.16.0]: https://github.com/pydantic/logfire/compare/v4.15.1...v4.16.0
+[v4.17.0]: https://github.com/pydantic/logfire/compare/v4.16.0...v4.17.0

logfire-api/logfire_api/__init__.pyi

@@ -15,7 +15,7 @@ from logfire.propagate import attach_context as attach_context, get_context as g
 from logfire.sampling import SamplingOptions as SamplingOptions
 from typing import Any
 
-__all__ = ['Logfire', 'LogfireSpan', 'LevelName', 'AdvancedOptions', 'ConsoleOptions', 'CodeSource', 'PydanticPlugin', 'configure', 'span', 'instrument', 'log', 'trace', 'debug', 'notice', 'info', 'warn', 'warning', 'error', 'exception', 'fatal', 'force_flush', 'log_slow_async_callbacks', 'install_auto_tracing', 'instrument_asgi', 'instrument_wsgi', 'instrument_pydantic', 'instrument_pydantic_ai', 'instrument_fastapi', 'instrument_openai', 'instrument_openai_agents', 'instrument_anthropic', 'instrument_google_genai', 'instrument_litellm', 'instrument_print', 'instrument_asyncpg', 'instrument_httpx', 'instrument_celery', 'instrument_requests', 'instrument_psycopg', 'instrument_django', 'instrument_flask', 'instrument_starlette', 'instrument_aiohttp_client', 'instrument_aiohttp_server', 'instrument_sqlalchemy', 'instrument_sqlite3', 'instrument_aws_lambda', 'instrument_redis', 'instrument_pymongo', 'instrument_mysql', 'instrument_system_metrics', 'instrument_mcp', 'AutoTraceModule', 'with_tags', 'with_settings', 'suppress_scopes', 'shutdown', 'no_auto_trace', 'ScrubMatch', 'ScrubbingOptions', 'VERSION', 'add_non_user_code_prefix', 'suppress_instrumentation', 'StructlogProcessor', 'LogfireLoggingHandler', 'loguru_handler', 'SamplingOptions', 'MetricsOptions', 'logfire_info', 'get_baggage', 'set_baggage', 'get_context', 'attach_context']
+__all__ = ['Logfire', 'LogfireSpan', 'LevelName', 'AdvancedOptions', 'ConsoleOptions', 'CodeSource', 'PydanticPlugin', 'configure', 'span', 'instrument', 'log', 'trace', 'debug', 'notice', 'info', 'warn', 'warning', 'error', 'exception', 'fatal', 'force_flush', 'log_slow_async_callbacks', 'install_auto_tracing', 'instrument_asgi', 'instrument_wsgi', 'instrument_pydantic', 'instrument_pydantic_ai', 'instrument_fastapi', 'instrument_openai', 'instrument_openai_agents', 'instrument_anthropic', 'instrument_google_genai', 'instrument_litellm', 'instrument_print', 'instrument_asyncpg', 'instrument_httpx', 'instrument_celery', 'instrument_requests', 'instrument_psycopg', 'instrument_django', 'instrument_flask', 'instrument_starlette', 'instrument_aiohttp_client', 'instrument_aiohttp_server', 'instrument_sqlalchemy', 'instrument_sqlite3', 'instrument_aws_lambda', 'instrument_redis', 'instrument_pymongo', 'instrument_mysql', 'instrument_surrealdb', 'instrument_system_metrics', 'instrument_mcp', 'AutoTraceModule', 'with_tags', 'with_settings', 'suppress_scopes', 'shutdown', 'no_auto_trace', 'ScrubMatch', 'ScrubbingOptions', 'VERSION', 'add_non_user_code_prefix', 'suppress_instrumentation', 'StructlogProcessor', 'LogfireLoggingHandler', 'loguru_handler', 'SamplingOptions', 'MetricsOptions', 'logfire_info', 'get_baggage', 'set_baggage', 'get_context', 'attach_context']
 
 DEFAULT_LOGFIRE_INSTANCE = Logfire()
 span = DEFAULT_LOGFIRE_INSTANCE.span
@@ -50,6 +50,7 @@ instrument_aws_lambda = DEFAULT_LOGFIRE_INSTANCE.instrument_aws_lambda
 instrument_redis = DEFAULT_LOGFIRE_INSTANCE.instrument_redis
 instrument_pymongo = DEFAULT_LOGFIRE_INSTANCE.instrument_pymongo
 instrument_mysql = DEFAULT_LOGFIRE_INSTANCE.instrument_mysql
+instrument_surrealdb = DEFAULT_LOGFIRE_INSTANCE.instrument_surrealdb
 instrument_system_metrics = DEFAULT_LOGFIRE_INSTANCE.instrument_system_metrics
 instrument_mcp = DEFAULT_LOGFIRE_INSTANCE.instrument_mcp
 suppress_scopes = DEFAULT_LOGFIRE_INSTANCE.suppress_scopes

logfire-api/logfire_api/_internal/config.pyi

@@ -32,10 +32,11 @@ from logfire.sampling._tail_sampling import TailSamplingProcessor as TailSamplin
 from logfire.version import VERSION as VERSION
 from opentelemetry.sdk._logs import LogRecordProcessor as LogRecordProcessor
 from opentelemetry.sdk.metrics.export import MetricReader as MetricReader
+from opentelemetry.sdk.metrics.view import View
 from opentelemetry.sdk.trace import SpanProcessor
 from opentelemetry.sdk.trace.id_generator import IdGenerator
 from pathlib import Path
-from typing import Any, Callable, Literal, TextIO, TypedDict
+from typing import Any, Callable, ClassVar, Literal, TextIO, TypedDict
 from typing_extensions import Self, Unpack
 
 CREDENTIALS_FILENAME: str
@@ -78,8 +79,10 @@ class PydanticPlugin:
 @dataclass
 class MetricsOptions:
     """Configuration of metrics."""
+    DEFAULT_VIEWS: ClassVar[Sequence[View]] = ...
     additional_readers: Sequence[MetricReader] = ...
     collect_in_spans: bool = ...
+    views: Sequence[View] = field(default_factory=Incomplete)
 
 @dataclass
 class CodeSource:

logfire-api/logfire_api/_internal/integrations/executors.pyi

@@ -1,3 +1,4 @@
+from ..stack_info import warn_at_user_stacklevel as warn_at_user_stacklevel
 from _typeshed import Incomplete
 from concurrent.futures import ProcessPoolExecutor, ThreadPoolExecutor
 from logfire.propagate import ContextCarrier as ContextCarrier, attach_context as attach_context, get_context as get_context
@@ -14,5 +15,11 @@ def submit_t(s: ThreadPoolExecutor, fn: Callable[..., Any], /, *args: Any, **kwa
     """A wrapper around ThreadPoolExecutor.submit() that carries over OTEL context across threads."""
 def submit_p(s: ProcessPoolExecutor, fn: Callable[..., Any], /, *args: Any, **kwargs: Any):
     """A wrapper around ProcessPoolExecutor.submit() that carries over OTEL context across processes."""
-def serialize_config() -> dict[str, Any]: ...
-def deserialize_config(config: dict[str, Any]) -> None: ...
+def serialize_config() -> dict[str, Any] | None:
+    """Serialize the global config for transmission to child processes.
+
+    Returns None if the config cannot be pickled, in which case a warning is emitted.
+    See: https://github.com/pydantic/logfire/issues/1556
+    """
+def deserialize_config(config: dict[str, Any] | None) -> None:
+    """Deserialize a config dict and apply it to the global config."""

logfire-api/logfire_api/_internal/integrations/openai_agents.pyi

@@ -64,6 +64,8 @@ class LogfireTraceWrapper(LogfireWrapperBase[Trace], Trace):
     def trace_id(self) -> str: ...
     @property
     def name(self) -> str: ...
+    @property
+    def tracing_api_key(self) -> str | None: ...
     def export(self) -> dict[str, Any] | None: ...
 
 @dataclass
@@ -89,6 +91,8 @@ class LogfireSpanWrapper(LogfireWrapperBase[Span[TSpanData]], Span[TSpanData]):
     def started_at(self) -> str | None: ...
     @property
     def ended_at(self) -> str | None: ...
+    @property
+    def tracing_api_key(self) -> str | None: ...
 
 def attributes_from_span_data(span_data: SpanData, msg_template: str) -> dict[str, Any]: ...
 def get_basic_response_attributes(response: Response): ...

logfire-api/logfire_api/_internal/integrations/surrealdb.pyi

@@ -0,0 +1,11 @@
+from logfire._internal.main import Logfire as Logfire
+from logfire._internal.scrubbing import BaseScrubber as BaseScrubber
+from logfire._internal.utils import handle_internal_errors as handle_internal_errors
+from surrealdb.connections.async_template import AsyncTemplate
+from surrealdb.connections.sync_template import SyncTemplate
+from typing import Any
+
+def get_all_surrealdb_classes() -> set[type]: ...
+def instrument_surrealdb(obj: SyncTemplate | AsyncTemplate | type[SyncTemplate] | type[AsyncTemplate] | None, logfire_instance: Logfire): ...
+@handle_internal_errors
+def patch_method(obj: Any, method_name: str, logfire_instance: Logfire): ...

logfire-api/logfire_api/_internal/main.pyi

@@ -49,6 +49,8 @@ from sqlalchemy.ext.asyncio import AsyncEngine
 from starlette.applications import Starlette
 from starlette.requests import Request as Request
 from starlette.websockets import WebSocket as WebSocket
+from surrealdb.connections.async_template import AsyncTemplate
+from surrealdb.connections.sync_template import SyncTemplate
 from types import ModuleType
 from typing import Any, Callable, Literal, TypeVar, overload
 from typing_extensions import LiteralString, ParamSpec, Unpack
@@ -403,6 +405,14 @@ class Logfire:
                 modules in `sys.modules` (i.e. modules that have already been imported) match the modules to trace.
                 Set to `'warn'` to issue a warning instead, or `'ignore'` to skip the check.
         """
+    def instrument_surrealdb(self, obj: SyncTemplate | AsyncTemplate | type[SyncTemplate] | type[AsyncTemplate] | None = None) -> None:
+        """Instrument [SurrealDB](https://surrealdb.com/) connections, creating a span for each method.
+
+        Args:
+            obj: Pass a single connection instance to instrument only that connection.
+                Pass a connection class to instrument all instances of that class.
+                By default, all connection classes are instrumented.
+        """
     def instrument_mcp(self, *, propagate_otel_context: bool = True) -> None:
         """Instrument the [MCP Python SDK](https://github.com/modelcontextprotocol/python-sdk).
 

logfire-api/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "logfire-api"
-version = "4.16.0"
+version = "4.17.0"
 description = "Shim for the Logfire SDK which does nothing unless Logfire is installed"
 authors = [
     { name = "Pydantic Team", email = "[email protected]" },

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "logfire"
-version = "4.16.0"
+version = "4.17.0"
 description = "The best Python observability tool! 🪵🔥"
 requires-python = ">=3.9"
 authors = [