Kenko

Zero dependency library for adding health checks to any rack based projects.

Supported features:

1. custom health endpoint;
2. html/json pages by defauld;
3. custom checks;
4. specify checks for the each middleware;

Add this line to your application's Gemfile:

gem 'kenko'

And then execute:

$ bundle

Or install it yourself as:

$ gem install kenko

Health checks important thing for k8s and for understanding the current status of the server. Usually, ruby libraries have problems:

1. Specific checks for the framework (only rails usually);
2. Hard to add custom checks for project-specific logic (service communications or specific DB checks);
3. Default rack check just checks nothing;

That's why this library was born. It's a default core framework for creating health checks for specific libraries or frameworks like hanami, rails, siquel, mongoid, etc,

Step 1: define custom checks

require 'kenko'

Kenko::Container.register(:base) { :ok }
Kenko::Container.register(:database) { SQLConnection.execute }
Kenko::Container.register(:redis) { Redis.ping }

Step 2: add middleware

require 'sinatra/base'
require 'kenko/middleware'

class Web < Sinatra::Base
  use Kenko::Middleware, checks: :all, path: '/health'

  get '/' do
    'index'
  end
end

Step 3: open /health or /health.json and see result

SOON

SOON

SOON

SOON

Just register a new check before start rack server:

Kenko::Container.register(:good) { :ok }
Kenko::Container.register(:bad) { nil }
Kenko::Container.register(:servie) { Service.get(:ping).success? }

Run bundle install and rake spec to run the tests.

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/davydovanton/kenko. 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.

Everyone interacting in the Kenko project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.