Release v0.47.0 (#326)

Author: alexmojaki

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release Notes
 
+## [v0.47.0] (2024-07-20)
+
+* Fix recursive logging from OTEL's `BatchSpanProcessor` by @alexmojaki in https://github.com/pydantic/logfire/pull/306
+* Set sqlalchemy 'connect' spans to debug level by @alexmojaki in https://github.com/pydantic/logfire/pull/307
+* Add type hints to instrument methods by @Kludex in https://github.com/pydantic/logfire/pull/320
+* Handle older versions of anthropic by @alexmojaki in https://github.com/pydantic/logfire/pull/316
+* Update dependencies, handle change in importlib by @alexmojaki in https://github.com/pydantic/logfire/pull/323
+* Summarize db.statement in message by @alexmojaki in https://github.com/pydantic/logfire/pull/308
+* Handle and test other OpenAI/Anthropic  client methods by @alexmojaki in https://github.com/pydantic/logfire/pull/312
+
 ## [v0.46.1] (2024-07-05)
 
 * Fix release process for `logfire-api` by @Kludex in https://github.com/pydantic/logfire/pull/303
@@ -204,6 +214,7 @@ First release from new repo!
 * Ensure `logfire.testing` doesn't depend on pydantic and eval_type_backport by @alexmojaki in https://github.com/pydantic/logfire/pull/40
 * Allow using pydantic plugin with models defined before calling logfire.configure by @alexmojaki in https://github.com/pydantic/logfire/pull/36
 
+[v0.47.0]: https://github.com/pydantic/logfire/compare/v0.46.1...v0.47.0
 [v0.46.1]: https://github.com/pydantic/logfire/compare/v0.46.0...v0.46.1
 [v0.46.0]: https://github.com/pydantic/logfire/compare/v0.45.1...v0.46.0
 [v0.45.1]: https://github.com/pydantic/logfire/compare/v0.45.0...v0.45.1

logfire-api/logfire_api/_internal/db_statement_summary.pyi

@@ -0,0 +1,32 @@
+from _typeshed import Incomplete
+from typing import Any, Mapping
+
+MAX_QUERY_MESSAGE_LENGTH: int
+
+def message_from_db_statement(attributes: Mapping[str, Any], message: str | None, span_name: str) -> str | None:
+    """Try to construct a useful span message from OTel db statement.
+
+    Returns: A new string to use as span message or None to keep the original message.
+    """
+
+TABLE_RE: str
+SELECT_RE: Incomplete
+SELECT_CTE_RE: Incomplete
+SELECT_SUBQUERY_RE: Incomplete
+INSERT_RE: Incomplete
+
+def summarize_query(db_statement: str) -> str | None:
+    """Summarize a database statement, specifically SQL queries.
+
+    Args:
+        db_statement: The database statement to summarize.
+
+    Returns: A new string to use as span message or None to keep the original message.
+
+    """
+def select(expr: str, table: str, *, match_end: int, db_statement: str, ctes: str | None = None, sub_query: str | None = None) -> str: ...
+def truncate(s: str, length: int) -> str: ...
+
+FALLBACK_HALF: Incomplete
+
+def fallback(db_statement: str): ...

logfire-api/logfire_api/_internal/exporters/processor_wrapper.pyi

@@ -1,4 +1,5 @@
 from ..constants import ATTRIBUTES_LOG_LEVEL_NUM_KEY as ATTRIBUTES_LOG_LEVEL_NUM_KEY, ATTRIBUTES_MESSAGE_KEY as ATTRIBUTES_MESSAGE_KEY, ATTRIBUTES_MESSAGE_TEMPLATE_KEY as ATTRIBUTES_MESSAGE_TEMPLATE_KEY, ATTRIBUTES_SPAN_TYPE_KEY as ATTRIBUTES_SPAN_TYPE_KEY, LEVEL_NUMBERS as LEVEL_NUMBERS, PENDING_SPAN_NAME_SUFFIX as PENDING_SPAN_NAME_SUFFIX, log_level_attributes as log_level_attributes
+from ..db_statement_summary import message_from_db_statement as message_from_db_statement
 from ..scrubbing import BaseScrubber as BaseScrubber
 from ..utils import ReadableSpanDict as ReadableSpanDict, is_instrumentation_suppressed as is_instrumentation_suppressed, span_to_dict as span_to_dict, truncate_string as truncate_string
 from .wrapper import WrapperSpanProcessor as WrapperSpanProcessor

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

@@ -1,7 +1,22 @@
 from flask.app import Flask
-from typing import Any
+from opentelemetry.trace import Span
+from typing_extensions import Protocol, TypedDict, Unpack
+from wsgiref.types import WSGIEnvironment
 
-def instrument_flask(app: Flask, **kwargs: Any):
+class RequestHook(Protocol):
+    def __call__(self, span: Span, environment: WSGIEnvironment) -> None: ...
+
+class ResponseHook(Protocol):
+    def __call__(self, span: Span, status: str, response_headers: list[tuple[str, str]]) -> None: ...
+
+class FlaskInstrumentKwargs(TypedDict, total=False):
+    request_hook: RequestHook | None
+    response_hook: RequestHook | None
+    excluded_urls: str | None
+    enable_commenter: bool | None
+    commenter_options: dict[str, str] | None
+
+def instrument_flask(app: Flask, **kwargs: Unpack[FlaskInstrumentKwargs]):
     """Instrument `app` so that spans are automatically created for each request.
 
     See the `Logfire.instrument_flask` method for details.

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

@@ -1,12 +1,25 @@
 from _typeshed import Incomplete
+from opentelemetry.instrumentation.psycopg import PsycopgInstrumentor
+from opentelemetry.instrumentation.psycopg2 import Psycopg2Instrumentor
 from typing import Any
+from typing_extensions import TypedDict, Unpack
+
+Instrumentor = PsycopgInstrumentor | Psycopg2Instrumentor
+
+class CommenterOptions(TypedDict, total=False):
+    db_driver: bool
+    db_framework: bool
+    opentelemetry_values: bool
+
+class PsycopgInstrumentKwargs(TypedDict, total=False):
+    enable_commenter: bool
+    commenter_options: CommenterOptions
 
-Instrumentor: Incomplete
 PACKAGE_NAMES: Incomplete
 
-def instrument_psycopg(conn_or_module: Any = None, **kwargs: Any):
+def instrument_psycopg(conn_or_module: Any = None, **kwargs: Unpack[PsycopgInstrumentKwargs]) -> None:
     """Instrument a `psycopg` connection or module so that spans are automatically created for each query.
 
     See the `Logfire.instrument_psycopg` method for details.
     """
-def check_version(name: str, version: str, instrumentor: Instrumentor): ...
+def check_version(name: str, version: str, instrumentor: Instrumentor) -> bool: ...

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

@@ -1,6 +1,24 @@
+from pymongo.monitoring import CommandFailedEvent, CommandStartedEvent, CommandSucceededEvent
 from typing import Any
+from typing_extensions import Protocol, TypedDict, Unpack
 
-def instrument_pymongo(**kwargs: Any):
+class RequestHook(Protocol):
+    def __call__(self, span: Any, event: CommandStartedEvent) -> None: ...
+
+class ResponseHook(Protocol):
+    def __call__(self, span: Any, event: CommandSucceededEvent) -> None: ...
+
+class FailedHook(Protocol):
+    def __call__(self, span: Any, event: CommandFailedEvent) -> None: ...
+
+class PymongoInstrumentKwargs(TypedDict, total=False):
+    request_hook: RequestHook | None
+    response_hook: ResponseHook | None
+    failed_hook: FailedHook | None
+    capture_statement: bool | None
+    skip_dep_check: bool
+
+def instrument_pymongo(**kwargs: Unpack[PymongoInstrumentKwargs]) -> None:
     """Instrument the `pymongo` module so that spans are automatically created for each operation.
 
     See the `Logfire.instrument_pymongo` method for details.

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

@@ -1,6 +1,20 @@
+from opentelemetry.trace import Span
+from redis import Connection
 from typing import Any
+from typing_extensions import Protocol, TypedDict, Unpack
 
-def instrument_redis(**kwargs: Any):
+class RequestHook(Protocol):
+    def __call__(self, span: Span, instance: Connection, *args: Any, **kwargs: Any) -> None: ...
+
+class ResponseHook(Protocol):
+    def __call__(self, span: Span, instance: Connection, response: Any) -> None: ...
+
+class RedisInstrumentKwargs(TypedDict, total=False):
+    request_hook: RequestHook | None
+    response_hook: ResponseHook | None
+    skip_dep_check: bool
+
+def instrument_redis(**kwargs: Unpack[RedisInstrumentKwargs]) -> None:
     """Instrument the `redis` module so that spans are automatically created for each operation.
 
     See the `Logfire.instrument_redis` method for details.

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

@@ -1,6 +1,18 @@
-from typing import Any
+from sqlalchemy import Engine
+from typing_extensions import TypedDict, Unpack
 
-def instrument_sqlalchemy(**kwargs: Any):
+class CommenterOptions(TypedDict, total=False):
+    db_driver: bool
+    db_framework: bool
+    opentelemetry_values: bool
+
+class SQLAlchemyInstrumentKwargs(TypedDict, total=False):
+    engine: Engine | None
+    enable_commenter: bool | None
+    commenter_options: CommenterOptions | None
+    skip_dep_check: bool
+
+def instrument_sqlalchemy(**kwargs: Unpack[SQLAlchemyInstrumentKwargs]) -> None:
     """Instrument the `sqlalchemy` module so that spans are automatically created for each query.
 
     See the `Logfire.instrument_sqlalchemy` method for details.

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

@@ -1,7 +1,23 @@
+from opentelemetry.trace import Span
 from starlette.applications import Starlette
 from typing import Any
+from typing_extensions import Protocol, TypedDict, Unpack
 
-def instrument_starlette(app: Starlette, **kwargs: Any):
+class ServerRequestHook(Protocol):
+    def __call__(self, span: Span, scope: dict[str, Any]): ...
+
+class ClientRequestHook(Protocol):
+    def __call__(self, span: Span, scope: dict[str, Any]): ...
+
+class ClientResponseHook(Protocol):
+    def __call__(self, span: Span, message: dict[str, Any]): ...
+
+class StarletteInstrumentKwargs(TypedDict, total=False):
+    server_request_hook: ServerRequestHook | None
+    client_request_hook: ClientRequestHook | None
+    client_response_hook: ClientResponseHook | None
+
+def instrument_starlette(app: Starlette, **kwargs: Unpack[StarletteInstrumentKwargs]):
     """Instrument `app` so that spans are automatically created for each request.
 
     See the `Logfire.instrument_starlette` method for details.

logfire-api/logfire_api/_internal/main.pyi

@@ -9,6 +9,12 @@ from .config import GLOBAL_CONFIG as GLOBAL_CONFIG, LogfireConfig as LogfireConf
 from .constants import ATTRIBUTES_JSON_SCHEMA_KEY as ATTRIBUTES_JSON_SCHEMA_KEY, ATTRIBUTES_MESSAGE_KEY as ATTRIBUTES_MESSAGE_KEY, ATTRIBUTES_MESSAGE_TEMPLATE_KEY as ATTRIBUTES_MESSAGE_TEMPLATE_KEY, ATTRIBUTES_SAMPLE_RATE_KEY as ATTRIBUTES_SAMPLE_RATE_KEY, ATTRIBUTES_SPAN_TYPE_KEY as ATTRIBUTES_SPAN_TYPE_KEY, ATTRIBUTES_TAGS_KEY as ATTRIBUTES_TAGS_KEY, ATTRIBUTES_VALIDATION_ERROR_KEY as ATTRIBUTES_VALIDATION_ERROR_KEY, DISABLE_CONSOLE_KEY as DISABLE_CONSOLE_KEY, LevelName as LevelName, NULL_ARGS_KEY as NULL_ARGS_KEY, OTLP_MAX_INT_SIZE as OTLP_MAX_INT_SIZE, log_level_attributes as log_level_attributes
 from .formatter import logfire_format as logfire_format, logfire_format_with_magic as logfire_format_with_magic
 from .instrument import LogfireArgs as LogfireArgs, instrument as instrument
+from .integrations.flask import FlaskInstrumentKwargs as FlaskInstrumentKwargs
+from .integrations.psycopg import PsycopgInstrumentKwargs as PsycopgInstrumentKwargs
+from .integrations.pymongo import PymongoInstrumentKwargs as PymongoInstrumentKwargs
+from .integrations.redis import RedisInstrumentKwargs as RedisInstrumentKwargs
+from .integrations.sqlalchemy import SQLAlchemyInstrumentKwargs as SQLAlchemyInstrumentKwargs
+from .integrations.starlette import StarletteInstrumentKwargs as StarletteInstrumentKwargs
 from .json_encoder import logfire_json_dumps as logfire_json_dumps
 from .json_schema import JsonSchemaProperties as JsonSchemaProperties, attributes_json_schema as attributes_json_schema, attributes_json_schema_properties as attributes_json_schema_properties, create_json_schema as create_json_schema
 from .metrics import ProxyMeterProvider as ProxyMeterProvider
@@ -27,7 +33,7 @@ from starlette.requests import Request as Request
 from starlette.websockets import WebSocket as WebSocket
 from types import TracebackType as TracebackType
 from typing import Any, Callable, ContextManager, Iterable, Literal, Sequence, TypeVar
-from typing_extensions import LiteralString
+from typing_extensions import LiteralString, Unpack
 
 ExcInfo: typing.TypeAlias
 
@@ -542,7 +548,7 @@ class Logfire:
             **kwargs: Additional keyword arguments to pass to the OpenTelemetry `instrument` methods,
                 particularly `request_hook` and `response_hook`.
         """
-    def instrument_psycopg(self, conn_or_module: Any = None, **kwargs: Any):
+    def instrument_psycopg(self, conn_or_module: Any = None, **kwargs: Unpack[PsycopgInstrumentKwargs]) -> None:
         """Instrument a `psycopg` connection or module so that spans are automatically created for each query.
 
         Uses the OpenTelemetry instrumentation libraries for
@@ -561,14 +567,14 @@ class Logfire:
             **kwargs: Additional keyword arguments to pass to the OpenTelemetry `instrument` methods,
                 particularly `enable_commenter` and `commenter_options`.
         """
-    def instrument_flask(self, app: Flask, **kwargs: Any):
+    def instrument_flask(self, app: Flask, **kwargs: Unpack[FlaskInstrumentKwargs]) -> None:
         """Instrument `app` so that spans are automatically created for each request.
 
         Uses the
         [OpenTelemetry Flask Instrumentation](https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/flask/flask.html)
         library, specifically `FlaskInstrumentor().instrument_app()`, to which it passes `**kwargs`.
         """
-    def instrument_starlette(self, app: Starlette, **kwargs: Any):
+    def instrument_starlette(self, app: Starlette, **kwargs: Unpack[StarletteInstrumentKwargs]) -> None:
         """Instrument `app` so that spans are automatically created for each request.
 
         Uses the
@@ -582,21 +588,21 @@ class Logfire:
         [OpenTelemetry aiohttp client Instrumentation](https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/aiohttp_client/aiohttp_client.html)
         library, specifically `AioHttpClientInstrumentor().instrument()`, to which it passes `**kwargs`.
         """
-    def instrument_sqlalchemy(self, **kwargs: Any):
+    def instrument_sqlalchemy(self, **kwargs: Unpack[SQLAlchemyInstrumentKwargs]) -> None:
         """Instrument the `sqlalchemy` module so that spans are automatically created for each query.
 
         Uses the
         [OpenTelemetry SQLAlchemy Instrumentation](https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/sqlalchemy/sqlalchemy.html)
         library, specifically `SQLAlchemyInstrumentor().instrument()`, to which it passes `**kwargs`.
         """
-    def instrument_pymongo(self, **kwargs: Any):
+    def instrument_pymongo(self, **kwargs: Unpack[PymongoInstrumentKwargs]) -> None:
         """Instrument the `pymongo` module so that spans are automatically created for each operation.
 
         Uses the
         [OpenTelemetry pymongo Instrumentation](https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/pymongo/pymongo.html)
             library, specifically `PymongoInstrumentor().instrument()`, to which it passes `**kwargs`.
         """
-    def instrument_redis(self, **kwargs: Any):
+    def instrument_redis(self, **kwargs: Unpack[RedisInstrumentKwargs]) -> None:
         """Instrument the `redis` module so that spans are automatically created for each operation.
 
         Uses the