Checks is a simple API wrapper for health check services, Ala healthchecks.io and Dead Man's Snitch.
Currently we only support healthchecks.io, but we're open to any service you can wish to use.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install checks
Designed for use within Rails, to use, add a file in
config/checks.yml with roughly the following format:
--- checks: group: key_a: "uuid-goes-here" other: key_b: "uuid-goes-here"
other are groups, and each pair underneath is a key combined with a healthchecks.io UUID. It's designed
to be the id-relevant to the specific healthcehck service.
Then, in your code, to trigger a checkin:
Checks.checkin :other, :key_b
This version will fail silently with an unknown group or key. If you want to to fail with an exception, instead use:
Checks.checkin! :other, :key_b
Finally, to invoke a manual specific id (e.g. from code):
Note that currently it is tied to healthchecks.io, but the plan is to add support for other services longer term.
After checking out the repo, run
bin/setup to install dependencies. You can also run
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To release a new version, update the version number in
version.rb, and then run
bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the
.gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/gyde-tv/checks. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.