Skip to main content

fastapi-observer

CI PyPI Python License

One-call observability for FastAPI. JSON logs with request IDs, Prometheus metrics and OpenTelemetry traces, with sensitive fields masked by default. No vendor backend: send it to whatever you already run.

from fastapi import FastAPI
from fastapiobserver import install_observability

app = FastAPI()
install_observability(app)

Every request now writes one JSON line, with the same trace_id as its trace when tracing is on:

{
  "timestamp": "2026-10-31T09:10:20.345831+00:00",
  "level": "INFO",
  "logger": "fastapiobserver.middleware",
  "message": "request.completed",
  "app_name": "orders-api",
  "service": "orders",
  "environment": "production",
  "version": "2.3.1",
  "request_id": "d496f541-5e5e-4f14-9174-e9bd697faa62",
  "trace_id": "11d5b6f088bfdba501927e55463be4cd",
  "span_id": "50a12c2d9937eacb",
  "event": {
    "method": "GET",
    "path": "/orders/42",
    "status_code": 200,
    "duration_ms": 1.314,
    "app_duration_ms": 1.35,
    "response_completed": true,
    "client_ip": "203.0.113.7",
    "error_type": "ok"
  }
}

Documentation: vitaee.github.io/FastapiObserver

Already have a JSON logger and approved redaction? Keep them:

install_observability(app, configure_logging=False)

Request diagnostics use your existing handlers, filters, formatters and levels. Your application owns log redaction and export; no logging handler or log exporter is added. See the integration guide and runnable example.

Install

pip install fastapi-observer                 # JSON logs, request IDs, redaction
pip install "fastapi-observer[prometheus]"   # + Prometheus /metrics
pip install "fastapi-observer[otel]"         # + OpenTelemetry traces and OTLP logs
pip install "fastapi-observer[all]"          # everything

Requires Python 3.11 or newer.

Configure with environment variables

install_observability(app) reads its settings from the environment: its own start with OBS_, and OpenTelemetry's standard OTEL_* variables work as usual. These are the ones most apps set:

Variable Example What it does
OBS_APP_NAME, OBS_SERVICE_NAME, OBS_ENVIRONMENT, OBS_APP_VERSION orders-api, orders, production, 2.3.1 Added to every log line
OBS_METRICS_ENABLED true Serves Prometheus metrics at /metrics (needs [prometheus])
OBS_OTEL_ENABLED, OTEL_EXPORTER_OTLP_ENDPOINT true, http://collector:4317 Sends traces over OTLP and adds trace_id to logs (needs [otel])
OBS_REDACTION_PRESET strict, pci, gdpr Chooses which fields and headers are masked
OBS_PROFILE development, production Sensible defaults: production sets INFO logs, a larger log queue, the strict preset and the event-loop watchdog

Explicit variables and Python arguments always win over profile defaults. Every setting is listed in the configuration guide.

What you get

  • One JSON line per request with method, path, sent status, response duration, total application lifetime and client IP, and your service's name, environment and version on every line, including your own logging calls. HTTP latency excludes background work; later failures still appear on the correlated request line.
  • 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.
  • Field-name redaction on by default. The library's outputs mask values under configured sensitive field and header names, including passwords, tokens, API keys, Authorization and cookies. URL credentials are masked in exception messages and stack traces. Arbitrary free text is not scanned for secrets or personal data; retain your approved sanitizer for that. Presets (strict, pci, gdpr) select fields and masking rules, not compliance guarantees. See the redaction limits.
  • Prometheus metrics labelled by route template (/orders/{order_id}). Requests no route matches, such as scanners, CORS preflights and requests an auth middleware rejects, share one <unmatched> label, and made-up methods share _OTHER, so neither IDs nor anonymous clients explode cardinality.
  • 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. A warning with the stack of any sync call that blocks the event loop, on in the production profile. A warning when the thread pool or a database connection pool is full, the usual cause when latency climbs while CPU stays low. For the SQLAlchemy engines you pass in, each request line counts its queries, and a query run once per item (N+1) gets a warning. HTTPX/HTTPX2 clients passed to instrument_httpx_client(), and Requests instrumented with instrument_requests_session(), report outbound counts, duration and failure categories too. These diagnostics work without tracing. Opt-in: DEBUG lines written only for requests that fail. With metrics on, /metrics shows how many bytes of logs each route writes (in a single process), and OBS_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, SQLAlchemy, httpx and requests tracing, Strawberry GraphQL and a Loguru bridge. See the documentation.

