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: add gauge for connections throttled by semaphore #104388

Merged
merged 1 commit into from Jun 7, 2023

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Jun 6, 2023

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

/cc @cockroachdb/release


fixes #82900

Release note (ops change): Added a gauge metric named sql.conns_waiting_to_hash. It counts the number of connection attempts that are being throttled in order to limit the amount of concurrent password hashing operations. The throttling behavior has been present since v21.2, and was added in order to prevent password hashing from using up too much CPU. The metric is the only new addition in this change.

The metric is expected to be 0 or close to 0 in a healthy setup. If the metric is consistently high and connection latencies are high, then an operator should do one or more of the following:

  • Make sure applications using the cluster have properly configured connection pools.
  • Add more vCPU or more nodes to the cluster.
  • Increase the password hashing concurrency using the COCKROACH_MAX_PW_HASH_COMPUTE_CONCURRENCY environment variable.

Release justification: metrics only change

@blathers-crl blathers-crl bot requested review from a team as code owners June 6, 2023 06:15
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.1-104235 branch from a84cfb9 to a0e637a Compare June 6, 2023 06:15
@blathers-crl blathers-crl bot requested a review from a team as a code owner June 6, 2023 06:15
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Jun 6, 2023
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.1-104235 branch from cba1dcc to 775bea0 Compare June 6, 2023 06:15
@blathers-crl
Copy link
Author

blathers-crl bot commented Jun 6, 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?

@blathers-crl
Copy link
Author

blathers-crl bot commented Jun 6, 2023

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 requested a review from ecwall June 6, 2023 18:51
See the release note. Note that other usages of this semaphore are not
measured. These include:
- Logging into the DB console.
- Creating or changing a user's password.
- Automatically rehashing a password when the "downgrade to bcrypt"
  option is set.

The purpose of this metric is *just* to track how many sql connections
are blocked, so those other usages should not contribute towards the
count.

Release note (ops change): Added a gauge metric named
sql.conns_waiting_to_hash. It counts the number of connection attempts
that are being throttled in order to limit the amount of concurrent
password hashing operations. The throttling behavior has been present
since v21.2, and was added in order to prevent password hashing from
using up too much CPU. The metric is the only new addition in this
change.

The metric is expected to be 0 or close to 0 in a healthy setup. If the
metric is consistently high and connection latencies are high, then an
operator should do one or more of the following:

- Make sure applications using the cluster have properly configured
  connection pools.
- Add more vCPU or more nodes to the cluster.
- Increase the password hashing concurrency using the
  COCKROACH_MAX_PW_HASH_COMPUTE_CONCURRENCY environment variable.
@rafiss rafiss force-pushed the blathers/backport-release-23.1-104235 branch from 775bea0 to 40e4224 Compare June 6, 2023 19:54
@rafiss rafiss requested a review from a team as a code owner June 6, 2023 19:54
@rafiss rafiss merged commit 1a5dc2a into release-23.1 Jun 7, 2023
6 checks passed
@rafiss rafiss deleted the blathers/backport-release-23.1-104235 branch June 7, 2023 00:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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

3 participants