Service::Status

Provides an object representing the status of a service, suitable for exposing as JSON as part of a REST api.

Installation

Add this line to your application's Gemfile:

gem 'service-status'

And then execute:

$ bundle

Or install it yourself as:

$ gem install service-status

Usage

status = ServiceStatus::Status.new("windows", '3.11', boot_time)
# boot_time is time the app was started

# check that we can connect to redis
redis_ok = true
begin
    Redis.new.ping
rescue
    redis_ok = false
end

#Last argument 'description' is optional
status.add_check('redis', redis_ok, 'Can connect to Redis')

#Last argument 'description' is optional
status.add_stat('request_count', 100, 'Number of Requests')

JSON.pretty_generate(status)             # render as JSON as required

Format

As below. Checks are always part of the 'checks' array. If they have failed, they are included in 'errors' as well.

'Status' is either "online" or "offline".

{
  "name": "windows",
  "version": "3.11",
  "hostname": "clippy",
  "stats": [{
    "name": "request_count",
    "value": 100,
    "description": "Number of Requests"
  }],
  "checks": [{
    "name": "redis",
    "successful": true
    "description": "Can connect to Redis"
  }],
  "timestamp": "2015-05-07 14:35:17",
  "uptime": "14d:23:11:21",
  "diskusage": "64%",
  "status": "online"
}

Contributing

Fork it ( https://github.com/[my-github-username]/service-status/fork )
git flow init -d (assuming you have git flow)
Create your feature branch (git flow feature start my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin feature/my-new-feature)
Create a new Pull Request

Copyright

See LICENSE (GPLv3)