The logging features above describe the default library-owned pipeline. With configure_logging=False, formatting, levels, sampling, queuing, redaction and log export follow the application's configuration.

Grafana dashboard built from fastapi-observer metrics, traces and logs

The Grafana dashboard from examples/full_stack, a Docker Compose stack you can run locally.

How it compares

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 Field/header names and exception URL credentials; 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:

  • You only want logs and need the lowest possible overhead: structlog alone does less work per line.
  • You already send everything to Logfire, Datadog or Sentry: their own FastAPI integrations fit better.
  • Your app isn't built on FastAPI or Starlette.

What it costs: with default settings, about 49 µs of CPU per request on an Apple M1, 35 µs of it on the request's own thread and the rest writing the line on a background thread. See the benchmarks, including outbound HTTP diagnostics and a comparison with wiring the same stack by hand.

Works with

  • Servers: uvicorn, gunicorn with UvicornWorker, and Granian. Uvicorn's duplicate access line is dropped automatically. To get the servers' own startup lines as JSON too, see running with gunicorn and Granian.
  • Backends: Prometheus, Grafana (Loki, Tempo), Jaeger and anything that accepts OTLP. See backends.
  • Error tracking: runs alongside Sentry. See the Sentry notes.

Why you can trust it

  • Tested in CI on Python 3.11 to 3.15, against both the newest and the oldest dependency versions it supports, type-checked with mypy --strict, and used in production by its maintainer.
  • Releases are published with PyPI Trusted Publishing and signed attestations, and only after their tests pass. CI runs pip-audit and builds the package on every pull request.
  • Security fixes are called out in the changelog. To report a vulnerability, see SECURITY.md.
  • Benchmarks are reproducible from examples/benchmarks.

Compatibility

Component Supported
Python >=3.11 (CI: 3.11 to 3.15)
FastAPI >=0.133.0
Starlette >=1.3.1
Prometheus extra prometheus-client>=0.24.1
OpenTelemetry extra opentelemetry-api/sdk/exporter>=1.45.1

Documentation

Support the project

If this library saves you time, you can buy me a coffee.

Metadata

Release files for fastapi-observer 2.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fastapi-observer 2.2.0
File Size Uploaded Provenance Actions
fastapi_observer-2.2.0.tar.gz 131.5 kB With provenance Details for fastapi_observer-2.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for fastapi-observer 2.2.0
File Interpreter ABI Platform Actions
fastapi_observer-2.2.0-py3-none-any.whl Python 3 none any Details for fastapi_observer-2.2.0-py3-none-any.whl

Total release size: 225.8 kB

Release files / fastapi_observer-2.2.0.tar.gz

Download URL fastapi_observer-2.2.0.tar.gz
Size 131.5 kB
Tags Source
SHA-256 checksum
How to use checksums
1546dd65879691732a2c9a839641f92f0c4e0bb3b24e6ca69fa5bbd77d7ce2bb
BLAKE2b-256 checksum
How to use checksums
268081af88fae5eb44fda9b13a31731aa1ae647eec231822cd405b97caed94c3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

Release files / fastapi_observer-2.2.0-py3-none-any.whl

Download URL fastapi_observer-2.2.0-py3-none-any.whl
Size 94.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b51e80016f69ebd36627351bb2b1b7865e8814a6f46d30eda33da548849d6585
BLAKE2b-256 checksum
How to use checksums
2e95f3444329f6b67ebaee48f056370256551fb874f81babff03bbfcf77f72f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

Security for fastapi-observer 2.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for fastapi_observer-2.2.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.2.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page