Repository is archived
No commit activity in last 3 years
No release in over 3 years
A Rails 4 Engine for health checking your application
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

>= 4.0
 Project Readme

Rails Server Status Build Status Code Climate

Mount a Rack application, that will act as a health check that ELB, Varnish, etc can use to verify that the application is healthy

Installation

Add this line to your application's Gemfile:

gem 'rails_server_status'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rails_server_status

Usage

In config/routes.rb:

mount RailsServerStatus::Engine => "/server-status"

cURL the mounted endpoint:

curl http://localhost:3000/server-status

HTTP/1.1 200 OK
up 48699 1.14 192.168.50.206

As JSON:

curl -H "Accept: application/json" http://localhost:3000/server-status

HTTP/1.1 200 OK
{"database":"up","pid":52509,"uptime":1.16,"ip_address":"192.168.50.206"}

Requirements

  • Ruby 2.0.0-p247

Contributing

  1. Fork it
  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 new Pull Request