Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ankane/slowpoke
Rack::Timeout enhancements for Rails
https://github.com/ankane/slowpoke
Last synced: about 2 months ago
JSON representation
Rack::Timeout enhancements for Rails
- Host: GitHub
- URL: https://github.com/ankane/slowpoke
- Owner: ankane
- License: mit
- Created: 2014-10-22T04:35:43.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-06-10T04:15:50.000Z (3 months ago)
- Last Synced: 2024-07-10T17:15:10.818Z (2 months ago)
- Language: Ruby
- Homepage:
- Size: 84 KB
- Stars: 337
- Watchers: 7
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-rails-gem - Slowpoke - Rack::Timeout is great. Slowpoke makes it better. (Production / Security)
README
# Slowpoke
[Rack::Timeout](https://github.com/heroku/rack-timeout) enhancements for Rails
- safer service timeouts
- dynamic timeouts
- custom error pages
[](https://github.com/ankane/slowpoke/actions)
## Installation
Add this line to your application’s Gemfile:
```ruby
gem "slowpoke"
```
And run:
```sh
rails generate slowpoke:install
```
This creates a `public/503.html` you can customize.
## Development
To try out custom error pages in development, temporarily add to `config/environments/development.rb`:
```ruby
config.slowpoke.timeout = 1
config.consider_all_requests_local = false
```
And add a `sleep` call to one of your actions:
```ruby
sleep(2)
```
The custom error page should appear.
## Production
The default timeout is 15 seconds. You can change this in `config/environments/production.rb` with:
```ruby
config.slowpoke.timeout = 5
```
For dynamic timeouts, use:
```ruby
config.slowpoke.timeout = lambda do |env|
request = Rack::Request.new(env)
request.path.start_with?("/admin") ? 15 : 5
end
```
Subscribe to timeouts with:
```ruby
ActiveSupport::Notifications.subscribe "timeout.slowpoke" do |name, start, finish, id, payload|
# report timeout
end
```
To learn more, see the [Rack::Timeout documentation](https://github.com/heroku/rack-timeout).
## Safer Service Timeouts
Rack::Timeout can raise an exception at any point in the code, which can leave your app in an [unclean state](https://www.schneems.com/2017/02/21/the-oldest-bug-in-ruby-why-racktimeout-might-hose-your-server/). The safest way to recover from a request timeout is to spawn a new process. This is the default behavior for Slowpoke.
For threaded servers like Puma, this means killing all threads when any one of them times out. This can have a significant impact on performance.
You can customize this behavior with:
```ruby
Slowpoke.on_timeout do |env|
next if Rails.env.development? || Rails.env.test?
exception = env["action_dispatch.exception"]
if exception && exception.backtrace.first.include?("/active_record/")
Slowpoke.kill
end
end
```
Note: To access `env["action_dispatch.exception"]` in development, temporarily add to `config/environments/development.rb`:
```ruby
config.consider_all_requests_local = false
```
## Database Timeouts
It’s a good idea to set a [statement timeout](https://github.com/ankane/the-ultimate-guide-to-ruby-timeouts/#statement-timeouts-1) and a [connect timeout](https://github.com/ankane/the-ultimate-guide-to-ruby-timeouts/#activerecord). For Postgres, your `config/database.yml` should include something like:
```yml
production:
connect_timeout: 3 # sec
variables:
statement_timeout: 5s
```
## History
View the [changelog](https://github.com/ankane/slowpoke/blob/master/CHANGELOG.md)
## Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- [Report bugs](https://github.com/ankane/slowpoke/issues)
- Fix bugs and [submit pull requests](https://github.com/ankane/slowpoke/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
To get started with development:
```sh
git clone https://github.com/ankane/slowpoke.git
cd slowpoke
bundle install
bundle exec rake test
```