Skip to content

A Ruby gem for adding a simple endpoint to see if your application "is up”.

License

Notifications You must be signed in to change notification settings

customink/is-it-up

Repository files navigation

Is It Up?

A Ruby gem that adds a simple endpoint to see if your application "is up". The endpoint is handled via Rack middleware. A Railtie is provided for integration with Ruby on Rails apps.

Requirements

  • Ruby 2.2 or higher
  • Ruby on Rails 3.2 or higher

Installation

Add this line to your application's Gemfile:

gem 'is_it_up'

And then execute:

$ bundle

Or install it yourself as:

$ gem install is_it_up

Usage

IsItUp provides a monitoring URI that returns a JSON response:

% curl your-domain/is_it_up
{ "status": "ok", "code": 200 }

Contributing

  1. Fork it ( http://github.com/customink/is_it_up/fork )
  2. Run bin/bootstrap_macos (if using macOS) and bin/setup to ensure your environment is configured for development
  3. Run bin/test to ensure all tests pass
  4. Create your feature branch (git checkout -b my-new-feature)
  5. Commit your changes (git commit -am 'Add some feature')
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request

Kudos

Various ideas borrowed from: