aiohttp_prometheus_exporter's Introduction

aiohttp prometheus exporter

Export aiohttp metrics for Prometheus.io

Usage

Requirements

aiohttp >= 3

Installation

Install with:

pip install aiohttp-prometheus-exporter

Server quickstart

from aiohttp import web
from aiohttp_prometheus_exporter.handler import metrics
from aiohttp_prometheus_exporter.middleware import prometheus_middleware_factory

async def hello(request):
    return web.Response(text="Hello, world")

app = web.Application()
app.add_routes([web.get('/', hello)])

app.middlewares.append(prometheus_middleware_factory())
app.router.add_get("/metrics", metrics())

web.run_app(app)

Client quickstart

import aiohttp
from aiohttp_prometheus_exporter.trace import PrometheusTraceConfig

async with aiohttp.ClientSession(trace_configs=[PrometheusTraceConfig()) as session:
    async with session.get('http://httpbin.org/get') as resp:
        print(resp.status)
        print(await resp.text())

Now, client metrics are attached to metrics exposed by your web server.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

aiohttp_prometheus_exporter's People

Contributors

Stargazers

Watchers

aiohttp_prometheus_exporter's Issues

remote label cardinality

Hi!

Thanks a lot for this repository, it helped me a lot and gave me inspiration.
I wanted to mention the "remote" label that stores the caller's IP address, which is kind of unbounded.
Prometheus documentation state the following:

CAUTION: Remember that every unique combination of key-value label pairs represents a new time series, which can dramatically increase the amount of data stored. Do not use labels to store dimensions with high cardinality (many different label values), such as user IDs, email addresses, or other unbounded sets of values.

Thus I think you need to consider this label for high-scale webservers as it might blow up the request and the data

Recommend Projects