Kiev

Kiev [](https://github.com/blacklane/kiev/actions?query=workflow%3A%22Main+CI%22) [](https://badge.fury.io/rb/kiev)

Kiev is a comprehensive logging library aimed at covering a wide range of frameworks and tools from the Ruby ecosystem:

• Rails
• Sinatra
• Rack and other Rack-based frameworks
• Sidekiq
• Que
• Shoryuken
• Her and other Faraday-based libraries
• HTTParty

The main goal of Kiev is consistent logging across distributed systems, like **tracking HTTP requests across various Ruby micro-services**. Kiev will generate and propagate request IDs and make it easy for you to identify service calls and branching requests, **including background jobs triggered by these requests**.

Aside from web requests and background jobs, which are tracked out of the box, Kiev makes it easy to append additional information or introduce **custom events**.

Kiev produces structured logs in the **JSON format**, which are ready to be ingested by ElasticSearch or other similar JSON-driven data stores. It eliminates the need for Logstash in a typical ELK stack.

In **development mode**, Kiev can print human-readable logs - pretty much like the default Rails logger, but including all the additional information that you've provided via Kiev events.

Install

Add the gem to your `Gemfile`:

gem "kiev"

Don't forget to `bundle install`.

Configure

Rails

Place your configuration under `config/initializers/kiev.rb`:

require "kiev"

Kiev.configure do |config|
  config.app = :my_app
  config.development_mode = Rails.env.development?
  config.log_path = Rails.root.join("log", "structured.log") unless Rails.env.development? || $stdout.isatty
end

The middleware stack is included automatically via a *Railtie*.

Sinatra

Somewhere in your code, ideally before the server configuration, add the following lines: