Skip to main content

Aiogram Based Metrics Collection for Prometheus

Project description

Aiogram Prometheus Collector

Aiogram Based Metrics Collection for Prometheus

PyPI PyPI - Python Version Docs

Downloads GitLab stars GitLab last commit

Functionality

  • Monitoring the status of bots and dispatchers
  • Middleware for monitoring the bot's network activity
  • Middleware for monitoring the event handler performance

example

Installation

pip install aiogram-prometheus

Quick start

  • aiogram_prometheus.PrometheusWrapperStorage - Collecting storage usage metrics
  • aiogram_prometheus.PrometheusUpdatesMiddleware - Collecting information about dispatcher updates
import os

import aiogram
from aiogram import Bot, Dispatcher
from aiogram.fsm.storage.memory import MemoryStorage

from aiogram_prometheus import PrometheusUpdatesMiddleware, PrometheusWrapperStorage

bot = Bot(os.environ['ENV_TG_BOT'])

dp = Dispatcher(storage=PrometheusWrapperStorage(MemoryStorage()))
dp.update.middleware(PrometheusUpdatesMiddleware())

if __name__ == '__main__':
    asyncio.run(dp.start_polling(bot))

Classes

aiogram_prometheus.PrometheusWrapperStorage

A wrapper around any storage you use that will collect usage metrics

from aiogram import Bot, Dispatcher
from aiogram.fsm.storage.memory import MemoryStorage

from aiogram_prometheus import PrometheusWrapperStorage

dp = Dispatcher(storage=PrometheusWrapperStorage(MemoryStorage()))

aiogram_prometheus.PrometheusUpdatesMiddleware

Intermediate layer for collecting metrics of updates processing

from aiogram import Dispatcher
from aiogram_prometheus import PrometheusUpdatesMiddleware

dp = Dispatcher()
dp.update.middleware(PrometheusUpdatesMiddleware())

Contribute

Issue Tracker: https://gitlab.com/rocshers/python/aiogram-prometheus/-/issues
Source Code: https://gitlab.com/rocshers/python/aiogram-prometheus

Before adding changes:

make install-dev

After changes:

make format test

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

aiogram_prometheus-0.3.0.tar.gz (6.1 kB view hashes)

Uploaded Source

Built Distribution

aiogram_prometheus-0.3.0-py3-none-any.whl (8.1 kB view hashes)

Uploaded Python 3

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