Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release-23.1: server: add node_id label to _status/vars output #99235

Merged
merged 1 commit into from
Mar 23, 2023

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Mar 22, 2023

Backport 1/1 commits from #98640 on behalf of @dhartunian.

/cc @cockroachdb/release


Previously, the output of the prometheus metrics via _status/ vars did not include any node labels. This caused challenges for customers who want to monitor large clusters as it requires additional configuration on the scrape- side to ensure a node ID is added to the metrics. This can be challenging to deal with when nodes come and go in a cluster and the scrape configuration must change as well.

This change adds a node_id prometheus label to the metrics we output that matches the current node's ID. Since _status/vars is output from a single node there is only ever one single value that's appropriate here.

Secondary tenants will mark their metrics with either the nodeID of the shared- process system tenant, or the instanceID of the tenant process.

Resolves: #94763
Epic: None

Release note (ops change): Prometheus metrics available at the _status/vars path now contain a node_id label that identifies the node they were scraped from.


Release justification: low-risk high impact addition of a feature that should be in the dot zero.

Previously, the output of the prometheus metrics via `_status/
vars` did not include any node labels. This caused challenges for
customers who want to monitor large clusters as it requires additional
configuration on the scrape- side to ensure a node ID is added to the
metrics. This can be challenging to deal with when nodes come and go
in a cluster and the scrape configuration must change as well.

This change adds a `node_id` prometheus label to the metrics we
output that matches the current node's ID. Since `_status/vars` is
output from a single node there is only ever one single value that's
appropriate here.

Secondary tenants will mark their metrics with either the nodeID of
the shared- process system tenant, or the instanceID of the tenant
process.

Resolves: #94763
Epic: None

Release note (ops change): Prometheus metrics available at the
`_status/vars` path now contain a `node_id` label that identifies the
node they were scraped from.
@blathers-crl blathers-crl bot requested a review from a team March 22, 2023 15:07
@blathers-crl blathers-crl bot requested a review from a team as a code owner March 22, 2023 15:07
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.1-98640 branch 2 times, most recently from 4c428dd to 23b5755 Compare March 22, 2023 15:08
@blathers-crl
Copy link
Author

blathers-crl bot commented Mar 22, 2023

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Patches should only be created for serious issues or test-only changes.
  • Patches should not break backwards-compatibility.
  • Patches should change as little code as possible.
  • Patches should not change on-disk formats or node communication protocols.
  • Patches should not add new functionality.
  • Patches must not add, edit, or otherwise modify cluster versions; or add version gates.
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters.
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.

Add a brief release justification to the body of your PR to justify this backport.

Some other things to consider:

  • What did we do to ensure that a user that doesn’t know & care about this backport, has no idea that it happened?
  • Will this work in a cluster of mixed patch versions? Did we test that?
  • If a user upgrades a patch version, uses this feature, and then downgrades, what happens?

@blathers-crl blathers-crl bot closed this Mar 22, 2023
@blathers-crl blathers-crl bot deleted the blathers/backport-release-23.1-98640 branch March 22, 2023 15:08
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@dhartunian dhartunian restored the blathers/backport-release-23.1-98640 branch March 22, 2023 15:20
@dhartunian dhartunian reopened this Mar 22, 2023
@dhartunian
Copy link
Collaborator

This change has been requested for a long time and will improve debugging quite a bit for anyone who scrapes metrics off of nodes and wants to remember what the node ID was without having to do additional work. Additionally, our 3rd party metrics integrations have been asking for this to improve their ingest process as well.

@dhartunian dhartunian requested review from knz and abarganier March 22, 2023 15:22
Copy link
Contributor

@abarganier abarganier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm_strong:

CI Failure appears to be a flake/unrelated.

Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @knz)

@dhartunian dhartunian merged commit ffbcb3e into release-23.1 Mar 23, 2023
@dhartunian dhartunian deleted the blathers/backport-release-23.1-98640 branch March 23, 2023 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants