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.2: cli: add job traces for traceable jobs to the debug zip #112644

Merged
merged 2 commits into from Oct 19, 2023

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Oct 18, 2023

Backport 2/2 commits from #112130 on behalf of @adityamaru.

/cc @cockroachdb/release


This change teaches the debug zip to collect the traces for traceable jobs (backup, restore, import, pcr) that are in a running or reverting state at the time the zip is collected. These traces are dumped in a
/jobs/<jobID>/<timestamp>/trace.zip file and rely on the existing tracing/zippr that is used by
cockroach debug job-trace to collect the required information.

Informs: #111886
Release note (cli change): cockroach debug zip can now collect the inflight traces of traceable jobs such as backup, restore, import, c2c and dump them in a jobs/ subdirectory in the zip.


Release justification: debug only functionality that defaults to disabled, and can be used to investigate stuck or slow jobs

This change teaches the debug zip to collect the traces
for traceable jobs (backup, restore, import, pcr) that
are in a running or reverting state at the time the zip
is collected. These traces are dumped in a
`/jobs/<jobID>/<timestamp>/trace.zip` file and rely on
the existing `tracing/zippr` that is used by
`cockroach debug job-trace` to collect the required
information.

Note this functionality is default off.

Release note (cli change): `cockroach debug zip` has an
additional flag that is default off `include-running-job-traces`
that will enable collecting the inflight traces of traceable jobs such as
backup, restore, import, c2c and dump them in a `jobs/`
subdirectory in the zip.
@blathers-crl blathers-crl bot requested review from a team as code owners October 18, 2023 20:21
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.2-112130 branch from 1b00425 to bd82c40 Compare October 18, 2023 20:21
@blathers-crl blathers-crl bot requested review from a team as code owners October 18, 2023 20:21
@blathers-crl blathers-crl bot requested review from msbutler and removed request for a team October 18, 2023 20:21
@blathers-crl blathers-crl bot added the blathers-backport This is a backport that Blathers created automatically. label Oct 18, 2023
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.2-112130 branch from 899463a to 11daaa7 Compare October 18, 2023 20:21
@blathers-crl blathers-crl bot added the O-robot Originated from a bot. label Oct 18, 2023
@blathers-crl blathers-crl bot requested review from dhartunian and removed request for a team October 18, 2023 20:21
@blathers-crl
Copy link
Author

blathers-crl bot commented Oct 18, 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 Oct 18, 2023
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@adityamaru adityamaru requested review from dt and stevendanna and removed request for msbutler and dhartunian October 18, 2023 20:56
@adityamaru
Copy link
Contributor

test timeout in TestRevertTenantToTimestamp is unrelated, ill track that separately. It might just be one of the infra timeouts we've seen today.

@adityamaru adityamaru merged commit 4a9368e into release-23.2 Oct 19, 2023
5 of 6 checks passed
@adityamaru adityamaru deleted the blathers/backport-release-23.2-112130 branch October 19, 2023 00:47
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.

None yet

3 participants