Skip to content

Detect stale metrics registry entries in the metrics sync prek hook - #69578

Merged
Lee-W merged 1 commit into
apache:mainfrom
FrankYang0529:airflow-prek-metrics-hook
Jul 23, 2026
Merged

Detect stale metrics registry entries in the metrics sync prek hook#69578
Lee-W merged 1 commit into
apache:mainfrom
FrankYang0529:airflow-prek-metrics-hook

Conversation

@FrankYang0529

Copy link
Copy Markdown
Member

Why

  • check-metrics-synced-with-registry only checks one direction: a metric used in code but missing from metrics_template.yaml.
  • A registry entry no longer emitted anywhere was undetected.

How

  • The check scans all git-tracked non-test Python files (git ls-files). It checks any registry entry with no matching metric in code.
  • Add an INDIRECTLY_EMITTED_METRICS allowlist for the three executor.* gauges whose names are built via BaseExecutor._get_metric_name() and cannot be resolved statically.

Was generative AI tooling used to co-author this PR?
  • Yes - Claude Code

  • Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
  • For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

@FrankYang0529
FrankYang0529 force-pushed the airflow-prek-metrics-hook branch 3 times, most recently from a8e4b57 to 544fd7f Compare July 8, 2026 09:17
@FrankYang0529
FrankYang0529 marked this pull request as ready for review July 9, 2026 00:44
@FrankYang0529
FrankYang0529 force-pushed the airflow-prek-metrics-hook branch 2 times, most recently from 6ccdd7c to c0029d5 Compare July 9, 2026 06:10
@Lee-W

Lee-W commented Jul 16, 2026

Copy link
Copy Markdown
Member

let's rebase from main and resolve the conflicts. thanks!

@FrankYang0529
FrankYang0529 force-pushed the airflow-prek-metrics-hook branch from c0029d5 to a0ab7a3 Compare July 16, 2026 12:31
@FrankYang0529

Copy link
Copy Markdown
Member Author

let's rebase from main and resolve the conflicts. thanks!

Resolved it. Thanks.

Comment thread scripts/ci/prek/check_metrics_synced_with_the_registry.py Outdated
@Lee-W
Lee-W requested review from guan404ming and henry3260 July 21, 2026 14:33

@henry3260 henry3260 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall. looks good just 2 nits

Comment thread scripts/ci/prek/check_metrics_synced_with_the_registry.py
Signed-off-by: PoAn Yang <payang@apache.org>
@FrankYang0529
FrankYang0529 force-pushed the airflow-prek-metrics-hook branch from a0ab7a3 to 12c7e4a Compare July 23, 2026 00:59
@Lee-W
Lee-W merged commit f44634c into apache:main Jul 23, 2026
77 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

Backport failed to create: v3-3-test. View the failure log Run details

Note: As of Merging PRs targeted for Airflow 3.X
the committer who merges the PR is responsible for backporting the PRs that are bug fixes (generally speaking) to the maintenance branches.

In matter of doubt please ask in #release-management Slack channel.

Status Branch Result
v3-3-test Commit Link

You can attempt to backport this manually by running:

cherry_picker f44634c v3-3-test

This should apply the commit to the v3-3-test branch and leave the commit in conflict state marking
the files that need manual conflict resolution.

After you have resolved the conflicts, you can continue the backport process by running:

cherry_picker --continue

If you don't have cherry-picker installed, see the installation guide.

@FrankYang0529
FrankYang0529 deleted the airflow-prek-metrics-hook branch July 23, 2026 01:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants