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: cli: default --include-range-info to true, but create a single file #104248

Merged
merged 5 commits into from Jun 9, 2023

Conversation

tbg
Copy link
Member

@tbg tbg commented Jun 2, 2023

Backport 5/5 commits from #104133.

/cc @cockroachdb/release

Release justification: debug.zip improvement that avoids loss of observability after a recent change, and improves UX


This was introduced and defaulted to false in
#102289.

Anecdotally I look at these in many L2 escalations1, and one cannot always
even change the default flag (e.g. CC), and seldom will a later debug.zip be
good enough for an RCA.

The original reason to introduce this flag seems to have been the delay
incurred when extracting these many files. There are suspicions that this
somehow exacerbates broken archives that we get from time to time, esp.
on large clusters.

This PR defaults the flag to true but also switches debug.zip so that it now
puts the ranges into a single file. This file is going to be large, but we can
handle that.

Epic: none
Release note: None

Footnotes

  1. most recently today: https://github.com/cockroachlabs/support/issues/2343#issuecomment-1569677115

tbg added 5 commits June 2, 2023 12:29
Epic: none
Release note: None
Epic: none
Release note: None
Epic: none
Release note: None
Epic: none
Release note (ops change): The debug.zip archive now contains the files formerly
located at `nodes/*/ranges/*.json` in one file per node, `nodes/*/ranges.json`.
This was introduced and defaulted to `false` in
cockroachdb#102289.

Anecdotally I look at these in many L2 escalations[^1], and one cannot always
even change the default flag (e.g. CC), and seldom will a later debug.zip be
good enough for an RCA.

The original reason to introduce this flag seems to have been the delay
incurred when extracting these many files, but they can be skipped via `unzip
-x "debug/nodes/*/ranges/*"`.

Besides, the flag is still there, so we can ask operators of large deployments
to opt in selectively.

[^1]: most recently today: cockroachlabs/support#2343 (comment)

Epic: none
Release note: None
@tbg tbg requested review from a team as code owners June 2, 2023 11:18
@blathers-crl
Copy link

blathers-crl bot commented Jun 2, 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?

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@tbg tbg requested a review from dt June 2, 2023 11:19
@tbg tbg merged commit 57e40e9 into cockroachdb:release-23.1 Jun 9, 2023
6 checks passed
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.

None yet

3 participants