https://github.com/customink/is-it-up
A Ruby gem for adding a simple endpoint to see if your application "is up”.
https://github.com/customink/is-it-up
Last synced: 10 months ago
JSON representation
A Ruby gem for adding a simple endpoint to see if your application "is up”.
- Host: GitHub
- URL: https://github.com/customink/is-it-up
- Owner: customink
- License: mit
- Created: 2014-06-23T17:02:04.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2025-07-24T13:10:30.000Z (about 1 year ago)
- Last Synced: 2025-09-18T03:00:49.227Z (10 months ago)
- Language: Ruby
- Size: 42 KB
- Stars: 4
- Watchers: 75
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 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:
```ruby
% 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:
* [is_it_up](https://github.com/andhapp/is_it_up), a similar rack middleware.
* [fitter_happer](https://github.com/atmos/fitter_happier), a similar Rails plugin.