dannyl1u opened a new pull request, #43618: URL: https://github.com/apache/airflow/pull/43618
Metrics Improvement Project: #42881 After https://github.com/apache/airflow/pull/43340 is merged, we can check in the `get_name` function that the `metric_name` exists in the metrics-registry.yaml file, and throw an error if it doesn't. This will enforce that the `metrics-registry.yaml` exists as a single source of truth for all metrics names. The metrics names from https://airflow.apache.org/docs/apache-airflow/stable/administration-and-deployment/logging-monitoring/metrics.html# will be generated from the `metrics-registry.yaml` file, ensuring that the documentation for metrics names is always up-to-date. The following bash script was used to grep all metric names from the codebase, excluding files ignored by git and tests. ```bash git ls-files | grep -vE '^tests/|^tests_common/' | xargs -I {} grep -oE '\.(incr|decr|gauge|timer|timing)\("([^"]+)"' "{}" | awk -F'"' '{ type = ($1 ~ /\.incr|\.decr/) ? "counter" : ($1 ~ /\.gauge/) ? "gauge" : "timer"; print "- name: "$2"\n type: "type"\n description: \"\"" }' > metrics-registry.yaml ``` TODOs: - populate description fields from documentation - cross reference `metrics-registry.yaml` with documentation to ensure no metrics were missed during the initial grep - implement existence check when a metric name is used, blocked by #42881 <!-- 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. --> <!-- Thank you for contributing! Please make sure that your code changes are covered with tests. And in case of new features or big changes remember to adjust the documentation. Feel free to ping committers for the review! In case of an existing issue, reference it using one of the following: closes: #ISSUE related: #ISSUE How to write a good git commit message: http://chris.beams.io/posts/git-commit/ --> <!-- Please keep an empty line above the dashes. --> --- **^ Add meaningful description above** Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information. In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed. In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x). In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [newsfragments](https://github.com/apache/airflow/tree/main/newsfragments). -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
