Metadata-Version: 2.1
Name: airflow-exporter
Version: 1.2.0
Summary: Airflow plugin to export dag and task based metrics to Prometheus.
Home-page: https://github.com/epoch8/airflow-exporter
License: UNKNOWN
Description: # Airflow prometheus exporter
        
        Exposes dag and task based metrics from Airflow to a Prometheus compatible endpoint.
        
        ## Discussion
        
        You can ask questions in Gitter channel: https://gitter.im/epoch8/airflow-exporter
        
        ## Screenshots
        
        <img src="https://epoch8.github.io/media/2018/08/03/monitoring-airflow-with-prometheus/metrics_screenshot.png" height="400" width="600"/>
        
        ## Compatibility
        
        **Note: this version is compatible with Airflow 1.10.3+ only, see [#46](https://github.com/epoch8/airflow-exporter/issues/46) for details**
        
        For compatibility with previous versions of Airflow use older version: [v0.5.4](https://github.com/epoch8/airflow-exporter/releases/tag/v0.5.4)
        
        * Airflow: airflow1.10.3+
        * Python: python2, python3
        * DataBase: postgresql, mysql
        
        ## Install
        
        ```sh
        pip install airflow-exporter
        ```
        
        That's it. You're done.
        
        ## Exporting extra labels to Prometheus
        
        It is possible to add extra labels to DAG-related metrics by providing `labels` dict to DAG `params`.
        
        ### Example
        
        ```
        dag = DAG(
            'dummy_dag',
            schedule_interval=timedelta(hours=5),
            default_args=default_args,
            catchup=False,
            params={
                'labels': {
                    'env': 'test'
                }
            }
        )
        ```
        
        Label `env` with value `test` will be added to all metrics related to `dummy_dag`:
        
        `airflow_dag_status{dag_id="dummy_dag",env="test",owner="owner",status="running"} 12.0`
        
        ## Metrics
        
        Metrics will be available at 
        
        ```
        http://<your_airflow_host_and_port>/admin/metrics/
        ```
        
        ### `airflow_task_status`
        
        Labels:
        
        * `dag_id`
        * `task_id`
        * `owner`
        * `status`
        
        Value: number of tasks in specific status.
        
        ### `airflow_dag_status`
        
        Labels:
        
        * `dag_id`
        * `owner`
        * `status`
        
        Value: number of dags in specific status.
        
        ### `airflow_dag_run_duration`
        
        Labels:
        
        * `dag_id`: unique identifier for a given DAG
        
        Value: duration in seconds of the longest DAG Run for given DAG. This metric 
        is not available for DAGs that have already completed.
        
        ## License
        
        Distributed under the BSD license. See [LICENSE](LICENSE) for more
        information.
        
Keywords: airflow plugin prometheus exporter metrics
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: System Administrators
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: System :: Monitoring
Description-Content-Type: text/markdown
