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: schematelemetry: emit metrics and logs about invalid objects #109733

Merged
merged 1 commit into from
Aug 31, 2023

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Aug 30, 2023

Backport 1/1 commits from #108559 on behalf of @chrisseto.

/cc @cockroachdb/release


Short of continuously polling crdb_internal.invalid_objects, there was not a convenient way to monitor a cluster for descriptor corruption.

Having such an indicator would allow customers to perform preflight checks ahead of upgrades to avoid being stuck in a mixed version state. It would also allow CRL to more easily monitor cloud clusters for corruptions in the wild.

This commit updates the schematelemetry job to additionally update the sql.schema.invalid_objects gauge and emit logs for any encountered corruptions.

Informs: #104266
Epic: CRDB-28665

Release note (ops change): Added a new sql.schema.invalid_objects gauge
metric. This gauge is periodically updated based on the schedule set by
the sql.schema.telemetry.recurrence cluster setting. When it is updated,
it counts the number of schema objects (tables, types, schemas, databases,
and functions) that are in an invalid state according to CockroachDB’s
internal validation checks. This metric is expected to be zero in a healthy
cluster, and if it is not, it indicates that there is a problem that must
be repaired.


Release justification: low risk addition to metrics

@blathers-crl blathers-crl bot requested a review from a team as a code owner August 30, 2023 17:15
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.1-108559 branch from a104323 to 475494e Compare August 30, 2023 17:15
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Aug 30, 2023
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.1-108559 branch from 40d5841 to eba281a Compare August 30, 2023 17:15
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@rafiss rafiss force-pushed the blathers/backport-release-23.1-108559 branch from eba281a to 2098fee Compare August 30, 2023 17:23
@rafiss
Copy link
Collaborator

rafiss commented Aug 30, 2023

blathers backport 23.1.9-rc

@blathers-crl
Copy link
Author

blathers-crl bot commented Aug 30, 2023

Encountered an error creating backports. Some common things that can go wrong:

  1. The backport branch might have already existed.
  2. There was a merge conflict.
  3. The backport branch contained merge commits.

You might need to create your backport manually using the backport tool.


error setting assignees, but backport branch blathers/backport-release-23.1.9-rc-109733 is ready: POST https://api.github.com/repos/cockroachdb/cockroach/issues/109739/assignees: 404 Not Found []

Backport to branch 23.1.9-rc failed. See errors above.


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

@blathers-crl
Copy link
Author

blathers-crl bot commented Aug 30, 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 added the backport Label PR's that are backports to older release branches label Aug 30, 2023
Short of continuously polling `crdb_internal.invalid_objects`, there was
not a convenient way to monitor a cluster for descriptor corruption.

Having such an indicator would allow customers to perform preflight
checks ahead of upgrades to avoid being stuck in a mixed version state.
It would also allow CRL to more easily monitor cloud clusters for
corruptions in the wild.

This commit updates the schematelemetry job to additionally update the
`sql.schema.invalid_objects` gauge and emit logs for any encountered
corruptions.

Informs: #104266
Epic: CRDB-28665

Release note (ops change): Added a new sql.schema.invalid_objects gauge
metric. This gauge is periodically updated based on the schedule set by
the sql.schema.telemetry.recurrence cluster setting. When it is updated,
it counts the number of schema objects (tables, types, schemas, databases,
and functions) that are in an invalid state according to CockroachDB’s
internal validation checks. This metric is expected to be zero in a healthy
cluster, and if it is not, it indicates that there is a problem that must
be repaired.
@rafiss rafiss force-pushed the blathers/backport-release-23.1-108559 branch from 2098fee to a49fe07 Compare August 30, 2023 18:43
@rafiss rafiss requested review from a team and abarganier and removed request for a team August 30, 2023 18:43
@rafiss rafiss merged commit d4c6cd3 into release-23.1 Aug 31, 2023
@rafiss rafiss deleted the blathers/backport-release-23.1-108559 branch August 31, 2023 06:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Label PR's that are backports to older release branches blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants