Skip to main content

Async helpers for prometheus_client.

Project description

PyPI Documentation Status CI status Test Coverage Code style: black

prometheus_async adds support for asynchronous frameworks to the official Python client for the Prometheus metrics and monitoring system.

Currently asyncio (Python 3.5+, PyPy3) and Twisted (Python 2.7, 3.5+, PyPy) are supported.

It works by wrapping the metrics from the official client:

import asyncio

from aiohttp import web
from prometheus_client import Histogram
from prometheus_async.aio import time

REQ_TIME = Histogram("req_time_seconds", "time spent in requests")

@time(REQ_TIME)
async def req(request):
    await asyncio.sleep(1)
    return web.Response(body=b"hello")

Even for synchronous applications, the metrics exposure methods can be useful since they are more powerful than the one shipped with the official client. For that, helper functions have been added that run them in separate threads (asyncio-only for the time being).

The source code is hosted on GitHub and the documentation on Read The Docs.

Release Information

18.2.0 (2018-05-29)

Backward-incompatible changes:

none

Deprecations:

  • Passing a loop argument to prometheus_async.aio.start_http_server() is a no-op and raises a DeprecationWarning now.

Changes:

  • Port to aiohttp’s application runner APIs to avoid those pesky deprecation warnings. As a consequence, the loop argument has been removed from internal APIs and became a no-op in public APIs.

Full changelog.

Credits

prometheus_async is written and maintained by Hynek Schlawack.

The development is kindly supported by Variomedia AG.

Other contributors can be found in GitHub’s overview.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

prometheus_async-18.2.0.tar.gz (27.1 kB view details)

Uploaded Source

Built Distribution

prometheus_async-18.2.0-py2.py3-none-any.whl (16.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file prometheus_async-18.2.0.tar.gz.

File metadata

File hashes

Hashes for prometheus_async-18.2.0.tar.gz
Algorithm Hash digest
SHA256 e7c16eda560d80fb0faa525dce23f5d917d7818b58a0492d87ba2a4473c6195d
MD5 6d88ce4daa0eda8959ae730527018c01
BLAKE2b-256 5c0bee1c0bfcf143b6efffaf7e0d07a7c6ec5b96e6b0407516bd7893a4be4ab8

See more details on using hashes here.

File details

Details for the file prometheus_async-18.2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for prometheus_async-18.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f34dcf486c5528b80463ab7b237b36925d36893a29f27db9fbf6353de2d57a25
MD5 d45d5e8d03a494e68fad887fa8091826
BLAKE2b-256 ff5794aaa8f5c1e68ee52d4a4c6b35dcbd3336d9e5ba50fb2e0ef45334c361f9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page