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-24.1: sql: add old zone config in zone config logs #132896

Merged
merged 1 commit into from
Oct 18, 2024

Conversation

annrpom
Copy link
Contributor

@annrpom annrpom commented Oct 18, 2024

Backport 1/3 commits from #132677.

/cc @cockroachdb/release


sql: add old zone config in zone config logs

This patch adds another field in eventpb.SetZoneConfig.
This field, ResolvedOldConfig, will aid in logging the zone configuration
that we have changed.

We use the completeZone/completeSubzone here because we want to
be more useful in our zone config logging. The benefit of using the
complete* is that we can explicitly see what fields are changing,
even if they are actually modeled as a zone config that just inherits
from its parent. The disadvantage of this is that we are not able
to easily tell the inheritence of the old zone config, but knowing
the actual diff between the old vs new config seems more relevant
for debugging.

Fixes: #127176

Release note: None


Release justification: low-risk logging improvement

@annrpom annrpom requested a review from a team as a code owner October 18, 2024 00:02
@annrpom annrpom requested review from kyle-a-wong and removed request for a team October 18, 2024 00:02
Copy link

blathers-crl bot commented Oct 18, 2024

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Backports should only be created for serious
    issues
    or test-only changes.
  • Backports should not break backwards-compatibility.
  • Backports should change as little code as possible.
  • Backports should not change on-disk formats or node communication protocols.
  • Backports should not add new functionality (except as defined
    here).
  • Backports must not add, edit, or otherwise modify cluster versions; or add version gates.
  • All backports must be reviewed by the owning areas TL. For more information as to how that review should be conducted, please consult the backport
    policy
    .
If your backport adds new functionality, please ensure that the following additional criteria are satisfied:
  • 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. State changes must be further protected such that nodes running old binaries will not be negatively impacted by the new state (with a mixed version test added).
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.
  • Your backport must be accompanied by a post to the appropriate Slack
    channel (#db-backports-point-releases or #db-backports-XX-X-release) for awareness and discussion.

Also, please add a brief release justification to the body of your PR to justify this
backport.

@blathers-crl blathers-crl bot added the backport Label PR's that are backports to older release branches label Oct 18, 2024
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@annrpom annrpom requested a review from a team October 18, 2024 00:02
This patch adds another field in `eventpb.SetZoneConfig`.
This field, `ResolvedOldConfig`, will aid in logging the zone
configuration that we have changed.

We use the `completeZone/completeSubzone` here because we want to
be more useful in our zone config logging. The benefit of using the
complete* is that we can explicitly see what fields are changing,
even if they are actually modeled as a zone config that just inherits
from its parent. The disadvantage of this is that we are not able
to easily tell the inheritence of the old zone config, but knowing
the actual diff between the old vs new config seems more relevant
for debugging.

Fixes: cockroachdb#127176

Release note: None
Copy link
Collaborator

@rafiss rafiss left a comment

Choose a reason for hiding this comment

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

Reviewed 6 of 6 files at r1, all commit messages.
Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (waiting on @kyle-a-wong)

@annrpom annrpom merged commit 20f8182 into cockroachdb:release-24.1 Oct 18, 2024
19 of 20 checks passed
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants