[jira] [Commented] (AIRFLOW-3380) Metrics documentation

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/AIRFLOW-3380?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16695020#comment-16695020
 ] 

ASF GitHub Bot commented on AIRFLOW-3380:
-

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 00..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 
`__:
+
+.. code-block:: bash
+
+[scheduler]
+statsd_on = True
+statsd_host = localhost
+statsd_port = 8125
+statsd_prefix = airflow
+
+Counters
+
+
+=== 

+NameDescription
+=== 

+_startNumber of started  job, ex. 
SchedulerJob, LocalTaskJob
+_end  Number of ended  job, ex. 
SchedulerJob, LocalTaskJob
+operator_failures_   Operator  failures
+operator_successes_  Operator  successes
+ti_failures Overall task instances failures
+ti_successesOverall 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.  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:
us...@infra.apache.org


> Metrics documentation
> -
>
> Key: AIRFLOW-3380
> URL: https://issues.apache.org/jira/browse/AIRFLOW-3380
> Project: Apache Airflow
>  Issue Type: Improvement
>  Components: Documentation
>Reporter: Bartosz Ługowski
>Assignee: Bartosz Ługowski
>Priority: Trivial
>
> At the moment there is no documentation about Airflow metrics:
>  * how to enable it
>  * which metrics are generated
>  * description of each metric



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

[jira] [Commented] (AIRFLOW-3380) Metrics documentation

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/AIRFLOW-3380?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16694507#comment-16694507
 ] 

ASF GitHub Bot commented on AIRFLOW-3380:
-

blugowski opened a new pull request #4219: [AIRFLOW-3380] Metrics documentation
URL: https://github.com/apache/incubator-airflow/pull/4219
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [x] My PR addresses the following [Airflow 
Jira](https://issues.apache.org/jira/browse/AIRFLOW-3380) issues and references 
them in the PR title.
   
   ### Description
   
   - [x] Here are some details about my PR, including screenshots of any UI 
changes:
   
   This PR adds metrics documenation:
   * how to enable metrics
   * list of generated metrics
   * description of each metric
   
   ### Tests
   
   - [x] My PR adds the following unit tests __OR__ does not need testing for 
this extremely good reason:
   
   Changes in documenation.
   
   ### Commits
   
   - [x] My commits all reference Jira issues in their subject lines, and I 
have squashed multiple commits if they address the same issue. In addition, my 
commits follow the guidelines from "[How to write a good git commit 
message](http://chris.beams.io/posts/git-commit/)":
 1. Subject is separated from body by a blank line
 1. Subject is limited to 50 characters (not including Jira issue reference)
 1. Subject does not end with a period
 1. Subject uses the imperative mood ("add", not "adding")
 1. Body wraps at 72 characters
 1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [x] In case of new functionality, my PR adds documentation that describes 
how to use it.
 - When adding new operators/hooks/sensors, the autoclass documentation 
generation needs to be added.
   
   ### Code Quality
   
   - [x] Passes `flake8`
   


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:
us...@infra.apache.org


> Metrics documentation
> -
>
> Key: AIRFLOW-3380
> URL: https://issues.apache.org/jira/browse/AIRFLOW-3380
> Project: Apache Airflow
>  Issue Type: Improvement
>  Components: Documentation
>Reporter: Bartosz Ługowski
>Assignee: Bartosz Ługowski
>Priority: Trivial
>
> At the moment there is no documentation about Airflow metrics:
>  * how to enable it
>  * which metrics are generated
>  * description of each metric



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)