release-23.1: metrics: improve ux around _status/vars output #99820
+50
−24
Conversation
This file contains 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
![blathers-crl[bot]](https://avatars.githubusercontent.com/in/59700?s=60&v=4){kind=small}
Previously, the addition of the `tenant` metric label was applied uniformly and could result in confusion for customers who never enable multi-tenancy or c2c. The `tenant="system"` label carries little meaning when there's no tenancy in use. This change modifies the system tenant label application to only happen when a non- sytem in-process tenant is created. Additionally, an environment variable: `COCKROACH_DISABLE_NODE_AND_TENANT_METRIC_LABELS` can be set to `false` to disable the new `tenant` and `node_id` labels. This can be used on single-process tenants to disable the `tenant` label. When the `tenantNameContainer` is nil, or the `nodeID` is set to 0, the labels will not be applied during recorder configuration on startup. This is currently the case when running a separate process tenant using `mt start-sql`. Those tenants *will not* have `tenant` or `nodeID` labels available. Resolves: #94668 Epic: CRDB-18798 Release note (ops change): The `COCKROACH_DISABLE_NODE_AND_TENANT_METRIC_LABELS` env var can be used to disable the newly introduced metric labels in the `_status/vars` output if they conflict with a customer's scrape configuration.
blathers-crl
bot
force-pushed
the
blathers/backport-release-23.1-99516
branch
2 times, most recently
from
1767e2d to
9521951
Compare
|
Thanks for opening a backport. Please check the backport criteria before merging:
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
Add a brief release justification to the body of your PR to justify this backport. Some other things to consider:
|
|
This change is |
|
@dhartunian is this still relevant? |
|
@knz yep, thx for reopening. |
knz
approved these changes
Mar 29, 2023
knz
suggested changes
Mar 29, 2023
| // We assume that all stores have been added to the registry | ||
| // prior to calling `AddNode`. | ||
| for _, s := range mr.mu.storeRegistries { | ||
| s.AddLabel("node_id", strconv.Itoa(int(desc.NodeID))) |
There was a problem hiding this comment.
Hold on I am confused here. Why are we adding the node_id label again for every store? Don't we want separate store IDs instead?
There was a problem hiding this comment.
The stores have a store_id label already. This adds an additional node_id to those because I was operating under the assumption that every metric emitted by a node under _status/vars should label itself with that node's ID.
Should we omit node_id label from store metrics entirely?
knz
approved these changes
Mar 30, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Backport 1/1 commits from #99516 on behalf of @dhartunian.
/cc @cockroachdb/release
Previously, the addition of the
tenantmetric label was applied uniformly and could result in confusion for customers who never enable multi-tenancy or c2c. Thetenant="system"label carries little meaning when there's no tenancy in use.This change modifies the system tenant label application to only happen when a non- sytem in-process tenant is created.
Additionally, an environment variable:
COCKROACH_DISABLE_NODE_AND_TENANT_METRIC_LABELScan be set tofalseto disable the newtenantandnode_idlabels. This can be used on single-process tenants to disable thetenantlabel.Resolves: #94668
Epic: CRDB-18798
Release note (ops change): The
COCKROACH_DISABLE_NODE_AND_TENANT_METRIC_LABELSenv var can be used to disable the newly introduced metric labels in the_status/varsoutput if they conflict with a customer's scrape configuration.Release justification: low risk high impact addition to the prometheus metric output that makes it easier to use and reduces impact of new changes