0.0
No commit activity in last 3 years
No release in over 3 years
A simple gem to check the health of a site
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.7
>= 0
>= 0
~> 10.0
>= 0
 Project Readme

OkHealthCheck

This gem provides a Rack app that responds to any request with a 200 status code and the text "OK". We suggest you mount it so it responds to requests from "/healthcheck" - in fact, if you use Rails, we do that for you.

Installation

Add this line to your application's Gemfile:

gem 'ok_health_check'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ok_health_check

Usage

Rails

Nothing to do here. Rails will automatically include a route /healthcheck that will return OK when requested.

If you want it to listen on some other endpoint, just add the following to your config/routes.rb file:

mount OkHealthCheck.new, at: "/<desired endpoint>"

Other Rack Apps (Sinatra, etc.)

require 'ok_health_check'

run Rack::URLMap.new \
  "/" => <Your app class>,
  "/healthcheck" => OkHealthCheck.new

Contributing

  1. Fork it ( https://github.com/[my-github-username]/ok_health_check/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request