Codestin Search App

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

Description

This PR implements extraction of metrics defined using prometheus.New*() and prometheus.New*Vec() patterns with *Opts{} structs.

Changes

Add extractOptsMetric() to handle:
- prometheus.NewGauge(prometheus.GaugeOpts{...})
- prometheus.NewCounter(prometheus.CounterOpts{...})
- prometheus.NewHistogram(prometheus.HistogramOpts{...})
- prometheus.NewSummary(prometheus.SummaryOpts{...})
- prometheus.New*Vec(prometheus.*Opts{...}, labels)
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:29:40Z

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

ssncferreira · 2026-01-09T10:01:05Z

@@ -1,21 +1,147 @@
+# HELP agent_reconnecting_pty_connections_total 


There are some metrics without a HELP definition (description). This indicates that those metrics should be updated in the source code, but that's out of scope for this PR.

As a follow-up, the scanner should probably warn about these metrics and exclude them from the generated_metrics file, since their descriptions would appear empty in the final documentation. Wdyt?

Added a warning log in scanFile when a metric has an empty HELP description. The metric is still included in the output for now. Added a TODO to consider filtering them out in a future PR.

SGTM.

out of curiosity: how many metrics without HELP do we have? maybe we can fix them here, and agree to fail fast when HELP is missing

2026/02/13 10:36:42 WARNING: metric "agent_scripts_executed_total" has no HELP description, skipping 2026/02/13 10:36:42 WARNING: metric "agent_ssh_server_failed_connections_total" has no HELP description, skipping 2026/02/13 10:36:42 WARNING: metric "agent_ssh_server_sftp_connections_total" has no HELP description, skipping 2026/02/13 10:36:42 WARNING: metric "agent_ssh_server_sftp_server_errors_total" has no HELP description, skipping 2026/02/13 10:36:42 WARNING: metric "agent_x11_handler_errors_total" has no HELP description, skipping 2026/02/13 10:36:42 WARNING: metric "agent_sessions_total" has no HELP description, skipping 2026/02/13 10:36:42 WARNING: metric "agent_sessions_errors_total" has no HELP description, skipping 2026/02/13 10:36:42 WARNING: metric "agent_reconnecting_pty_connections_total" has no HELP description, skipping 2026/02/13 10:36:42 WARNING: metric "agent_reconnecting_pty_errors_total" has no HELP description, skipping 2026/02/13 10:36:42 WARNING: metric "coderd_notifications_dispatch_attempts_total" has no HELP description, skipping

We have 10 metrics without HELP. The script already logs a warning for these cases. The last one uses fmt.Sprintf for the description, which the scanner cannot evaluate at compile time. We can address this in a follow-up PR 👍

mtojek · 2026-01-09T12:23:26Z

+// extractOptsMetric extracts a metric from prometheus.New*() or prometheus.New*Vec() calls.
+// Supported patterns:
+//   - prometheus.NewGauge(prometheus.GaugeOpts{...})
+//   - prometheus.NewCounter(prometheus.CounterOpts{...})
+//   - prometheus.NewHistogram(prometheus.HistogramOpts{...})
+//   - prometheus.NewSummary(prometheus.SummaryOpts{...})
+//   - prometheus.NewGaugeVec(prometheus.GaugeOpts{...}, labels)
+//   - prometheus.NewCounterVec(prometheus.CounterOpts{...}, labels)
+//   - prometheus.NewHistogramVec(prometheus.HistogramOpts{...}, labels)
+//   - prometheus.NewSummaryVec(prometheus.SummaryOpts{...}, labels)


since you identified these code snippets, maybe claude can generate fake .go files that use these patterns?

Good idea 👍 we can create test fixtures with each pattern as a follow-up

mtojek · 2026-01-09T12:24:00Z

+	if name != "" {
+		parts = append(parts, name)
+	}
+	return strings.Join(parts, "_")


fmt.Sprintf("%s_%s_%s") ?

We can't use fmt.Sprintf here, namespace and subsystem are optional. This could generate something like "__name". The current approach only joins non-empty parts. Added a comment for clarity

coderagents · 2026-01-28T08:59:59Z

Documentation Check

No Changes Needed

