Codestin Search App

ssncferreira · 2026-01-08T20:10:22Z

Description

This PR implements extraction of metrics defined using the prometheus.NewDesc() pattern.

Changes

Add extractNewDescMetric() to extract metrics from prometheus.NewDesc() calls
Script generates an updated scripts/metricsdocgen/generated_metrics file

Related to: #13223

Disclosure: This PR was mainly developed with Claude Sonnet 4, with iterative review and refinement by @ssncferreira

ssncferreira · 2026-01-08T20:10:38Z

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

mtojek · 2026-01-09T12:21:19Z

+// Example:
+//   - "coderd_" + "api_" + "requests": "coderd_api_requests"
+//   - namespace + "_" + metricName: resolved concatenation
+func resolveBinaryExpr(expr *ast.BinaryExpr, decls declarations) string {


ugh... I trust you that it works the right way, although some tests would be helpful.

Agree, but unfortunately didn't have time for tests. Tthis is currently working as seen by the generated file: scripts/metricsdocgen/generated_metrics. But yes, tests would be great for future metric changes on the codebase.

github-actions · 2026-01-23T19:19:21Z

Task created: https://dev.coder.com/tasks/doc-check-bot/89c4be9d-ddb8-4d55-9f9f-93087c4b9ae5

coderagents · 2026-01-23T19:21:15Z

Documentation Check

No Changes Needed

This PR enhances the internal metrics scanner tool (scripts/metricsdocgen) to extract metrics from prometheus.NewDesc() patterns. The generated metrics file is used internally to auto-generate the metrics table in docs/admin/integrations/prometheus.md.

Since the PR updates the code generation tool (not user-facing features), and the generated metrics are already documented via the auto-generated table at lines 105-199 of docs/admin/integrations/prometheus.md, no documentation changes are needed.

The newly extracted metrics (pubsub, insights, license, and prebuilt workspace metrics) are already present in the generated table in the documentation.

Automated review via Coder Tasks

coderagents · 2026-01-28T09:02:24Z

Documentation Check

Previous Feedback

The previous review stated metrics were already documented, but this was inaccurate. The metrics will be documented when the stack completes.

No Changes Needed (for this PR)

This PR (#21461) is part of a stack that implements automatic metrics documentation generation:

feat(scripts/metricsdocgen): add prometheus.NewDesc() pattern to metrics scanner #21461 (this PR): Adds scanner support for prometheus.NewDesc() pattern
feat(scripts/metricsdocgen): add prometheus.New*() and New*Vec() patterns to metrics scanner #21462-feat(scripts/metricsdocgen): support merging static and generated metrics files #21464: Add support for other prometheus patterns
chore: integrate metrics scanner into Makefile #21465: Wires up Makefile to auto-generate docs from scanned metrics

The newly extracted metrics in scripts/metricsdocgen/generated_metrics include:

coder_pubsub_* (6 metrics)
coderd_insights_* (3 metrics)
coderd_license_* (3 metrics)
coderd_prebuilt_workspaces_* (11 metrics)

These metrics are not yet in the documentation because:

The current docs/admin/integrations/prometheus.md is generated from scripts/metricsdocgen/metrics (not generated_metrics)
PR chore: integrate metrics scanner into Makefile #21465 will update the Makefile to use the scanner output
Documentation will be auto-generated when make docs/admin/integrations/prometheus.md runs after the stack merges

No documentation changes needed in this PR - the infrastructure PR is working as designed. The documentation will be automatically updated by the build process once the full stack lands.

Automated review via Coder Tasks

ssncferreira · 2026-02-13T10:48:36Z

Merge activity

Feb 13, 10:48 AM UTC: A user started a stack merge that includes this pull request via Graphite.
Feb 13, 10:50 AM UTC: Graphite rebased this pull request as part of a merge.
Feb 13, 11:01 AM UTC: @ssncferreira merged this pull request with Graphite.

…ics scanner

github-actions Bot assigned ssncferreira Jan 8, 2026

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-core branch from 95bcc37 to c3053d7 Compare January 8, 2026 21:22

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-newdesc branch from f64fdaf to d2a562c Compare January 8, 2026 21:22

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-core branch from c3053d7 to c591965 Compare January 9, 2026 08:51

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-newdesc branch from d2a562c to 4340913 Compare January 9, 2026 08:51

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-core branch from c591965 to d253ee8 Compare January 9, 2026 08:52

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-newdesc branch 3 times, most recently from b52d9eb to 44b7bba Compare January 9, 2026 09:47

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-core branch 2 times, most recently from b487f0c to aee2d85 Compare January 9, 2026 10:37

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-newdesc branch 2 times, most recently from 70d2452 to a14ee38 Compare January 9, 2026 10:38

ssncferreira changed the title ~~feat(scripts): add prometheus.NewDesc() pattern to metrics scanner~~ feat(scripts/metricsdocgen): add prometheus.NewDesc() pattern to metrics scanner Jan 9, 2026

ssncferreira marked this pull request as ready for review January 9, 2026 11:32

mtojek approved these changes Jan 9, 2026

View reviewed changes

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-core branch from aee2d85 to b8b4331 Compare January 16, 2026 19:01

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-newdesc branch from a14ee38 to 7464012 Compare January 16, 2026 19:01

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-core branch from b8b4331 to c6638df Compare January 23, 2026 19:18

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-newdesc branch from 7464012 to 0462360 Compare January 23, 2026 19:18

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-core branch from c6638df to a370b3f Compare January 28, 2026 08:57

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-newdesc branch from 0462360 to 2caf0ad Compare January 28, 2026 08:57

github-actions Bot added the stale This issue is like stale bread. label Feb 5, 2026

ssncferreira removed the stale This issue is like stale bread. label Feb 6, 2026

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-core branch from a370b3f to ca70f52 Compare February 12, 2026 15:57

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-newdesc branch 3 times, most recently from 2b637bb to fd7a05c Compare February 12, 2026 16:58

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-core branch from 65dbf29 to 0f1be8c Compare February 12, 2026 16:58

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-newdesc branch from fd7a05c to a65ba82 Compare February 12, 2026 17:22

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-core branch from 0f1be8c to 1bdb883 Compare February 12, 2026 17:23

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-newdesc branch from a65ba82 to 1ada5a6 Compare February 12, 2026 17:23

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-core branch from 1bdb883 to f7f0213 Compare February 13, 2026 10:20

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-newdesc branch from 36ce1aa to 27c0d16 Compare February 13, 2026 10:20

mtojek approved these changes Feb 13, 2026

View reviewed changes

ssncferreira changed the base branch from ssncferreira/metricsdocgen-ast-scanner-core to graphite-base/21461 February 13, 2026 10:48

ssncferreira changed the base branch from graphite-base/21461 to main February 13, 2026 10:49

ssncferreira added 2 commits February 13, 2026 10:49

feat(scripts/metricsdocgen): add prometheus.NewDesc() pattern to metr…

e3139cd

…ics scanner

chore: improve comments and add logging

f0cb7f3

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-newdesc branch from 27c0d16 to f0cb7f3 Compare February 13, 2026 10:49

ssncferreira merged commit 45280d5 into main Feb 13, 2026
33 checks passed

ssncferreira deleted the ssncferreira/metricsdocgen-ast-scanner-newdesc branch February 13, 2026 11:01

github-actions Bot locked and limited conversation to collaborators Feb 13, 2026

Navigation Menu

Uh oh!

feat(scripts/metricsdocgen): add prometheus.NewDesc() pattern to metrics scanner - #21461

feat(scripts/metricsdocgen): add prometheus.NewDesc() pattern to metrics scanner#21461
ssncferreira merged 2 commits into
mainfrom
ssncferreira/metricsdocgen-ast-scanner-newdesc

ssncferreira commented Jan 8, 2026 •

edited

Loading

Uh oh!

ssncferreira commented Jan 8, 2026 •

edited

Loading

Uh oh!

mtojek Jan 9, 2026

Uh oh!

ssncferreira Feb 12, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jan 23, 2026

Uh oh!

coderagents Bot commented Jan 23, 2026

Uh oh!

coderagents Bot commented Jan 28, 2026

Uh oh!

ssncferreira commented Feb 13, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

ssncferreira commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

Uh oh!

ssncferreira commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mtojek Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

ssncferreira Feb 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jan 23, 2026

Uh oh!

coderagents Bot commented Jan 23, 2026

Documentation Check

No Changes Needed

Uh oh!

coderagents Bot commented Jan 28, 2026

Documentation Check

Previous Feedback

No Changes Needed (for this PR)

Uh oh!

ssncferreira commented Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ssncferreira commented Jan 8, 2026 •

edited

Loading

ssncferreira commented Jan 8, 2026 •

edited

Loading

ssncferreira Feb 12, 2026 •

edited

Loading

ssncferreira commented Feb 13, 2026 •

edited

Loading