metric: add static labels to metric metadata #143511
Merged
Conversation
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
dhartunian
requested review from
Abhinav1299,
aa-joshi,
angles-n-daemons,
arjunmahishi and
Copilot
and removed request for
a team
Member
|
This change is |
This was referenced Mar 26, 2025
|
this should solve your problem if useStaticLabels && len(md.StaticLabels) > 0 { |
dhartunian
force-pushed
the
davidh/push-orrrntktwptm
branch
2 times, most recently
from
f5fc352 to
9966a80
Compare
Contributor
angles-n-daemons
left a comment
angles-n-daemons
left a comment
There was a problem hiding this comment.
This looks good overall, one question - for tsdb, is the plan to add scraping with static labels = false to maintain backwards compatibility?
| // GetName is a method on Metadata | ||
| GetName() string | ||
| // GetLabeledName is a method on Metadata | ||
| GetLabeledName() string |
Contributor
There was a problem hiding this comment.
Not that this is explicitly necessary, but is it possible to modify the GetName function in the same way the GetLabels function was modified, or does it break compatibility with prom?
Collaborator
Author
There was a problem hiding this comment.
Thanks for the suggestion, I hesitated because the PR was getting big. I've got a commit that does the bulk rename that I'll put up separately for easier review once this merges.
Collaborator
Author
@angles-n-daemons correct. TSDB will not be scraping with static labels. |
Previously, it was not possible to emit metrics with static labels that were known at startup. Labels would need to be dynamically added after `Metadata` was constructed. This made it difficult to define groups of metrics with the same name but different labels. This commit adds two new fields to the `metric.Metadata` struct, which are meant to enable a backwards-compatible transition to labeled metrics from today's definitions which reify the label values into the metric name. The Prometheus export code is modified to accept a flag that governs whether static labels are requested. If so, the labeled name of the metric be used if available. A future PR will add a `/metrics` endpoint that is like `/_status/ vars` except that it will emit the static label version of metrics when they have those definitions available. Part of: cockroachdb#142570 Release note: None
dhartunian
force-pushed
the
davidh/push-orrrntktwptm
branch
from
9966a80 to
e2edfc6
Compare
angles-n-daemons
approved these changes
Apr 7, 2025
Collaborator
Author
|
TFTR! bors r=angles-n-daemons |
Contributor
|
Build succeeded: |
craig bot
pushed a commit
that referenced
this pull request
Apr 9, 2025
143536: metric: add /metrics endpoint with static labels r=angles-n-daemons a=dhartunian
A new metrics endpoint that's Prometheus-compatible, is now available
at `/metrics` similarly to `/_status/vars`. This endpoint will emit
statically labeled metrics if the metric metadata defines static
labels and a labeled name.
Here's an example of what this looks like on a demo cluster with
multitenancy using the few metrics that have been migrated in this PR
from SQL:
```
http GET http://localhost:8080/_status/vars cluster==system | grep sql_insert_count
# HELP sql_insert_count_internal Number of SQL INSERT statements successfully executed (internal queries)
# TYPE sql_insert_count_internal counter
sql_insert_count_internal{node_id="1",tenant="system"} 138
sql_insert_count_internal{node_id="1",tenant="demoapp"} 152
# HELP sql_insert_count Number of SQL INSERT statements successfully executed
# TYPE sql_insert_count counter
sql_insert_count{node_id="1",tenant="system"} 2
sql_insert_count{node_id="1",tenant="demoapp"} 73
~/go/src/github.com/cockroachdb/cockroach remotes/dhartunian/davidh/push-orrrntktwptm* ≡
❯
http GET http://localhost:8080/metrics cluster==system | grep sql_insert_count
~/go/src/github.com/cockroachdb/cockroach remotes/dhartunian/davidh/push-orrrntktwptm* ≡
❯
http GET http://localhost:8080/metrics cluster==system | grep sql_count
# HELP sql_count Number of SQL UPDATE statements successfully executed (internal queries)
# TYPE sql_count counter
sql_count{node_id="1",tenant="system",query_type="select",query_internal="true"} 172
sql_count{node_id="1",tenant="system",query_type="update"} 0
sql_count{node_id="1",tenant="system",query_type="update",query_internal="true"} 67
sql_count{node_id="1",tenant="system",query_type="select"} 0
sql_count{node_id="1",tenant="system",query_type="delete",query_internal="true"} 29
sql_count{node_id="1",tenant="system",query_type="insert",query_internal="true"} 138
sql_count{node_id="1",tenant="system",query_type="delete"} 0
sql_count{node_id="1",tenant="system",query_type="insert"} 2
sql_count{node_id="1",tenant="demoapp",query_type="update",query_internal="true"} 124
sql_count{node_id="1",tenant="demoapp",query_type="update"} 0
sql_count{node_id="1",tenant="demoapp",query_type="insert"} 269
sql_count{node_id="1",tenant="demoapp",query_type="insert",query_internal="true"} 152
sql_count{node_id="1",tenant="demoapp",query_type="select",query_internal="true"} 243
sql_count{node_id="1",tenant="demoapp",query_type="delete",query_internal="true"} 57
sql_count{node_id="1",tenant="demoapp",query_type="select"} 593
sql_count{node_id="1",tenant="demoapp",query_type="delete"} 0
```
Resolves: #142570
Release note (ops change): Prometheus metrics are now also available
at the `/metrics` endpoint in addition to `/_status/vars`. This new
endpoint will evolve more rapidly as we migrate metrics to use labels
where previously different metric names were defined. Customers can
continue to use `/_status/vars` where the names will not change.
----
First commit can be reviewed here: #143511
Co-authored-by: David Hartunian <davidh@cockroachlabs.com>
celeste-cockroachdb
bot
added
v25.2.0-prerelease
and removed
target-release-25.2.0
labels
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Previously, it was not possible to emit metrics with static labels that were known at startup. Labels would need to be dynamically added after
Metadatawas constructed. This made it difficult to define groups of metrics with the same name but different labels.This commit adds two new fields to the
metric.Metadatastruct, which are meant to enable a backwards-compatible transition to labeled metrics from today's definitions which reify the label values into the metric name.The Prometheus export code is modified to accept a flag that governs whether static labels are requested. If so, the labeled name of the metric be used if available.
A future PR will add a
/metricsendpoint that is like/_status/ varsexcept that it will emit the static label version of metrics when they have those definitions available.Part of: #142570
Release note: None