Add metrics manifest for dashboard and rule change tracking#367
Open
Add metrics manifest for dashboard and rule change tracking#367
Conversation
Adds a generated metrics-manifest.yaml that lists all metric names from Grafana dashboards and PrometheusRule CRDs. Changes to this file in PRs signal that the customer-facing metrics glossary in unionai-docs may need updating. - scripts/extract-metrics.py: extracts metrics from dashboard JSON and PrometheusRule templates - make generate-metrics-manifest: regeneration target - CLAUDE.md: instructions for maintaining the glossary Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
Current Aviator status
This pull request is currently open (not queued). How to mergeTo merge this PR, comment
See the real-time status of this PR on the
Aviator webapp.
Use the Aviator Chrome Extension
to see the status of your PR within GitHub.
|
xjerod
approved these changes
May 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
metrics-manifest.yaml— an auto-generated list of all metric names from shipped Grafana dashboards and PrometheusRule CRDsscripts/extract-metrics.pyto extract metrics from dashboard JSON and PrometheusRule templatesmake generate-metrics-manifesttargetCLAUDE.mdwith instructions for maintaining the metrics glossaryWhy
When dashboard panels or PrometheusRules change (metrics added, removed, renamed), the customer-facing metrics glossary in unionai-docs needs to be updated. Today there's no signal in PRs that this is needed.
The manifest makes metric changes visible in PR diffs, so Copilot and reviewers can flag when docs updates are needed.
How it works
scripts/extract-metrics.pyparses dashboard JSONexprfields and PrometheusRulerecord:/alert:/expr:blocksmake generate-metrics-manifestand commits the diffTest plan
make generate-metrics-manifestproduces clean output🤖 Generated with Claude Code