metric: add labels for `sql.*.started.count` #151946

ZhouXing19 · 2025-08-15T20:43:17Z

Previously, only metrics for executed SELECT|UPDATE|DELETE|INSERT statements are labeled, while their started equivalent are not labeled. This commit is to label these metrics. Since they are not frequently used metrics, they are not marked as Essential.

Fixes: #152074

Release note (ops change): sql.select.started.count, sql.insert.started.count, sql.update.started.count, sql.delete.started.count are now labeled with sql.started.count.

blathers-crl · 2025-08-15T20:43:20Z

It looks like your PR touches production code but doesn't add or edit any test code. Did you consider adding tests to your PR?

_{🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf.}

cockroach-teamcity · 2025-08-15T20:43:31Z

This change is

dhartunian · 2025-08-18T14:03:48Z

pkg/sql/exec_util.go

+		StaticLabels: metric.MakeLabelPairs(metric.LabelQueryType, "started-select"),
+		Essential:    true,
+		Category:     metric.Metadata_SQL,
+		HowToUse:     "This high-level metric reflects workload volume. Monitor this metric to identify abnormal application behavior or patterns over time. If abnormal patterns emerge, apply the metric's time range to the SQL Activity pages to investigate interesting outliers or patterns. For example, on the Transactions page and the Statements page, sort on the Execution Count column. To find problematic sessions, on the Sessions page, sort on the Transaction Count column. Find the sessions with high transaction counts and trace back to a user or application.",


Can you say anything more specific about started vs other metrics that would be helpful here?

I'm also not sure this metric is "essential". Most customers use the executed metrics to count QPS so we should justify why they should also pay attention to these.

Good point. I searched Slack and found only 2 threads that explicitly mentioned using the started metrics for troubleshooting:

https://cockroachlabs.slack.com/archives/C02119Q1G05/p1623169882143700?thread_ts=1623161302.135100&cid=C02119Q1G05

https://cockroachlabs.slack.com/archives/C0713QV7XHP/p1714432731834549

Additionally, the started metrics was introduced in #37264, which also introduced the executed metrics as a claimed more useful one.

So maybe we should close it for now until receiving explicit ask for this feature?

Removed the "Essential:true" field per offline discussion.

I agree that "started" shouldn't be essential.

dhartunian

LGTM. Thanks!

dhartunian

NVM I realized this needs an edit.

dhartunian · 2025-08-20T21:26:18Z

pkg/sql/exec_util.go

+		Help:         "Number of SQL UPDATE statements started",
+		Measurement:  "SQL Statements",
+		Unit:         metric.Unit_COUNT,
+		LabeledName:  "sql.count",


Sorry I was mistaken: these counts should not be aggregated along with other sql.count metrics because "started" and "executed" should not be added together.

This should be sql.started.count with label update for example.

yuzefovich

@yuzefovich reviewed 2 of 2 files at r2, all commit messages.
Reviewable status: complete! 0 of 0 LGTMs obtained (waiting on @dhartunian and @ZhouXing19)

-- commits line 10 at r2:
nit: this needs an update.

yuzefovich · 2025-08-22T21:30:33Z

pkg/sql/exec_util.go

+		StaticLabels: metric.MakeLabelPairs(metric.LabelQueryType, "started-select"),
+		Essential:    true,
+		Category:     metric.Metadata_SQL,
+		HowToUse:     "This high-level metric reflects workload volume. Monitor this metric to identify abnormal application behavior or patterns over time. If abnormal patterns emerge, apply the metric's time range to the SQL Activity pages to investigate interesting outliers or patterns. For example, on the Transactions page and the Statements page, sort on the Execution Count column. To find problematic sessions, on the Sessions page, sort on the Transaction Count column. Find the sessions with high transaction counts and trace back to a user or application.",


I agree that "started" shouldn't be essential.

michae2 · 2025-09-24T16:24:54Z

Does this need to get into 25.4?

ZhouXing19 · 2025-09-24T16:30:19Z

@dhartunian Can I ask for another look? Thanks!

Previously, only metrics for *executed* `SELECT|UPDATE|DELETE|INSERT` statements are labeled, while their *started* equivalent are not labeled. This commit is to label these metrics. Ref cockroachdb#143536 Release note (ops change): sql.select.started.count, sql.insert.started.count, sql.update.started.count, sql.delete.started.count are now labeled with sql.started.count. <what was there before: Previously, ...> <why it needed to change: This was inadequate because ...> <what you did about it: To address this, this patch ...>

ZhouXing19 · 2025-09-29T17:36:57Z

TFTR!
bors r+

craig · 2025-09-29T18:19:52Z

Build succeeded:

dhartunian reviewed Aug 18, 2025

View reviewed changes

ZhouXing19 force-pushed the add-label-started branch 2 times, most recently from 7b76724 to fc51076 Compare August 18, 2025 17:07

ZhouXing19 marked this pull request as ready for review August 19, 2025 13:01

ZhouXing19 requested a review from dhartunian August 19, 2025 13:01

dhartunian approved these changes Aug 20, 2025

View reviewed changes

dhartunian requested changes Aug 20, 2025

View reviewed changes

yuzefovich reviewed Aug 22, 2025

View reviewed changes

ZhouXing19 force-pushed the add-label-started branch from fc51076 to d62f304 Compare August 28, 2025 12:53

ZhouXing19 force-pushed the add-label-started branch from d62f304 to 5692dac Compare September 24, 2025 16:29

ZhouXing19 requested a review from dhartunian September 24, 2025 16:30

ZhouXing19 force-pushed the add-label-started branch from 5692dac to c19c6df Compare September 29, 2025 13:44

dhartunian approved these changes Sep 29, 2025

View reviewed changes

ZhouXing19 added the backport-25.4.x Flags PRs that need to be backported to 25.4 label Sep 29, 2025

craig bot merged commit b0e0704 into cockroachdb:master Sep 29, 2025
22 of 23 checks passed

celeste-cockroachdb bot added the target-release-26.1.0 label Sep 29, 2025

blathers-crl bot mentioned this pull request Sep 29, 2025

release-25.4: metric: add labels for sql.*.started.count #154388

Merged

celeste-cockroachdb bot added v26.1.0-prerelease and removed target-release-26.1.0 labels Dec 4, 2025

metric: add labels for sql.*.started.count #151946

metric: add labels for sql.*.started.count #151946

Uh oh!

Conversation

ZhouXing19 commented Aug 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

blathers-crl bot commented Aug 15, 2025

Uh oh!

cockroach-teamcity commented Aug 15, 2025

Uh oh!

dhartunian Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

ZhouXing19 Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

ZhouXing19 Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

yuzefovich Aug 22, 2025

Choose a reason for hiding this comment

Uh oh!

dhartunian left a comment

Choose a reason for hiding this comment

Uh oh!

dhartunian left a comment

Choose a reason for hiding this comment

Uh oh!

dhartunian Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

yuzefovich left a comment

Choose a reason for hiding this comment

Uh oh!

yuzefovich Aug 22, 2025

Choose a reason for hiding this comment

Uh oh!

michae2 commented Sep 24, 2025

Uh oh!

ZhouXing19 commented Sep 24, 2025

Uh oh!

ZhouXing19 commented Sep 29, 2025

Uh oh!

craig bot commented Sep 29, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

metric: add labels for `sql.*.started.count` #151946

metric: add labels for `sql.*.started.count` #151946

ZhouXing19 commented Aug 15, 2025 •

edited

Loading