Add ActiveRecord::Base.connection_pool.stat #26988

Merged
merged 1 commit into from Nov 8, 2016

Projects

None yet

7 participants

@Paxa
Contributor
Paxa commented Nov 7, 2016

Example:

p ActiveRecord::Base.connection_pool.stat
{
  max: 25,
  total: 1,
  busy: 1,
  dead: 0,
  idle: 0,
  num_waiting: 0,
  checkout_timeout: 5
}

Related to #26898

@rails-bot

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @chancancode (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

@Paxa
Contributor
Paxa commented Nov 7, 2016

@matthewd is it how you think or it?

@Paxa Paxa changed the title from Add ActiveRecord::ConnectionAdapters::ConnectionPool.stat to Add ActiveRecord::Base.connection_pool.stat Nov 7, 2016
@matthewd
Member
matthewd commented Nov 8, 2016

👍

Wrap the method body in a synchronize do block to ensure the numbers are consistent.

@Paxa
Contributor
Paxa commented Nov 8, 2016

Done

+ synchronize do
+ {
+ max: size,
+ total: @connections.size,
@jrafanie
jrafanie Nov 8, 2016 Contributor

Great idea! Personal preference but max and total are a bit confusing to me. Naming is hard. We instantiate a pool with a "size". A pool contains "connections". Therefore, my poor naming would be:

size: size
connections: @connections.size

Either way, this is helpful!

@rafaelfranca
rafaelfranca Nov 8, 2016 Member

Yeah. I like the naming suggested by @jrafanie

@Paxa
Contributor
Paxa commented Nov 8, 2016

Changed to

{ size: 15, connections: 1, busy: 1, dead: 0, idle: 0, waiting: 0, checkout_timeout: 5 }

Also waiting: feels odd to me, because all other values related to connections, but waiting are consumers. Will it be better to name it as waiting_in_queue or queue?

@@ -581,6 +581,22 @@ def num_waiting_in_queue # :nodoc:
@available.num_waiting
end
+ # Return connection pool's usage statistic
+ # Example: <tt>{ size: 15, connections: 1, busy: 1, dead: 0, idle: 0, waiting: 0, checkout_timeout: 5 }</tt>
@rafaelfranca
rafaelfranca Nov 8, 2016 Member
# Example:
#
#    ActiveRecord::Base.connection_pool.stat # => { size: 15, connections: 1, busy: 1, dead: 0, idle: 0, waiting: 0, checkout_timeout: 5 }
@rafaelfranca
Member

Could you add a CHANGELOG entry and squash your commits?

@Paxa Paxa Add ActiveRecord::Base.connection_pool.stat
35b6898
@Paxa
Contributor
Paxa commented Nov 8, 2016

Done

@rafaelfranca rafaelfranca merged commit 1b16e4c into rails:master Nov 8, 2016

0 of 2 checks passed

continuous-integration/travis-ci/pr The Travis CI build could not complete due to an error
Details
codeclimate Code Climate is analyzing this code.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment