Thanks to visit codestin.com
Credit goes to github.com

Skip to content

chore: integrate metrics scanner into Makefile - #21465

Merged
ssncferreira merged 2 commits into
mainfrom
ssncferreira/metricsdocgen-makefile
Feb 13, 2026
Merged

chore: integrate metrics scanner into Makefile#21465
ssncferreira merged 2 commits into
mainfrom
ssncferreira/metricsdocgen-makefile

Conversation

@ssncferreira

@ssncferreira ssncferreira commented Jan 8, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

This PR wires up the metrics scanner in the Makefile to automatically regenerate metrics documentation when source files change.

Changes

  • Add Makefile target scripts/metricsdocgen/generated_metrics to run the AST scanner to generate the metrics file
  • Update docs/admin/integrations/prometheus.md Makefile target to depend on scripts/metricsdocgen/generated_metrics
  • Add scripts/metricsdocgen/README.md documenting the metrics generation process

Closes: #13223

This was referenced Jan 8, 2026
Merged
Merged
Merged
Merged
@ssncferreira Graphite App

ssncferreira commented Jan 8, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@ssncferreira ssncferreira mentioned this pull request Jan 8, 2026
Merged
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch from efcae85 to 9cea937 Compare January 8, 2026 21:22
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch from 290834d to c5a36c6 Compare January 8, 2026 21:22
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch from 9cea937 to 69a76c5 Compare January 8, 2026 21:26
@ssncferreira ssncferreira changed the title chore(scripts): integrate metrics scanner into Makefile chore: integrate metrics scanner into Makefile Jan 8, 2026
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch from 69a76c5 to f5bb336 Compare January 9, 2026 08:51
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch from c5a36c6 to 0a2e6a5 Compare January 9, 2026 08:51
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch from f5bb336 to 6e7325e Compare January 9, 2026 08:52
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch from 0a2e6a5 to 0b325ff Compare January 9, 2026 08:52
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch from 6e7325e to ce0cf82 Compare January 9, 2026 09:29
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch 2 times, most recently from 3ee81f5 to d39d62e Compare January 9, 2026 09:42
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch 2 times, most recently from c35af63 to 081d6cb Compare January 9, 2026 09:47
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch from d39d62e to 316234e Compare January 9, 2026 09:47
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch from 081d6cb to da989c4 Compare January 9, 2026 10:04
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch from 316234e to 07b917e Compare January 9, 2026 10:04
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch 3 times, most recently from 4fd8f5f to e53704d Compare January 9, 2026 10:33
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch from 07b917e to b43e7ff Compare January 9, 2026 10:37
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch 2 times, most recently from a21310d to e7264ea Compare January 9, 2026 10:38
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch from b43e7ff to fbec171 Compare January 9, 2026 10:38
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch from d67486c to 23bfddf Compare January 28, 2026 08:57
@github-actions github-actions Bot added the stale This issue is like stale bread. label Feb 5, 2026
@ssncferreira ssncferreira removed the stale This issue is like stale bread. label Feb 6, 2026
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch from 23bfddf to f1c07cf Compare February 12, 2026 15:57
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch 2 times, most recently from b609802 to 82c7fb5 Compare February 12, 2026 16:52
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch from f1c07cf to aeba418 Compare February 12, 2026 16:52
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch from 82c7fb5 to ad48a45 Compare February 12, 2026 16:58
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch from aeba418 to 622c232 Compare February 12, 2026 16:58
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch from ad48a45 to b898655 Compare February 12, 2026 17:22
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch 2 times, most recently from 1fba71b to b5fdd68 Compare February 12, 2026 17:23
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch 2 times, most recently from b85baf7 to 2d2f70c Compare February 12, 2026 17:54
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch 2 times, most recently from 16db381 to f4acd97 Compare February 12, 2026 18:33
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch 2 times, most recently from 940cfab to fac40a0 Compare February 12, 2026 18:41
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch from f4acd97 to 7e10dcf Compare February 12, 2026 18:41
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch from fac40a0 to 6825455 Compare February 12, 2026 18:43
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch from 7e10dcf to 65028be Compare February 12, 2026 18:43
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch from 6825455 to 00b7efe Compare February 12, 2026 18:51
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-merge-metrics-files branch from 65028be to a565c91 Compare February 12, 2026 18:51
@ssncferreira
ssncferreira force-pushed the ssncferreira/metricsdocgen-makefile branch 2 times, most recently from aa4cca8 to bf950df Compare February 12, 2026 20:17
dannykopping
dannykopping approved these changes Feb 13, 2026
View reviewed changes

@dannykopping dannykopping 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.

💪 very cool!

@coderagents

coderagents Bot commented Feb 13, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Documentation Check

Updates Needed

  • docs/about/contributing/backend.md - Add section in "Recipes" documenting metrics documentation generation workflow
    • Add a subsection similar to "Adding database migrations and fixtures"
    • Explain when metrics docs need regeneration (after adding/modifying Prometheus metrics)
    • Reference the command: make docs/admin/integrations/prometheus.md
    • Link to scripts/metricsdocgen/README.md for technical details
    • Note: The README.md was added in this PR ✓, but backend.md needs to reference it for discoverability

Context

This PR adds comprehensive documentation in scripts/metricsdocgen/README.md explaining how the metrics generation system works. However, backend contributors need to discover this workflow when they add or modify metrics. The backend contributing guide should mention this in its "Recipes" section (similar to how it documents database migrations) so contributors know when and how to regenerate metrics documentation.

Automated review via Coder Tasks

@ssncferreira Graphite App

ssncferreira commented Feb 13, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Merge activity

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@mtojek mtojek mtojek left review comments
@dannykopping dannykopping dannykopping approved these changes

Assignees

@ssncferreira ssncferreira

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

docs: generate admin/prometheus.md dynamically

3 participants

@ssncferreira @dannykopping @mtojek