sidekiq-logging-json 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc9b1930649549a4d84514f6c00e608b7cb9955b
+  data.tar.gz: f05ea0ec054aa1f083b42cc32b3fda446db1b63e
+SHA512:
+  metadata.gz: f136cdbf07b220d7684a4c3950937a0a8324ec3cae569df404bed9c09ef80d73984c230b01b0bf6c7faae3d0841b9077fa86479c914dcab8669ee89670505cc7
+  data.tar.gz: 7ff1aa34324ef09722def61c81f89ed59b2802c67b1705ba2c208635a32e7f4bd2b80323aca3cdd62da525847274ec60f8b1d35a0c17937aa719840e3525e17d

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-logging-json.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Wouter de Vos
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# Sidekiq::Logging::Json
+
+At [Springest](http://www.springest.com), we use
+[Logstash](http://logstash.net/) to ship all our logs to
+[Elasticsearch](http://www.elasticsearch.org/). An Elasticsearch index
+consists of JSON documents. To make it possible to make fine grained
+queries on [Sidekiq](http://sidekiq.org/) logs, we needed logging in
+JSON format. This gem contains that logger.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-logging-json'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install sidekiq-logging-json
+```
+
+## Usage
+
+Add this to your Sidekiq configuration:
+
+```ruby
+require 'sidekiq/logging/json'
+
+Sidekiq.logger.formatter = Sidekiq::Logging::Json::Logger.new
+```
+
+## Contributing
+
+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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/sidekiq/logging/json.rb

@@ -0,0 +1,38 @@
+require "sidekiq/logging/json/version"
+require "sidekiq/logging/json"
+require "json"
+
+module Sidekiq
+  module Logging
+    module Json
+      class Logger < Sidekiq::Logging::Pretty
+        # Provide a call() method that returns the formatted message.
+        def call(severity, time, program_name, message)
+          {
+            '@timestamp' => time.utc.iso8601,
+            :pid => ::Process.pid,
+            :tid => "TID-#{Thread.current.object_id.to_s(36)}",
+            :context => "#{context}",
+            :severity => severity,
+            :program_name => program_name,
+            :type => 'sidekiq',
+            :status => nil,
+            :run_time => nil
+          }.merge(processed_message(message)).to_json
+        end
+
+        def process_message(message)
+          result = message.match(/INFO: (done|start)(: ([0-9\.]+) sec)?$/)
+
+          return { message: message } unless result
+
+          {
+            :message => message,                       # The full message
+            :status => result[1],                      # start or done
+            :run_time => result[3] && result[3].to_f   # run time in seconds
+          }
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/logging/json/version.rb

@@ -0,0 +1,7 @@
+module Sidekiq
+  module Logging
+    module Json
+      VERSION = "0.0.1"
+    end
+  end
+end

data/sidekiq-logging-json.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/logging/json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-logging-json"
+  spec.version       = Sidekiq::Logging::Json::VERSION
+  spec.authors       = ["Wouter de Vos"]
+  spec.email         = ["wouter@springest.com"]
+  spec.summary       = %q{Sidekiq JSON log format, e.g. for Logstash.}
+  spec.description   = <<-DESC
+At Springest, we use Logstash to ship all our logs to Elasticsearch. 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.
+DESC
+  spec.homepage      = "https://github.com/Springest/Sidekiq-Logging-JSON"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "rspec", "~> 3"
+
+  spec.add_runtime_dependency "sidekiq", "~> 3"
+end

data/spec/sidekiq/logging/json_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe "Sidekiq::Logging::Json" do
+  describe "process_message" do
+    subject { Sidekiq::Logging::Json::Logger.new.process_message(logentry) }
+    let(:logentry) { "Some random message" }
+    let(:message) { subject[:message] }
+    let(:status) { subject[:status] }
+    let(:run_time) { subject[:run_time] }
+
+    it { expect( message ).to eq(logentry) }
+    it { expect( status ).to eq(nil) }
+    it { expect( run_time ).to eq(nil) }
+
+    context "start" do
+      let(:logentry) { "2014-06-05T12:38:55Z 8630 TID-osanfu5nw SubjectClickthroughTracker JID-e17a9e9ca0521bb74b423166 INFO: start" }
+
+      it { expect( message ).to eq(logentry) }
+      it { expect( status ).to eq("start") }
+      it { expect( run_time ).to eq(nil) }
+    end
+
+    context "done" do
+      let(:logentry) { "2014-06-05T12:38:42Z 8630 TID-osammcf2k TrainingIndexer::Work JID-177066e96052c2314dcad8c7 INFO: done: 51.579 sec" }
+
+      it { expect( message ).to eq(logentry) }
+      it { expect( status ).to eq("done") }
+      it { expect( run_time ).to eq(51.579) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'sidekiq'
+require 'sidekiq/logging/json'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-logging-json
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wouter de Vos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+description: |
+  At Springest, we use Logstash to ship all our logs to Elasticsearch. 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.
+email:
+- wouter@springest.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq/logging/json.rb
+- lib/sidekiq/logging/json/version.rb
+- sidekiq-logging-json.gemspec
+- spec/sidekiq/logging/json_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Springest/Sidekiq-Logging-JSON
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Sidekiq JSON log format, e.g. for Logstash.
+test_files:
+- spec/sidekiq/logging/json_spec.rb
+- spec/spec_helper.rb