PgbConnectionReaperRb

Gem created to handle K8S PGBouncer issue with gracefull shutdown by setting ttl on connections for PG adapter.

Installation

Add this line to your application's Gemfile:

gem 'pgb_connection_reaper_rb'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install pgb_connection_reaper_rb

Usage

• Install gem
• specify config for ttl/idle_timeout in your config/database.yml

    production:
      adapter: postgresql
      database: your_database
      username: your_username
      password: your_password
      host: your_host
      port: 5432
      pool: 5
      ttl: 300 
      idle_timeout: 300
  

Compatibility

This gem supports:

• Ruby: 3.1+
• ActiveRecord: 6.1+, 7.0+, 7.1+, 7.2+
• Rails: 6.1+, 7.0+, 7.1+, 7.2+

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Testing Multiple ActiveRecord Versions

This project uses Appraisal to test against multiple ActiveRecord versions:

# Install appraisal gemfiles
bundle exec appraisal install

# Run tests against all ActiveRecord versions
bundle exec appraisal rspec

# Run tests against a specific ActiveRecord version
bundle exec appraisal activerecord-7.1 rspec
bundle exec appraisal activerecord-7.0 rspec
bundle exec appraisal activerecord-6.1 rspec

Available appraisal configurations:

• activerecord-6.1 - ActiveRecord 6.1.x
• activerecord-7.0 - ActiveRecord 7.0.x
• activerecord-7.1 - ActiveRecord 7.1.x
• activerecord-7.2 - ActiveRecord 7.2.x

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pgb_connection_reaper_rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the PgbConnectionReaperRb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.