Configurable Python library for metrics collection
Switch branches/tags
Clone or download
Latest commit 739db48 Jul 25, 2018

README.rst

Kaneda

https://travis-ci.org/APSL/kaneda.svg?branch=master https://readthedocs.org/projects/kaneda/badge/?version=latest

Kaneda is a Python library that allows to report events and metrics of your applications. It provides a several builtin metrics methods in order to store any amount of data that you want to then analyze it or for performance studies.

Usage

First of all, you need to install Kaneda package:

pip install kaneda

Then you need a backend in order to keep data in a persistent storage. The following example it shows how to send metrics with Elasticsearch as a backend:

from kaneda.backends import ElasticsearchBackend
from kaneda import Metrics

backend = ElasticsearchBackend(index_name='myindex', app_name='myapp', host='localhost',
                               port=9200, user='kaneda', password='kaneda')
metrics = Metrics(backend=backend)
metrics.gauge('answer_of_life', 42)

Features

  • Builtin metrics functions and custom metric reports.
  • Configurable reporting backends classes and asynchronous queue classes.
  • Builtin Elasticsearch, MongoDB, InfluxDB and RethinkDB backends.
  • Builtin Celery, RQ and ZMQ asynchronous queue classes.
  • Django support.

Documentation

Visit the documentation for an in-depth look at Kaneda.