airflow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] feng-tao closed pull request #4219: [AIRFLOW-3380] Metrics documentation
Date Wed, 21 Nov 2018 17:44:44 GMT
feng-tao closed pull request #4219: [AIRFLOW-3380] Metrics documentation
URL: https://github.com/apache/incubator-airflow/pull/4219
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/docs/index.rst b/docs/index.rst
index 4c18ce5ce6..efd0a8b78d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -103,6 +103,7 @@ Content
     timezone
     api
     integration
+    metrics
     lineage
     faq
     code
diff --git a/docs/metrics.rst b/docs/metrics.rst
new file mode 100644
index 0000000000..29819c03e6
--- /dev/null
+++ b/docs/metrics.rst
@@ -0,0 +1,67 @@
+..  Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+..    http://www.apache.org/licenses/LICENSE-2.0
+
+..  Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Metrics
+=======
+
+Configuration
+-------------
+Airflow can be set up to send metrics to `StatsD <https://github.com/etsy/statsd>`__:
+
+.. code-block:: bash
+
+    [scheduler]
+    statsd_on = True
+    statsd_host = localhost
+    statsd_port = 8125
+    statsd_prefix = airflow
+
+Counters
+--------
+
+=================================== ================================================================
+Name                                Description
+=================================== ================================================================
+<job_name>_start                    Number of started <job_name> job, ex. SchedulerJob,
LocalTaskJob
+<job_name>_end                      Number of ended <job_name> job, ex. SchedulerJob,
LocalTaskJob
+operator_failures_<operator_name>   Operator <operator_name> failures
+operator_successes_<operator_name>  Operator <operator_name> successes
+ti_failures                         Overall task instances failures
+ti_successes                        Overall task instances successes
+zombies_killed                      Zombie tasks killed
+scheduler_heartbeat                 Scheduler heartbeats
+=================================== ================================================================
+
+Gauges
+------
+
+===================== =====================================
+Name                  Description
+===================== =====================================
+collect_dags          Seconds taken to scan and import DAGs
+dagbag_import_errors  DAG import errors
+dagbag_size           DAG bag size
+===================== =====================================
+
+Timers
+------
+
+================================= =======================================
+Name                              Description
+================================= =======================================
+dagrun.dependency-check.<dag_id>  Seconds taken to check DAG dependencies
+================================= =======================================


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message