Prometheus metrics exporter for Starlette applications.
Project description
starlette_exporter
Prometheus exporter for Starlette and FastAPI.
The middleware collects basic metrics:
- Counter: starlette_requests_total
- Histogram: starlette_request_duration_seconds
Metrics include labels for the HTTP method, the path, and the response status code.
starlette_requests_total{method="GET",path="/",status_code="200"} 1.0
starlette_request_duration_seconds_bucket{le="0.01",method="GET",path="/",status_code="200"} 1.0
Use the HTTP handler handle_metrics
at path /metrics
to expose a metrics endpoint to Prometheus.
Usage
pip install starlette_exporter
Starlette
from starlette.applications import Starlette
from starlette_exporter import PrometheusMiddleware, handle_metrics
app = Starlette()
app.add_middleware(PrometheusMiddleware)
app.add_route("/metrics", handle_metrics)
...
FastAPI
from fastapi import FastAPI
from starlette_exporter import PrometheusMiddleware, handle_metrics
app = FastAPI()
app.add_middleware(PrometheusMiddleware)
app.add_route("/metrics", handle_metrics)
...
Options
app_name
: Sets the value of the app_name
label for exported metrics (default: starlette
).
group_paths
: setting this to True
will populate the path label using named parameters (if any) in the router path, e.g. /api/v1/items/{item_id}
. This will group requests together by endpoint (regardless of the value of item_id
). This option may come with a performance hit for larger routers. Default is False
, which will result in separate metrics for different URLs (e.g., /api/v1/items/42
, /api/v1/items/43
, etc.).
Example:
app.add_middleware(PrometheusMiddleware, app_name="hello_world", group_paths=True)
Developing
git clone https://github.com/stephenhillier/starlette_exporter
cd starlette_exporter
pytest tests
License
Code released under the Apache License, Version 2.0.
Dependencies
https://github.com/prometheus/client_python
https://github.com/encode/starlette
Credits
Starlette - https://github.com/encode/starlette
FastAPI - https://github.com/tiangolo/fastapi
Flask exporter - https://github.com/rycus86/prometheus_flask_exporter
Alternate Starlette exporter - https://github.com/perdy/starlette-prometheus
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for starlette_exporter-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5770eca744d1aaabb08cd2ac10ae1a9db75515d76059d20befd11748d3107276 |
|
MD5 | 526ee2144980c18b73119f878c50b4f3 |
|
BLAKE2b-256 | d29238a77016aad297718d951451337d33c5a7a63bdd1d331bc17dfdc09a99a2 |