fairchild / Sidekiq-Logging-JSON

Sidekiq JSON log format, e.g. for Logstash

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


An Elasticsearch index consists of JSON documents. To make it possible to make fine grained queries on Sidekiq logs, we needed logging in JSON format. This gem contains that logger.

Example log entry:

  "@timestamp": "2014-06-05T12:38:42Z",
  "pid": 8630,
  "tid": "TID-osammcf2k",
  "context": "TrainingIndexer::Work JID-177066e96052c2314dcad8c7",
  "severity": "INFO",
  "program_name": "TrainingIndexer::Work",
  "type": "sidekiq",
  "message": "2014-06-05T12:38:42Z 8630 TID-osammcf2k TrainingIndexer::Work JID-177066e96052c2314dcad8c7 INFO: done: 51.579 sec",
  "status": "done",
  "run_time": 51.579


Add this line to your application's Gemfile:

gem 'sidekiq-logging-json'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sidekiq-logging-json


Add this to your Sidekiq configuration:

require 'sidekiq/logging/json'

Sidekiq.logger.formatter = Sidekiq::Logging::Json::Logger.new


  1. Fork it ( https://github.com/[my-github-username]/sidekiq-logging-json/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request


Sidekiq JSON log format, e.g. for Logstash

License:MIT License


Language:Ruby 100.0%