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-22.2: tenant: add support to Log endpoints to status server #96906

Merged

Conversation

jeffswenson
Copy link
Collaborator

@jeffswenson jeffswenson commented Feb 9, 2023

Backport 1/1 commits from #91604.

/cc @cockroachdb/release

Release justification: Including logs in debug zips simplifies debugging issues in multi-tenant deploys.


Previously, the tenant status server did not support the log-file related
endpoints leading to missing logs in the debug.zip when generating for a tenant
server.

This commit migrates the implementations from the standard status server into
the tenant, adjusts for fanout to instances instead of nodes, and leaves the
rest as-is.

Resolves: #91992
Epic: CC-5168

Release note (ops change): generating a debug.zip for a tenant server will now
include logs in the zip file.

@jeffswenson jeffswenson requested a review from a team February 9, 2023 21:35
@jeffswenson jeffswenson requested a review from a team as a code owner February 9, 2023 21:35
@jeffswenson jeffswenson requested a review from a team February 9, 2023 21:35
@jeffswenson jeffswenson requested a review from a team as a code owner February 9, 2023 21:35
@blathers-crl
Copy link

blathers-crl bot commented Feb 9, 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

@jeffswenson
Copy link
Collaborator Author

-       instance, err := t.sqlServer.sqlInstanceReader.GetInstance(ctx, instanceID)
+       instance, err := t.sqlServer.sqlInstanceProvider.GetInstance(ctx, instanceID)

I made a small change to get the patch to build on 22.2. sqlInstanceProvider was renamed to sqlInstanceReader.

Previously, the tenant status server did not support the log-file related
endpoints leading to missing logs in the debug.zip when generating for a tenant
server.

This commit migrates the implementations from the standard status server into
the tenant, adjusts for fanout to instances instead of nodes, and leaves the
rest as-is.

Resolves: cockroachdb#91992
Epic: CC-5168

Release note (ops change): generating a debug.zip for a tenant server will now
include logs in the zip file.
@jeffswenson jeffswenson requested a review from a team as a code owner February 10, 2023 18:08
Copy link
Collaborator

@dhartunian dhartunian left a comment

Choose a reason for hiding this comment

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

I made a small change to get the patch to build on 22.2. sqlInstanceProvider was renamed to sqlInstanceReader.

👍

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


pkg/cli/testdata/zip/testzip_tenant line 144 at r1 (raw file):

[node 1] 0 goroutine dumps found
[node 1] requesting log file ...
[node 1] 0 log file ...

I'm surprised this test didn't have to change on the original PR. Do you know why?

@jeffswenson
Copy link
Collaborator Author

pkg/cli/testdata/zip/testzip_tenant line 144 at r1 (raw file):

[node 1] 0 goroutine dumps found
[node 1] requesting log file ...
[node 1] 0 log file ...

I'm surprised this test didn't have to change on the original PR. Do you know why?

It looks like the test is skipped:

skip.WithIssue(t, 89192, "flaky test")

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