Metadata-Version: 2.1
Name: airflow_prometheus_exporter
Version: 1.0.1
Summary: Prometheus Exporter for Airflow Metrics
Home-page: https://github.com/robinhood/airflow_prometheus_exporter
Author: Robinhood Markets, Inc.
Author-email: open-source@robinhood.com
License: BSD 3-Clause
Description: # Airflow Prometheus Exporter
        
        The Airflow Prometheus Exporter exposes various metrics about the Scheduler, DAGs and Tasks which helps improve the observability of an Airflow cluster.
        
        The exporter is based on this [prometheus exporter for Airflow](https://github.com/epoch8/airflow-exporter).
        
        ## Requirements
        
        The plugin has been tested with:
        
        - Airflow >= 1.10.4
        - Python 3.6+
        
        The scheduler metrics assume that there is a DAG named `canary_dag`. In our setup, the `canary_dag` is a DAG which has a tasks which perform very simple actions such as establishing database connections. This DAG is used to test the uptime of the Airflow scheduler itself.
        
        ## Installation
        
        The exporter can be installed as an Airflow Plugin using:
        
        ```pip install airflow-prometheus-exporter```
        
        This should ideally be installed in your Airflow virtualenv.
        
        ## Metrics
        
        Metrics will be available at
        
        `http://<your_airflow_host_and_port>/admin/metrics/`
        
        ### Task Specific Metrics
        
        #### `airflow_task_status`
        
        Number of tasks with a specific status.
        
        All the possible states are listed [here](https://github.com/apache/airflow/blob/master/airflow/utils/state.py#L46).
        
        #### `airflow_task_duration`
        
        Duration of successful tasks in seconds.
        
        #### `airflow_task_fail_count`
        
        Number of times a particular task has failed.
        
        ### Dag Specific Metrics
        
        #### `airflow_dag_status`
        
        Number of DAGs with a specific status.
        
        All the possible states are listed [here](https://github.com/apache/airflow/blob/master/airflow/utils/state.py#L59)
        
        #### `airflow_dag_run_duration`
        Duration of successful DagRun in seconds.
        
        ### Scheduler Metrics
        
        #### `airflow_dag_scheduler_delay`
        
        Scheduling delay for a DAG Run in seconds. This metric assumes there is a `canary_dag`.
        
        The scheduling delay is measured as the delay between when a DAG is marked as `SCHEDULED` and when it actually starts `RUNNING`.
        
        #### `airflow_task_scheduler_delay`
        
        Scheduling delay for a Task in seconds. This metric assumes there is a `canary_dag`.
        
        #### `airflow_num_queued_tasks`
        
        Number of tasks in the `QUEUED` state at any given instance.
        
Keywords: airflow_prometheus_exporter
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
