Support Prometheus metrics for ASGI applications
Project description
asgi-prometheus – Support Prometheus metrics for ASGI applications (Asyncio / Trio, / Curio)
Requirements
python >= 3.7
Installation
asgi-prometheus should be installed using pip:
pip install asgi-prometheus
Usage
Common ASGI applications:
from asgi_prometheus import PrometheusMiddleware
async def my_app(scope, receive, send):
"""Read session and get the current user data from it or from request query."""
await send({"type": "http.response.start", "status": status, "headers": headers})
await send({"type": "http.response.body", "body": b"Hello World!"})
app = PrometheusMiddleware(my_app, metrics_url="/metrics", group_paths=['/'])
# http GET / -> OK
# http GET /metrics -> [Prometheus metrics]
As ASGI-Tools Internal middleware
from asgi_tools import App
from asgi_prometheus import PrometheusMiddleware
app = App()
app.middleware(PrometheusMiddleware.setup(group_paths=['/views', '/api']))
@app.route('/')
async def index(request):
return 'Hello World!'
# http GET / -> OK
# http GET /prometheus -> [Prometheus metrics (default URL)]
Options
from asgi_sessions import PrometheusMiddleware
app = PrometheusMiddleware(
# Your ASGI application
app,
# Metrics URL for Prometheus (set empty string to disable)
metrics_url='/prometheus',
# List of path's prefixes to group. A path which starts from the prefix will be grouped.
# For example: group_paths=['/api/users'], "/api/users/1", "/api/users/2" will be grouped into "/api/users*"
group_paths=[],
)
Bug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/asgi-prometheus/issues
Contributing
Development of the project happens at: https://github.com/klen/asgi-prometheus
License
Licensed under a MIT license.
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
asgi-prometheus-1.0.2.tar.gz
(4.9 kB
view hashes)
Built Distribution
Close
Hashes for asgi_prometheus-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bde9c0eb5c955f6f5919881c3eb9d3aa8608c43659ce498d129254a7661944f |
|
MD5 | 262feae6c04ae8399841fd8302957155 |
|
BLAKE2b-256 | 817f09c1ca601a4a6f6759fb8a77859e35b123577eae87910fcd8a344a8b1616 |