https://github.com/APSL/kaneda

Configurable Python library for metrics collection
https://github.com/APSL/kaneda

async elasticsearch events metrics mongo

Last synced: 1 day ago
JSON representation

Configurable Python library for metrics collection

• Host: GitHub
• URL: https://github.com/APSL/kaneda
• Owner: APSL
• License: mit
• Created: 2016-05-03T18:37:30.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-07-25T21:52:19.000Z (about 6 years ago)
• Last Synced: 2024-04-15T00:26:45.465Z (4 months ago)
• Topics: async, elasticsearch, events, metrics, mongo
• Language: Python
• Homepage:
• Size: 75.2 KB
• Stars: 53
• Watchers: 6
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG
  • License: LICENSE.txt
  • Authors: AUTHORS.txt

Awesome Lists containing this project

• starred-awesome - kaneda - Configurable Python library for metrics and events reporting (Python)

README

        
Kaneda

======

.. image:: https://travis-ci.org/APSL/kaneda.svg?branch=master

    :target: https://travis-ci.org/APSL/kaneda

.. image:: https://readthedocs.org/projects/kaneda/badge/?version=latest

    :target: https://readthedocs.org/projects/kaneda/?badge=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:

.. code-block:: python

    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.