feat(scripts/metricsdocgen): add AST scanner core for metrics doc generation - #21460
Merged
Merged
Conversation
Contributor
Author
ssncferreira
force-pushed
the
ssncferreira/metricsdocgen-ast-scanner-core
branch
from
January 8, 2026 19:58
53b26d8 to
95bcc37
Compare
This was referenced Jan 8, 2026
Merged
ssncferreira
force-pushed
the
ssncferreira/metricsdocgen-ast-scanner-core
branch
5 times, most recently
from
January 9, 2026 10:37
b487f0c to
aee2d85
Compare
ssncferreira
marked this pull request as ready for review
January 9, 2026 11:32
mtojek
approved these changes
Jan 9, 2026
mtojek
left a comment
Member
There was a problem hiding this comment.
Nothing blocking, looking forward to next PR :)
Comment on lines
+27
to
+32
| var scanDirs = []string{ | ||
| "agent", | ||
| "coderd", | ||
| "enterprise", | ||
| "provisionerd", | ||
| } |
Member
There was a problem hiding this comment.
nit: alternative approach .metricsignore file :)
Contributor
Author
There was a problem hiding this comment.
This might be a good idea for the future, we can revisit this if needed 👍
| } | ||
|
|
||
| // scanFile parses a single Go file and extracts all Prometheus metric definitions. | ||
| func scanFile(path string) ([]Metric, error) { |
Member
There was a problem hiding this comment.
Future: We could add some smoke tests to prevent accidental AST logic changes.
Contributor
Author
There was a problem hiding this comment.
Yes, this is missing testing. This is something we need to address in the future 👍
ssncferreira
force-pushed
the
ssncferreira/metricsdocgen-ast-scanner-core
branch
from
January 16, 2026 19:01
aee2d85 to
b8b4331
Compare
ssncferreira
force-pushed
the
ssncferreira/metricsdocgen-ast-scanner-core
branch
from
January 23, 2026 19:18
b8b4331 to
c6638df
Compare
Contributor
ssncferreira
force-pushed
the
ssncferreira/metricsdocgen-ast-scanner-core
branch
from
January 28, 2026 08:57
c6638df to
a370b3f
Compare
Contributor
Documentation CheckNo Changes NeededThis PR adds foundational scanner infrastructure with placeholder implementations. The actual metric extraction logic ( No documentation changes are required because:
Automated review via Coder Tasks |
ssncferreira
force-pushed
the
ssncferreira/metricsdocgen-ast-scanner-core
branch
3 times, most recently
from
February 12, 2026 17:23
0f1be8c to
1bdb883
Compare
ssncferreira
force-pushed
the
ssncferreira/metricsdocgen-ast-scanner-core
branch
from
February 13, 2026 10:20
1bdb883 to
f7f0213
Compare
mtojek
approved these changes
Feb 13, 2026
Contributor
Author
Merge activity
|
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
2 participants
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.
Description
This PR adds an AST-based scanner to automatically generate Prometheus metrics documentation from the coder source code.
Changes
scripts/metricsdocgen/scanner/scanner.gowith:agent/,coderd/,enterprise/,provisionerd/*_test.gofiles)Metric.String()for Prometheus text exposition format renderingwriteMetrics()to output metrics to stdoutextractMetricFromCall()(implemented in subsequent PRs)scripts/metricsdocgen/generated_metricsplaceholder (populated by subsequent PRs)Note: To facilitate the review process, this was separated into scoped stacked PRs. The division was based on the main structure, the different Prometheus patterns currently present in the codebase, and updates to the build process.
Related to: #13223
Disclosure: This PR was mainly developed with Claude Sonnet 4, with iterative review and refinement by @ssncferreira