This PR enhances the internal metrics documentation generator () to recognize additional Prometheus metric patterns ( and ). Since this is an internal development tool that automatically generates metrics documentation and doesn't affect user-facing features or workflows, no documentation updates are required.

The generated metrics file () is auto-generated and properly updated by the script itself.

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, 11:03 AM UTC: Graphite rebased this pull request as part of a merge.
Feb 13, 11:13 AM UTC: @ssncferreira merged this pull request with Graphite.

…erns to metrics scanner

github-actions Bot assigned ssncferreira Jan 8, 2026

ssncferreira mentioned this pull request Jan 8, 2026

feat(scripts/metricsdocgen): add AST scanner core for metrics doc generation #21460

Merged

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-opts branch from ee2942e to b0e8dc4 Compare January 8, 2026 21:22

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-opts branch from b0e8dc4 to c4b0acc Compare January 9, 2026 08:51

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

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-opts branch from c4b0acc to 0243d78 Compare January 9, 2026 08:52

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-newdesc branch from 1c42124 to b52d9eb Compare January 9, 2026 09:29

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-opts branch 3 times, most recently from 602f312 to ca16038 Compare January 9, 2026 09:47

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

ssncferreira commented Jan 9, 2026

View reviewed changes

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-opts branch from ca16038 to 8bc9baa 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 force-pushed the ssncferreira/metricsdocgen-ast-scanner-opts branch 2 times, most recently from 7c7892d to 8fc6317 Compare January 9, 2026 10:39

ssncferreira changed the title ~~feat(scripts): add prometheus.New*() and New*Vec() patterns to metrics scanner~~ feat(scripts/metricsdocgen): add prometheus.New*() and New*Vec() patterns 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-newdesc branch from a14ee38 to 7464012 Compare January 16, 2026 19:01

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-opts branch from b6a4028 to 9bae7b7 Compare January 16, 2026 19:01

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-opts branch from 9bae7b7 to f8f98ee Compare January 23, 2026 19:18

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-opts branch from a94b964 to cd66231 Compare February 12, 2026 15:57

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

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-opts branch from cd66231 to 13618b3 Compare February 12, 2026 16:52

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

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-opts branch from 13618b3 to 143e11f 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-opts branch 2 times, most recently from 2463ea5 to 89e829c 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-opts branch 4 times, most recently from c110fa1 to 9832bc8 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-newdesc to graphite-base/21462 February 13, 2026 10:49

ssncferreira changed the base branch from graphite-base/21462 to main February 13, 2026 11:01

ssncferreira added 3 commits February 13, 2026 11:02

feat(scripts/metricsdocgen): add prometheus.New*() and New*Vec() patt…

d0923b9

…erns to metrics scanner

fix: resolve cross-package label constants in metrics scanner

b8f07e7

chore: improve comments and add logging

777de5c

ssncferreira force-pushed the ssncferreira/metricsdocgen-ast-scanner-opts branch from 9832bc8 to 777de5c Compare February 13, 2026 11:02

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

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

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

Navigation Menu

Uh oh!

feat(scripts/metricsdocgen): add prometheus.New() and NewVec() patterns to metrics scanner - #21462

feat(scripts/metricsdocgen): add prometheus.New() and NewVec() patterns to metrics scanner#21462
ssncferreira merged 3 commits into
mainfrom
ssncferreira/metricsdocgen-ast-scanner-opts

ssncferreira commented Jan 8, 2026 •

edited

Loading

Uh oh!

ssncferreira commented Jan 8, 2026 •

edited

Loading

Uh oh!

ssncferreira Jan 9, 2026

Uh oh!

ssncferreira Feb 12, 2026

Uh oh!

mtojek Feb 13, 2026

Uh oh!

ssncferreira Feb 13, 2026

Uh oh!

mtojek Jan 9, 2026

Uh oh!

ssncferreira Feb 12, 2026

Uh oh!

mtojek Jan 9, 2026

Uh oh!

ssncferreira Feb 12, 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

		@@ -1,21 +1,147 @@
		# HELP agent_reconnecting_pty_connections_total

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

coderagents Bot commented Jan 28, 2026

Documentation Check

No Changes Needed

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 commented Feb 13, 2026 •

edited

Loading