Metadata-Version: 2.1
Name: celery-redis-prometheus
Version: 1.1.1
Summary: Exports task execution metrics in Prometheus format
Home-page: https://github.com/zeitonline/celery_redis_prometheus
Author: Zeit Online
Author-email: zon-backend@zeit.de
License: BSD
Description: =======================
        celery_redis_prometheus
        =======================
        
        Exports task execution metrics in Prometheus format: how many tasks were started
        and have completed successfully or with failure, and how many tasks are still in
        the queues (supported only for broker redis).
        
        Inspired by https://gitlab.com/kalibrr/celery-prometheus
        
        
        Usage
        =====
        
        Start HTTP service
        ------------------
        
        Start the HTTP server like this::
        
          $ bin/celery prometheus --host=127.0.0.1 --port=9691
        
        
        
        Configure Prometheus
        --------------------
        
        ::
        
            scrape_configs:
              - job_name: 'celery'
                static_configs:
                  - targets: ['localhost:9691']
        
        
        We export the following metrics:
        
        * ``celery_tasks_total{state="started|succeeded|failed|retried"}``, counter
        * ``celery_task_queuetime_seconds``, histogram (only if ``task_send_sent_event`` is enabled in Celery) 
        * ``celery_task_runtime_seconds``, histogram
        
        If you pass ``--queuelength-interval=x`` then every x seconds the queue lengths will be checked (NOTE: this only works with redis as the broker), resulting in this additional metric:
        
        * ``celery_queue_length{queue="..."}``, gauge
        
        
        Run tests
        =========
        
        Using `tox`_ and `py.test`_. Maybe install ``tox`` (e.g. via ``pip install tox``)
        and then simply run ``tox``.
        
        .. _`tox`: http://tox.readthedocs.io/
        .. _`py.test`: http://pytest.org/
        
        
        celery_redis_prometheus changes
        ===============================
        
        1.1.1 (2020-03-20)
        ------------------
        
        - Fix py2 class syntax issues
        
        
        1.1.0 (2020-03-20)
        ------------------
        
        - Make py2 compatible.
        
        
        1.0.0 (2020-03-20)
        ------------------
        
        - Initial release
        
Platform: UNKNOWN
Provides-Extra: test
