No commit activity in last 3 years
No release in over 3 years
Adds "/health" endpoint to Rails app so it can be monitored
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.10
~> 0.6.3
~> 4.1
~> 10.0
 Project Readme

Wet::HealthEndpoint

Adds /health endpoint to Rails app so it can be monitored.

Installation

Add this line to your application's Gemfile:

gem 'wet-health_endpoint'

And then execute:

$ bundle

Or install it yourself as:

$ gem install wet-health_endpoint

Usage

$ curl -I http://example.com/health
HTTP/1.1 204 No Content
Cache-Control: no-cache
X-Request-Id: 89d3c0c8-0b5c-421b-83a1-757dd04fef30
X-Runtime: 0.000578
Connection: close

Also we've wrote a blogpost describing example usage of this gem.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/arkency/wet-health_endpoint.

License

The gem is available as open source under the terms of the MIT License.

About

Arkency

Health Endpoint is funded and maintained by Arkency. Check out our other open-source projects.

You can also hire us or read our blog.