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: pgwire: log session start and end unconditionally #124375

Merged
merged 3 commits into from
May 20, 2024

Conversation

rafiss
Copy link
Collaborator

@rafiss rafiss commented May 17, 2024

Backport 3/3 commits from #124254.

/cc @cockroachdb/release

Release justification: high value logging change


pgwire: remove redundant log for JWT auth

This already gets logged in the processCommands function, right before
the server enters the main command processing loop.

pgwire: log auth info message as redactable string

Previously, the entire info text would be redacted, which made
debugging harder. This improves it so we use the built in
redaction facilities in order to get more detail.

pgwire: log session start and end unconditionally

Release note (ops change): The client_authentication_ok and
client_session_end messages are now logged to the SESSIONS log channel
unconditionally. Previously, these would only be logged if the
server.auth_log.sql_sessions.enabled cluster setting was changed to
true. All other SESSIONS log messages are still only logged if
server.auth_log.sql_sessions.enabled or
server.auth_log.sql_connections.enabled are set to true.

If you do not want to see client_authentication_ok or client_session_end
messages, then the SESSIONS log channel can be disabled entirely.

fixes #122684

This already gets logged in the processCommands function, right before
the server enters the main command processing loop.

Release note: None
Previously, the entire info text would be redacted, which made
debugging harder. This improves it so we use the built in
redaction facilities in order to get more detail.

Release note: None
Release note (ops change): The client_authentication_ok and
client_session_end messages are now logged to the SESSIONS log channel
unconditionally. Previously, these would only be logged if the
server.auth_log.sql_sessions.enabled cluster setting was changed to
true. All other SESSIONS log messages are still only logged if
server.auth_log.sql_sessions.enabled or
server.auth_log.sql_connections.enabled are set to true.

If you do not want to see client_authentication_ok or client_session_end
messages, then the SESSIONS log channel can be disabled entirely.
@rafiss rafiss requested review from mgartner and souravcrl May 17, 2024 23:12
@rafiss rafiss requested review from a team as code owners May 17, 2024 23:12
@rafiss rafiss requested review from abarganier and removed request for a team May 17, 2024 23:12
Copy link

blathers-crl bot commented May 17, 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 and one additional
    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 May 17, 2024
Copy link

blathers-crl bot commented May 17, 2024

It looks like your PR touches production code but doesn't add or edit any test code. Did you consider adding tests to your PR?

🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf.

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@rafiss rafiss merged commit 2ebfe78 into cockroachdb:release-23.1 May 20, 2024
6 checks passed
@rafiss rafiss deleted the backport23.1-124254 branch May 20, 2024 20:52
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.

None yet

4 participants