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: pgwire: change sql.defaults.results_buffer.size default to 512KiB #124633

Merged
merged 2 commits into from
May 28, 2024

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented May 23, 2024

Backport 1/1 commits from #124580 on behalf of @rafiss.

/cc @cockroachdb/release


When this setting was added in PR #32366, the default value did not receive much scrutiny. Using a bigger value is beneficial since it will reduce the chance for clients using READ COMMITTED transactions to hit errors that cannot automatically be retried within CockroachDB. (The reason being that if results were already sent back to the client since the buffer filled up, it's not safe to retry that operation.)

512KiB is still pretty small, but should prevent more errors than the old default of 16KiB.

fixes #124049
Release note (sql change): The default value of the sql.defaults.results_buffer.size cluster setting was changed from 16KiB to 512KiB.


Release justification: low risk high benefit config change

When this setting was added in PR #32366, the default value did not
receive much scrutiny. Using a bigger value is beneficial since it will
reduce the chance for clients using READ COMMITTED transactions to hit
errors that cannot automatically be retried within CockroachDB. (The
reason being that if results were already sent back to the client since
the buffer filled up, it's not safe to retry that operation.)

512KiB is still pretty small, but should prevent more errors than the
old default of 16KiB.

Release note (sql change): The default value of the
sql.defaults.results_buffer.size cluster setting was changed from
16KiB to 512KiB.
@blathers-crl blathers-crl bot requested a review from a team as a code owner May 23, 2024 21:41
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-24.1-124580 branch from dc67628 to 2569926 Compare May 23, 2024 21:41
@blathers-crl blathers-crl bot requested review from a team as code owners May 23, 2024 21:41
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels May 23, 2024
@blathers-crl blathers-crl bot requested review from kyle-a-wong and removed request for a team May 23, 2024 21:41
Copy link
Author

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

This change is Reviewable

Copy link
Collaborator

@fqazi fqazi left a comment

Choose a reason for hiding this comment

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

:lgtm:

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

This avoids a race when setting a cluster setting, and instead sets the
parameter directly in the connection string.

Release note: None
@rafiss rafiss merged commit 04fb9d9 into release-24.1 May 28, 2024
19 of 20 checks passed
@rafiss rafiss deleted the blathers/backport-release-24.1-124580 branch May 28, 2024 17:48
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

4 participants