Skip to main content

Library for aggregating metrics from the Prometheus monitoring system's python client library.

Project description

# Prometheus Roller
[![Build Status](https://travis-ci.org/turtlemonvh/prometheus_python_roller.png?branch=master)](https://travis-ci.org/turtlemonvh/prometheus_python_roller)
[![PyPI version](https://img.shields.io/pypi/v/prometheus_roller.svg)](https://pypi.python.org/pypi/prometheus_roller)
[![Downloads](http://img.shields.io/pypi/dm/prometheus_roller.svg)](https://pypi.python.org/pypi/prometheus_roller)
[![Python versions](https://img.shields.io/pypi/pyversions/prometheus_roller.svg)](https://pypi.python.org/pypi/prometheus_roller)
[![License](https://img.shields.io/pypi/l/prometheus_roller.svg)](https://pypi.python.org/pypi/prometheus_roller)


This is a small helper utility for creating time-boxed rollups for histogram and counter metrics created using the [prometheus python client](https://github.com/prometheus/client_python).

Metrics like counters and histograms increase indefinitely, but you usually care about recent activity. This library provides a way to turn a counter or histogram into a gauge or set of gauges that give instantaneous measures of the state of the application.

This isn't very useful if you're using [the prometheus server](https://github.com/prometheus/prometheus) since it provides [functions to do that for you](https://prometheus.io/docs/querying/functions/), but if you are sending metrics to multiple places (e.g. [check_mk](https://mathias-kettner.de/checkmk_localchecks.html)) and you want to send those metrics in a form that make basic alerting and reporting easier, this may help.

## Usage

```python
from prometheus_client import Histogram, Counter
from prometheus_roller import HistogramRoller, CounterRoller, start_update_daemon

# Create a histogram
h = Histogram('test_value', 'Testing roller')

# Create a counter
c = Counter('test_counted_value', 'Testing roller')

# Create a roller for the histogram, which calculates windowed values.
# By default it will create a gauge with a label for each histogram bin.
# The value of each gauge will be the change in value over the last 5 minutes, updated every 5 seconds.
# See the `options` parameter for more configuration options.
rh = HistogramRoller(h)

# Create a roller for the counter, which calculates windowed values.
# The value of each gauge will be the change in value over the last 5 minutes, updated every 5 seconds.
# See the `options` parameter for more configuration options.
rc = CounterRoller(c)

# Launch a daemon thread tracking and updating all roller objects.
# See the code for more options for configuring this update process.
start_update_daemon()
```

## Installation

```bash
# Install with pip
pip install prometheus_roller

# To install as editable to work on it
pip install -e git+https://github.com/turtlemonvh/prometheus_python_roller.git#egg=prometheus_python_roller
# OR
git clone git@github.com:turtlemonvh/prometheus_python_roller.git prometheus-roller
cd prometheus-roller
python setup.py develop
```

## Running tests

```bash
# Plain old python
python -m unittest discover

# If you have nose and coverage installed
nosetests --with-cover
```

## TODO

* Add IQR reducer

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_roller-0.0.2.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

prometheus_roller-0.0.2-py2.py3-none-any.whl (8.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file prometheus_roller-0.0.2.tar.gz.

File metadata

File hashes

Hashes for prometheus_roller-0.0.2.tar.gz
Algorithm Hash digest
SHA256 2aed11873c7b2bef7882fd6f6bc86c09aa8ddeff59c82ec102e07fe475e416d6
MD5 050c36af795b1bfabcbd26688de0cdb8
BLAKE2b-256 37f637dcf601f38d3a8fa51374359facc63a599629e88226a57d85f54147d21c

See more details on using hashes here.

File details

Details for the file prometheus_roller-0.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for prometheus_roller-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 92329c4b91052c0c3b7f298202ee06fef8f425e07424f4c4388ea7b3222b1ef1
MD5 97dbfb8338ab88418a4a61cf9802b756
BLAKE2b-256 302647e130ba9bce65fe717076b61d43117958b0fe356cbfb7ec554133c930f9

See more details on using hashes here.

Supported by

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