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.2: util/log/logconfig: allow format for stderr log sink #131539

Merged
merged 1 commit into from
Sep 29, 2024

Conversation

xinhaoz
Copy link
Member

@xinhaoz xinhaoz commented Sep 27, 2024

Backport 1/1 commits from #131529.

/cc @cockroachdb/release

Release justification: fix regression


Previously in #113532 we fixed the stderr sink log format to crdb-v2-tty. This was deemed to be a regression, as the stderr sink could previously be set to any available format. This commit reverts the restriction.

The following are still true after this commit:

  • format in file-defaults is not propagated to format of the stderr sink. To set stderr format, one must explicitly define it in the stderr sink section of the log config.
  • format-options in file-defaults are only applied to stderr if the format of the stderr sink and that in file-defaults are compatible.

Epic: none
Fixes: #128665

Release note (ops change): Users may set the log format for the stderr sink by setting the format field in the logging config under the stderr sink section.

Previously in cockroachdb#113532 we fixed the stderr sink log format
to `crdb-v2-tty`. This was deemed to be a regression, as
the stderr sink could previously be set to any available
format. This commit reverts the restriction.

The following are still true after this commit:
- `format` in `file-defaults` is not propagated to
`format` of the stderr sink. To set `stderr` format,
one must explicitly define it in the `stderr` sink
section of the log config.
- `format-options` in `file-defaults` are only applied
to stderr if the format of the stderr sink and that in
file-defaults are compatible.

Epic: none
Fixes: cockroachdb#128665

Release note (ops change): Users may set the log format
for the stderr sink by setting the `format` field in the
logging config under the `stderr` sink section.
@xinhaoz xinhaoz requested a review from a team as a code owner September 27, 2024 19:46
@xinhaoz xinhaoz requested review from angles-n-daemons and removed request for a team September 27, 2024 19:46
Copy link

blathers-crl bot commented Sep 27, 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 Sep 27, 2024
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@xinhaoz xinhaoz requested a review from dhartunian September 27, 2024 19:47
@xinhaoz xinhaoz merged commit 15f96a5 into cockroachdb:release-24.2 Sep 29, 2024
19 of 20 checks passed
@xinhaoz xinhaoz deleted the backport24.2-131529 branch September 29, 2024 14:17
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