fastapi-observer 1.12.0__tar.gz → 1.13.0__tar.gz

{fastapi_observer-1.12.0/src/fastapi_observer.egg-info → fastapi_observer-1.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-observer
-Version: 1.12.0
+Version: 1.13.0
 Summary: Zero-glue FastAPI observability with security presets and runtime controls
 Author-email: Vitaee <opensource@vitaee.dev>
 License-Expression: MIT
@@ -150,9 +150,9 @@ Explicit variables and Python arguments always win over profile defaults. Every
 - **Request IDs** taken from `X-Request-ID` when the caller is a trusted proxy, generated otherwise, returned in the response and passed on to the services you call, so one ID finds a request's logs in every service.
 - **Redaction on by default.** Passwords, tokens, API keys, `Authorization` and cookies are masked before anything is written. Presets cover stricter needs (`strict`, `pci`, `gdpr`).
 - **Prometheus metrics** labelled by route template (`/orders/{order_id}`), and 404s for paths no route matches share one `<unmatched>` label, so neither IDs nor scanners explode cardinality.
-- **OpenTelemetry traces** with `trace_id` and `span_id` in every log line, and optional log export over OTLP.
+- **OpenTelemetry traces**, from FastAPI's own support on 0.142 and later, with `trace_id` and `span_id` in every log line, and optional log export over OTLP, redacted like everything else.
 - **Non-blocking log writes.** Lines are written from a background thread, so a slow stdout never stalls the event loop.
-- **Help finding what slows a request down.** Opt-in: a warning with the stack of any sync call that blocks the event loop, and `DEBUG` lines written only for requests that fail. With tracing on, each request line counts its queries and outbound HTTP calls, and a query run once per item (N+1) gets a warning. With metrics on, `/metrics` shows how many bytes of logs each route writes, and `LOG_SAMPLE_RATE` keeps a share of successful requests, chosen by trace ID, while failed and slow requests are always written in full.
+- **Help finding what slows a request down.** Opt-in: a warning with the stack of any sync call that blocks the event loop, and `DEBUG` lines written only for requests that fail. Always on: a warning when the thread pool or a database connection pool is full, the usual cause when latency climbs while CPU stays low. With tracing on, each request line counts its queries and outbound HTTP calls, and a query run once per item (N+1) gets a warning. With metrics on, `/metrics` shows how many bytes of logs each route writes, and `LOG_SAMPLE_RATE` keeps a share of successful requests, chosen by trace ID, while failed and slow requests are always written in full.
 
 Optional extras: runtime log-level control, a tamper-evident audit log, SQLAlchemy, `httpx` and `requests` tracing, Strawberry GraphQL and a Loguru bridge. See the [documentation](https://vitaee.github.io/FastapiObserver/).
 
@@ -162,14 +162,16 @@ Optional extras: runtime log-level control, a tamper-evident audit log, SQLAlche
 
 ## How it compares
 
-| | fastapi-observer | structlog or loguru | OpenTelemetry auto-instrumentation | Logfire |
-|---|---|---|---|---|
-| JSON log line per request | Built in | You write the middleware | No | A span per request |
-| Request ID on every log line | Built in | You wire it up | No | Trace IDs |
-| Redaction by default | Yes, with presets | You write a processor | No | Yes |
-| Prometheus `/metrics` | Built in | No | Through an exporter | No |
-| Traces | OpenTelemetry | No | Yes | Yes |
-| Where data goes | stdout, Prometheus and any OTLP backend | stdout or files | Any OTLP backend | Logfire's platform |
+| | fastapi-observer | FastAPI 0.142+ built in | structlog or loguru | OpenTelemetry auto-instrumentation | Logfire |
+|---|---|---|---|---|---|
+| JSON log line per request | Built in | No, only errors as OTLP log records | You write the middleware | No | A span per request |
+| Request ID on every log line | Built in | No | You wire it up | No | Trace IDs |
+| Redaction by default | Yes, with presets | Signed-URL query parameters only | You write a processor | No | Yes |
+| Prometheus `/metrics` | Built in | Through an exporter | No | Through an exporter | No |
+| Traces | FastAPI's own on 0.142+, OpenTelemetry's instrumentation before | Yes, with spans for dependencies, the endpoint and serialization | No | Yes | Yes |
+| Where data goes | stdout, Prometheus and any OTLP backend | Any OTLP backend | stdout or files | Any OTLP backend | Logfire's platform |
+
+Since 0.142, FastAPI traces requests on its own once an OpenTelemetry provider is set up. fastapi-observer uses that for traces and adds the rest of the first column.
 
 **When not to use it:**
 

{fastapi_observer-1.12.0 → fastapi_observer-1.13.0}/README.md

@@ -74,9 +74,9 @@ Explicit variables and Python arguments always win over profile defaults. Every
 - **Request IDs** taken from `X-Request-ID` when the caller is a trusted proxy, generated otherwise, returned in the response and passed on to the services you call, so one ID finds a request's logs in every service.
 - **Redaction on by default.** Passwords, tokens, API keys, `Authorization` and cookies are masked before anything is written. Presets cover stricter needs (`strict`, `pci`, `gdpr`).
 - **Prometheus metrics** labelled by route template (`/orders/{order_id}`), and 404s for paths no route matches share one `<unmatched>` label, so neither IDs nor scanners explode cardinality.
-- **OpenTelemetry traces** with `trace_id` and `span_id` in every log line, and optional log export over OTLP.
+- **OpenTelemetry traces**, from FastAPI's own support on 0.142 and later, with `trace_id` and `span_id` in every log line, and optional log export over OTLP, redacted like everything else.
 - **Non-blocking log writes.** Lines are written from a background thread, so a slow stdout never stalls the event loop.
-- **Help finding what slows a request down.** Opt-in: a warning with the stack of any sync call that blocks the event loop, and `DEBUG` lines written only for requests that fail. With tracing on, each request line counts its queries and outbound HTTP calls, and a query run once per item (N+1) gets a warning. With metrics on, `/metrics` shows how many bytes of logs each route writes, and `LOG_SAMPLE_RATE` keeps a share of successful requests, chosen by trace ID, while failed and slow requests are always written in full.
+- **Help finding what slows a request down.** Opt-in: a warning with the stack of any sync call that blocks the event loop, and `DEBUG` lines written only for requests that fail. Always on: a warning when the thread pool or a database connection pool is full, the usual cause when latency climbs while CPU stays low. With tracing on, each request line counts its queries and outbound HTTP calls, and a query run once per item (N+1) gets a warning. With metrics on, `/metrics` shows how many bytes of logs each route writes, and `LOG_SAMPLE_RATE` keeps a share of successful requests, chosen by trace ID, while failed and slow requests are always written in full.
 
 Optional extras: runtime log-level control, a tamper-evident audit log, SQLAlchemy, `httpx` and `requests` tracing, Strawberry GraphQL and a Loguru bridge. See the [documentation](https://vitaee.github.io/FastapiObserver/).
 
@@ -86,14 +86,16 @@ Optional extras: runtime log-level control, a tamper-evident audit log, SQLAlche
 
 ## How it compares
 
-| | fastapi-observer | structlog or loguru | OpenTelemetry auto-instrumentation | Logfire |
-|---|---|---|---|---|
-| JSON log line per request | Built in | You write the middleware | No | A span per request |
-| Request ID on every log line | Built in | You wire it up | No | Trace IDs |
-| Redaction by default | Yes, with presets | You write a processor | No | Yes |
-| Prometheus `/metrics` | Built in | No | Through an exporter | No |
-| Traces | OpenTelemetry | No | Yes | Yes |
-| Where data goes | stdout, Prometheus and any OTLP backend | stdout or files | Any OTLP backend | Logfire's platform |
+| | fastapi-observer | FastAPI 0.142+ built in | structlog or loguru | OpenTelemetry auto-instrumentation | Logfire |
+|---|---|---|---|---|---|
+| JSON log line per request | Built in | No, only errors as OTLP log records | You write the middleware | No | A span per request |
+| Request ID on every log line | Built in | No | You wire it up | No | Trace IDs |
+| Redaction by default | Yes, with presets | Signed-URL query parameters only | You write a processor | No | Yes |
+| Prometheus `/metrics` | Built in | Through an exporter | No | Through an exporter | No |
+| Traces | FastAPI's own on 0.142+, OpenTelemetry's instrumentation before | Yes, with spans for dependencies, the endpoint and serialization | No | Yes | Yes |
+| Where data goes | stdout, Prometheus and any OTLP backend | Any OTLP backend | stdout or files | Any OTLP backend | Logfire's platform |
+
+Since 0.142, FastAPI traces requests on its own once an OpenTelemetry provider is set up. fastapi-observer uses that for traces and adds the rest of the first column.
 
 **When not to use it:**
 

{fastapi_observer-1.12.0 → fastapi_observer-1.13.0/src/fastapi_observer.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-observer
-Version: 1.12.0
+Version: 1.13.0
 Summary: Zero-glue FastAPI observability with security presets and runtime controls
 Author-email: Vitaee <opensource@vitaee.dev>
 License-Expression: MIT
@@ -150,9 +150,9 @@ Explicit variables and Python arguments always win over profile defaults. Every
 - **Request IDs** taken from `X-Request-ID` when the caller is a trusted proxy, generated otherwise, returned in the response and passed on to the services you call, so one ID finds a request's logs in every service.
 - **Redaction on by default.** Passwords, tokens, API keys, `Authorization` and cookies are masked before anything is written. Presets cover stricter needs (`strict`, `pci`, `gdpr`).
 - **Prometheus metrics** labelled by route template (`/orders/{order_id}`), and 404s for paths no route matches share one `<unmatched>` label, so neither IDs nor scanners explode cardinality.
-- **OpenTelemetry traces** with `trace_id` and `span_id` in every log line, and optional log export over OTLP.
+- **OpenTelemetry traces**, from FastAPI's own support on 0.142 and later, with `trace_id` and `span_id` in every log line, and optional log export over OTLP, redacted like everything else.
 - **Non-blocking log writes.** Lines are written from a background thread, so a slow stdout never stalls the event loop.
-- **Help finding what slows a request down.** Opt-in: a warning with the stack of any sync call that blocks the event loop, and `DEBUG` lines written only for requests that fail. With tracing on, each request line counts its queries and outbound HTTP calls, and a query run once per item (N+1) gets a warning. With metrics on, `/metrics` shows how many bytes of logs each route writes, and `LOG_SAMPLE_RATE` keeps a share of successful requests, chosen by trace ID, while failed and slow requests are always written in full.
+- **Help finding what slows a request down.** Opt-in: a warning with the stack of any sync call that blocks the event loop, and `DEBUG` lines written only for requests that fail. Always on: a warning when the thread pool or a database connection pool is full, the usual cause when latency climbs while CPU stays low. With tracing on, each request line counts its queries and outbound HTTP calls, and a query run once per item (N+1) gets a warning. With metrics on, `/metrics` shows how many bytes of logs each route writes, and `LOG_SAMPLE_RATE` keeps a share of successful requests, chosen by trace ID, while failed and slow requests are always written in full.
 
 Optional extras: runtime log-level control, a tamper-evident audit log, SQLAlchemy, `httpx` and `requests` tracing, Strawberry GraphQL and a Loguru bridge. See the [documentation](https://vitaee.github.io/FastapiObserver/).
 
@@ -162,14 +162,16 @@ Optional extras: runtime log-level control, a tamper-evident audit log, SQLAlche
 
 ## How it compares
 
-| | fastapi-observer | structlog or loguru | OpenTelemetry auto-instrumentation | Logfire |
-|---|---|---|---|---|
-| JSON log line per request | Built in | You write the middleware | No | A span per request |
-| Request ID on every log line | Built in | You wire it up | No | Trace IDs |
-| Redaction by default | Yes, with presets | You write a processor | No | Yes |
-| Prometheus `/metrics` | Built in | No | Through an exporter | No |
-| Traces | OpenTelemetry | No | Yes | Yes |
-| Where data goes | stdout, Prometheus and any OTLP backend | stdout or files | Any OTLP backend | Logfire's platform |
+| | fastapi-observer | FastAPI 0.142+ built in | structlog or loguru | OpenTelemetry auto-instrumentation | Logfire |
+|---|---|---|---|---|---|
+| JSON log line per request | Built in | No, only errors as OTLP log records | You write the middleware | No | A span per request |
+| Request ID on every log line | Built in | No | You wire it up | No | Trace IDs |
+| Redaction by default | Yes, with presets | Signed-URL query parameters only | You write a processor | No | Yes |
+| Prometheus `/metrics` | Built in | Through an exporter | No | Through an exporter | No |
+| Traces | FastAPI's own on 0.142+, OpenTelemetry's instrumentation before | Yes, with spans for dependencies, the endpoint and serialization | No | Yes | Yes |
+| Where data goes | stdout, Prometheus and any OTLP backend | Any OTLP backend | stdout or files | Any OTLP backend | Logfire's platform |
+
+Since 0.142, FastAPI traces requests on its own once an OpenTelemetry provider is set up. fastapi-observer uses that for traces and adds the rest of the first column.
 
 **When not to use it:**
 

{fastapi_observer-1.12.0 → fastapi_observer-1.13.0}/src/fastapi_observer.egg-info/SOURCES.txt

@@ -15,6 +15,7 @@ src/fastapiobserver/fastapi.py
 src/fastapiobserver/loguru.py
 src/fastapiobserver/loop_watchdog.py
 src/fastapiobserver/plugins.py
+src/fastapiobserver/pools.py
 src/fastapiobserver/profiles.py
 src/fastapiobserver/propagation.py
 src/fastapiobserver/py.typed
@@ -98,6 +99,7 @@ tests/test_otel_logs_pipeline.py
 tests/test_otel_metrics_from_env.py
 tests/test_otlp_export_integration.py
 tests/test_plugin_isolation.py
+tests/test_pools.py
 tests/test_profiles.py
 tests/test_propagation.py
 tests/test_redaction_presets.py

fastapi_observer-1.13.0/src/fastapiobserver/_version.py

@@ -0,0 +1 @@
+__version__ = "1.13.0"

{fastapi_observer-1.12.0 → fastapi_observer-1.13.0}/src/fastapiobserver/fastapi.py

@@ -35,6 +35,7 @@ from .otel import (
     install_otel_metrics,
 )
 from .otel.native import keep_native_logs_out
+from .pools import watch_db_pool, watch_thread_pool
 from .propagation import install_request_id_propagation
 from .security import SecurityPolicy, TrustedProxyPolicy
 
@@ -109,9 +110,13 @@ def install_observability(
     if otel_settings and otel_settings.enabled:
         install_otel(app, settings, otel_settings)
 
-    # --- 4b. Database tracing + SQLCommenter ---
-    if db_engine is not None and otel_settings and otel_settings.enabled:
-        _setup_database_tracing(db_engine, db_commenter_enabled, db_commenter_options)
+    # --- 4b. Database pools, tracing + SQLCommenter ---
+    if db_engine is not None:
+        engines = _as_engine_list(db_engine)
+        for engine in engines:
+            watch_db_pool(getattr(engine, "sync_engine", engine))
+        if otel_settings and otel_settings.enabled:
+            _setup_database_tracing(engines, db_commenter_enabled, db_commenter_options)
 
     # --- 5. OTel metrics ---
     if otel_metrics_settings and otel_metrics_settings.enabled:
@@ -262,8 +267,17 @@ def _setup_metrics_backend(
     return metrics_backend
 
 
+def _as_engine_list(db_engine: Any | Sequence[Any]) -> list[Any]:
+    if isinstance(db_engine, (str, bytes, bytearray)):
+        raise TypeError(
+            f"db_engine must be an SQLAlchemy Engine or sequence of Engines, "
+            f"not {type(db_engine).__name__}"
+        )
+    return list(db_engine) if isinstance(db_engine, Sequence) else [db_engine]
+
+
 def _setup_database_tracing(
-    db_engine: Any | Sequence[Any],
+    engines: list[Any],
     db_commenter_enabled: bool,
     db_commenter_options: dict[str, bool] | None,
 ) -> None:
@@ -272,13 +286,6 @@ def _setup_database_tracing(
         instrument_sqlalchemy_async,
     )
 
-    if isinstance(db_engine, (str, bytes, bytearray)):
-        raise TypeError(
-            f"db_engine must be an SQLAlchemy Engine or sequence of Engines, "
-            f"not {type(db_engine).__name__}"
-        )
-
-    engines = db_engine if isinstance(db_engine, Sequence) else [db_engine]
     for engine in engines:
         if hasattr(engine, "sync_engine"):
             instrument_sqlalchemy_async(
@@ -400,6 +407,7 @@ async def observability_lifespan(app: FastAPI) -> typing.AsyncGenerator[typing.A
     watchdog = None
     if state:
         _auto_discover_excluded_routes(app, state.settings)
+        watch_thread_pool()
         if state.settings.loop_block_threshold_ms:
             watchdog = EventLoopWatchdog(state.settings.loop_block_threshold_ms / 1000)
             watchdog.start()

{fastapi_observer-1.12.0 → fastapi_observer-1.13.0}/src/fastapiobserver/metrics/prometheus.py

@@ -186,17 +186,65 @@ class _LogQueueMetricsCollector:
             yield counter
 
 
-def _register_log_queue_metrics_collector() -> None:
-    # Per-worker queue stats would be meaningless once aggregated across processes.
+class _PoolMetricsCollector:
+    """Exposes thread pool and SQLAlchemy connection pool usage at scrape time."""
+
+    def collect(self) -> Iterator[Any]:
+        from prometheus_client.core import GaugeMetricFamily
+
+        from ..pools import db_pool_usage, thread_pool_usage
+
+        threads = thread_pool_usage()
+        if threads is not None:
+            busy, limit, waiting = threads
+            yield GaugeMetricFamily(
+                "fastapiobserver_threadpool_busy",
+                "Threads running sync endpoints and dependencies.",
+                value=busy,
+            )
+            yield GaugeMetricFamily(
+                "fastapiobserver_threadpool_limit",
+                "Threads AnyIO's default pool may run at once.",
+                value=limit,
+            )
+            yield GaugeMetricFamily(
+                "fastapiobserver_threadpool_waiting",
+                "Calls waiting for a thread.",
+                value=waiting,
+            )
+
+        db_pools = db_pool_usage()
+        if not db_pools:
+            return
+        checked_out = GaugeMetricFamily(
+            "fastapiobserver_db_pool_checked_out",
+            "Connections checked out of each SQLAlchemy pool.",
+            labels=["engine"],
+        )
+        limits = GaugeMetricFamily(
+            "fastapiobserver_db_pool_limit",
+            "Connections each SQLAlchemy pool may hand out: pool_size plus max_overflow.",
+            labels=["engine"],
+        )
+        for label, out, limit in db_pools:
+            checked_out.add_metric([label], out)
+            limits.add_metric([label], limit)
+        yield checked_out
+        yield limits
+
+
+def _register_collectors() -> None:
+    # Per-worker stats would be meaningless once aggregated across processes.
     if _multiprocess_dir():
         return
     from ..logging.volume import start_counting
 
     start_counting()
-    try:
-        _import_prometheus_client().REGISTRY.register(_LogQueueMetricsCollector())
-    except ValueError:
-        pass  # Already registered by an earlier backend build in this process.
+    for collector in (_LogQueueMetricsCollector(), _PoolMetricsCollector()):
+        try:
+            _import_prometheus_client().REGISTRY.register(collector)
+        except ValueError:
+            pass  # Already registered by an earlier backend build in this process.
 
 
 class PrometheusMetricsBackend:
@@ -288,7 +336,7 @@ def _build_prometheus_metrics_backend(
         environment=environment,
         exemplars_enabled=exemplars_enabled,
     )
-    _register_log_queue_metrics_collector()
+    _register_collectors()
     return backend
 
 

{fastapi_observer-1.12.0 → fastapi_observer-1.13.0}/src/fastapiobserver/middleware/request_logging.py

@@ -9,6 +9,7 @@ from starlette.types import ASGIApp, Message, Receive, Scope, Send
 from ..config import ObservabilitySettings
 from ..logging.held import keep_request_logs
 from ..metrics import MetricsBackend, NoopMetricsBackend
+from ..pools import check_pools
 from ..request_context import get_request_state
 from ..security import (
     SecurityPolicy,
@@ -62,6 +63,7 @@ class RequestLoggingMiddleware:
             await self.app(scope, receive, send)
             return
 
+        check_pools()
         start = time.perf_counter()
         raw_headers = scope.get("headers", [])
         client_ip, trusted_source = self.ip_resolver.resolve(scope, raw_headers)

fastapi_observer-1.13.0/src/fastapiobserver/pools.py

@@ -0,0 +1,99 @@
+"""Full pools: requests wait, latency climbs, CPU stays low.
+
+Two pools make requests wait without using CPU: AnyIO's thread pool, which runs
+sync endpoints and dependencies, and SQLAlchemy connection pools. Neither AnyIO
+nor SQLAlchemy has a hook for how long one call waited, so this reports when a
+pool is full: a warning at most once a minute per pool, checked as each request
+starts, and gauges on ``/metrics``. Requests still start when every thread and
+connection is stuck, so a deadlock is reported too.
+"""
+
+from __future__ import annotations
+
+import logging
+import math
+import time
+import weakref
+from typing import Any
+
+_LOGGER = logging.getLogger("fastapiobserver.pools")
+# ponytail: fixed; make it a setting if once a minute is too noisy or too quiet.
+_WARN_INTERVAL_SECONDS = 60.0
+
+_thread_limiter: Any = None  # AnyIO's default limiter, captured on the event loop
+_db_pools: weakref.WeakKeyDictionary[Any, str] = weakref.WeakKeyDictionary()  # engine: label
+_last_warned: dict[str, float] = {}
+
+
+def watch_thread_pool() -> None:
+    """Remember AnyIO's default thread limiter. Call it on the event loop."""
+    global _thread_limiter
+    from anyio.to_thread import current_default_thread_limiter
+
+    _thread_limiter = current_default_thread_limiter()
+
+
+def watch_db_pool(engine: Any) -> None:
+    """Watch a sync SQLAlchemy engine's pool, if it has a limit (``QueuePool``)."""
+    if callable(getattr(engine.pool, "checkedout", None)):
+        _db_pools[engine] = engine.url.render_as_string(hide_password=True)
+
+
+def thread_pool_usage() -> tuple[int, float, int] | None:
+    """Busy threads, the limit and calls waiting; None until the app has started."""
+    if _thread_limiter is None:
+        return None
+    stats = _thread_limiter.statistics()
+    return stats.borrowed_tokens, stats.total_tokens, stats.tasks_waiting
+
+
+def db_pool_usage() -> list[tuple[str, int, float]]:
+    """Each watched engine's label, checked-out connections and limit."""
+    return [
+        (label, engine.pool.checkedout(), _db_pool_limit(engine.pool))
+        for engine, label in list(_db_pools.items())
+    ]
+
+
+def check_pools() -> None:
+    """Warn about full pools. Called as each request starts."""
+    limiter = _thread_limiter
+    # Cheap test first; statistics() copies the borrower list.
+    if limiter is not None and limiter.borrowed_tokens >= limiter.total_tokens:
+        busy, limit, waiting = thread_pool_usage() or (0, 0, 0)
+        if waiting:
+            _warn(
+                "threadpool.saturated",
+                "threadpool",
+                {"busy": busy, "limit": limit, "waiting": waiting},
+            )
+    for label, checked_out, limit in db_pool_usage():
+        if checked_out >= limit:
+            _warn(
+                "db.pool_exhausted",
+                label,
+                {"engine": label, "checked_out": checked_out, "limit": limit},
+            )
+
+
+def _db_pool_limit(pool: Any) -> float:
+    # max_overflow has no public accessor; without it, or at -1, there's no limit.
+    max_overflow = getattr(pool, "_max_overflow", -1)
+    return math.inf if max_overflow < 0 else pool.size() + max_overflow
+
+
+def _warn(message: str, pool: str, event: dict[str, Any]) -> None:
+    now = time.monotonic()
+    if now - _last_warned.get(pool, -math.inf) < _WARN_INTERVAL_SECONDS:
+        return
+    _last_warned[pool] = now
+    _LOGGER.warning(message, extra={"event": event, "_skip_enrichers": True})
+
+
+__all__ = [
+    "check_pools",
+    "db_pool_usage",
+    "thread_pool_usage",
+    "watch_db_pool",
+    "watch_thread_pool",
+]

fastapi_observer-1.13.0/tests/test_pools.py

@@ -0,0 +1,116 @@
+from __future__ import annotations
+
+import asyncio
+import logging
+import threading
+from types import SimpleNamespace
+
+import anyio.to_thread
+from fastapi import FastAPI
+from fastapi.testclient import TestClient
+import httpx2
+import pytest
+
+from fastapiobserver import ObservabilitySettings, install_observability
+from fastapiobserver import pools
+
+prometheus_client = pytest.importorskip("prometheus_client")
+
+
+@pytest.fixture(autouse=True)
+def _fresh_warnings() -> None:
+    pools._last_warned.clear()
+
+
+def _warnings(caplog: pytest.LogCaptureFixture, message: str) -> list[logging.LogRecord]:
+    return [r for r in caplog.records if r.getMessage() == message]
+
+
+def test_requests_waiting_for_a_thread_are_reported(caplog: pytest.LogCaptureFixture) -> None:
+    app = FastAPI()
+    release = threading.Event()
+
+    @app.get("/sync")
+    def sync_endpoint() -> dict[str, str]:  # runs in AnyIO's thread pool
+        release.wait(5)
+        return {}
+
+    @app.get("/ping")
+    async def ping() -> dict[str, str]:
+        return {}
+
+    install_observability(app, ObservabilitySettings(), metrics_enabled=True)
+
+    async def main() -> str:
+        async with app.router.lifespan_context(app):
+            anyio.to_thread.current_default_thread_limiter().total_tokens = 1
+            transport = httpx2.ASGITransport(app=app)
+            async with httpx2.AsyncClient(transport=transport, base_url="http://test") as client:
+                blocked = [asyncio.create_task(client.get("/sync")) for _ in range(2)]
+                await asyncio.sleep(0.1)  # one call holds the only thread, one waits
+                await client.get("/ping")  # starts while the pool is full
+                await client.get("/ping")  # within a minute: no second warning
+                metrics = prometheus_client.generate_latest().decode()
+                release.set()
+                await asyncio.gather(*blocked)
+        return metrics
+
+    with caplog.at_level(logging.WARNING, logger="fastapiobserver.pools"):
+        metrics = asyncio.run(main())
+
+    [warning] = _warnings(caplog, "threadpool.saturated")
+    assert warning.event == {"busy": 1, "limit": 1, "waiting": 1}  # type: ignore[attr-defined]
+    assert "fastapiobserver_threadpool_busy 1.0" in metrics
+    assert "fastapiobserver_threadpool_limit 1.0" in metrics
+    assert "fastapiobserver_threadpool_waiting 1.0" in metrics
+
+
+class _QueuePool:
+    """The part of SQLAlchemy's QueuePool that fastapi-observer reads."""
+
+    def __init__(self, size: int, max_overflow: int) -> None:
+        self._size = size
+        self._max_overflow = max_overflow
+        self.checked_out = 0
+
+    def size(self) -> int:
+        return self._size
+
+    def checkedout(self) -> int:
+        return self.checked_out
+
+
+class _Engine:
+    """A SQLAlchemy engine: weakly referenceable, with a pool and a URL."""
+
+    def __init__(self, pool: _QueuePool) -> None:
+        self.pool = pool
+        self.url = SimpleNamespace(render_as_string=lambda hide_password: "postgresql://app@db/orders")
+
+
+def test_a_full_database_pool_is_reported(caplog: pytest.LogCaptureFixture) -> None:
+    pool = _QueuePool(size=2, max_overflow=1)
+    engine = _Engine(pool)
+    app = FastAPI()
+
+    @app.get("/ping")
+    async def ping() -> dict[str, str]:
+        return {}
+
+    install_observability(app, ObservabilitySettings(), metrics_enabled=True, db_engine=engine)
+    client = TestClient(app)
+    with caplog.at_level(logging.WARNING, logger="fastapiobserver.pools"):
+        client.get("/ping")  # 0 of 3 checked out
+        pool.checked_out = 3
+        client.get("/ping")
+        client.get("/ping")  # within a minute: no second warning
+
+    [warning] = _warnings(caplog, "db.pool_exhausted")
+    assert warning.event == {  # type: ignore[attr-defined]
+        "engine": "postgresql://app@db/orders",
+        "checked_out": 3,
+        "limit": 3,
+    }
+    metrics = prometheus_client.generate_latest().decode()
+    assert 'fastapiobserver_db_pool_checked_out{engine="postgresql://app@db/orders"} 3.0' in metrics
+    assert 'fastapiobserver_db_pool_limit{engine="postgresql://app@db/orders"} 3.0' in metrics

fastapi_observer-1.12.0/src/fastapiobserver/_version.py

@@ -1 +0,0 @@
-__version__ = "1.12.0"