rafidka opened a new issue #10091:
URL: https://github.com/apache/airflow/issues/10091


   <!--
   
   Welcome to Apache Airflow!  For a smooth issue process, try to answer the 
following questions.
   Don't worry if they're not all applicable; just try to include what you can 
:-)
   
   If you need to include code snippets or logs, please put them in fenced code
   blocks.  If they're super-long, please use the details tag like
   <details><summary>super-long log</summary> lots of stuff </details>
   
   Please delete these comment blocks before submitting the issue.
   
   -->
   
   <!--
   
   IMPORTANT!!!
   
   PLEASE CHECK "SIMILAR TO X EXISTING ISSUES" OPTION IF VISIBLE
   NEXT TO "SUBMIT NEW ISSUE" BUTTON!!!
   
   PLEASE CHECK IF THIS ISSUE HAS BEEN REPORTED PREVIOUSLY USING SEARCH!!!
   
   Please complete the next sections or the issue will be closed.
   This questions are the first thing we need to know to understand the context.
   
   -->
   
   **Apache Airflow version**:
   
   N/A
   
   **Kubernetes version (if you are using kubernetes)** (use `kubectl version`):
   
   N/A
   
   **Environment**:
   
   N/A
   
   - **Cloud provider or hardware configuration**:
   - **OS** (e.g. from /etc/os-release):
   - **Kernel** (e.g. `uname -a`):
   - **Install tools**:
   - **Others**:
   
   **What happened**:
   
   By inspecting the code of Airflow (1.10.11rc2, though I believe previous 
versions apply as well), I noticed the [metrics documentation 
page](https://airflow.apache.org/docs/stable/metrics.html) misses the following 
metrics:
   
   - *{job_name}*_heartbeat_failure
   - dag_file_refresh_error
   - scheduler.tasks.executable
   - scheduler.tasks.pending
   - scheduler.tasks.running
   - scheduler.tasks.starving
   - scheduler.tasks.without_dagrun
   - task_removed_from_dag.{dag_id}
   - task_restored_to_dag.{dag_id}
   - task_instance_created-*{operator_name}*
   
   Any reason why these are not documented?
   
   Additionally, the following metrics are incorrectly documented:
   
   - dag_processing.processor_timeouts: documented as a guage but it is 
actually a counter
   - dag_processing.last_runtime.*{dag_filename}*: documented as a gauge but it 
is actually a timer
   
   **What you expected to happen**:
   
   - The Metrics page should document all metrics being emitted by Airflow.
   - The Metrics page should correctly document the type of the metric.
   
   **How to reproduce it**:
   <!---
   
   As minimally and precisely as possible. Keep in mind we do not have access 
to your cluster or dags.
   
   If you are using kubernetes, please attempt to recreate the issue using 
minikube or kind.
   
   ## Install minikube/kind
   
   - Minikube https://minikube.sigs.k8s.io/docs/start/
   - Kind https://kind.sigs.k8s.io/docs/user/quick-start/
   
   If this is a UI bug, please provide a screenshot of the bug or a link to a 
youtube video of the bug in action
   
   You can include images using the .md sytle of
   ![alt text](http://url/to/img.png)
   
   To record a screencast, mac users can use QuickTime and then create an 
unlisted youtube video with the resulting .mov file.
   
   --->
   
   - Clone the latest Airflow 1.x code base.
   - Search the code base for `Stats.`, i.e. lines that publish metrics using 
the `Stats` object.
   - Compare the result with [Metrics 
page](https://airflow.apache.org/docs/stable/metrics.html) in Airflow 
documentation.
   
   **Anything else we need to know**:
   
   <!--
   
   How often does this problem occur? Once? Every time etc?
   
   Any relevant logs to include? Put them here in side a detail tag:
   <details><summary>x.log</summary> lots of stuff </details>
   
   -->
   
   I am happy to send a PR to update the documentation.
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to