sidekiq-gelf 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3369600b6f033ab0be05cf913a3185e279d4161
-  data.tar.gz: fe0940b6754d0dad4008db0f227eef05c257944e
+  metadata.gz: 0161085b4bfbd7f4835b5c1158abaed97562c28a
+  data.tar.gz: 9764d0c63c041f58b5708ad7337e422ff2dac164
 SHA512:
-  metadata.gz: 3013683629056cfdbc54c8044f0cb5a2e38b1652678ce3b1fc15a8a8592f852e4c970ef329234ba89ad7f300be8d38b84bb6678fdd47fb5cf4d9d5f428e82a01
-  data.tar.gz: 12e263f7bae80326bb2e13e97be9b1312f4a53c37a14aa949a453930188f78e7c085f5f9e6cd55b048792b34ddff2497f35d38137d339c6158d5efa31497e207
+  metadata.gz: 457ccf8317313e94edca9a7d8a0da5cfd268e50d7b474451dc58bfa19b889772ae5e9c27611ee6d7acd2b78e17b2a429363199f3b03210d713d3567d359743bf
+  data.tar.gz: a150d03466d764bd25f7d9478ad0c83b322c95db65c8b7d50333bbb35638e98f9331d111d61a63548def235428fc543b9b72fdadbc973ff932aaa94870542b2d

data/README.md

@@ -2,13 +2,21 @@
 
 Enables Sidekiq logging to a GELF-supported server, such as Graylog2.
 
-**Note:** at this time, you must use [this version](https://github.com/layervault/gelf-rb) of gelf-rb. The main version does not have formatted logging support yet.
-
 ## Usage
 
 ``` ruby
-# Replace the sidekiq logger with gelf-rb and set the formatter
+# Adds the GELF logger as middleware in Sidekiq in order
 # to include important logging information.
 # These arguments are passed through to gelf-rb.
 Sidekiq::Logging::GELF.hook!('127.0.0.1', 12201, 'LAN', facility: "my-application")
+```
+
+**Note:** by default, normal logging is left as-is. If you wish to log only to the GELF input, you can do:
+
+``` ruby
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.remove Sidekiq::Middleware::Server::Logging
+  end
+end
 ```

data/lib/sidekiq-gelf.rb

@@ -2,7 +2,7 @@ require 'logger'
 require 'gelf'
 require 'sidekiq'
 
-require 'sidekiq-gelf/formatter'
+require 'sidekiq-gelf/middleware'
 
 module Sidekiq
   module Logging
@@ -10,8 +10,11 @@ module Sidekiq
       extend self
 
       def hook!(*args)
-        Sidekiq::Logging.logger = ::GELF::Logger.new(*args)
-        Sidekiq::Logging.logger.formatter = Formatter.new
+        Sidekiq.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.add Middleware::Server::GELFLogging, *args
+          end
+        end
       end
     end
   end

data/lib/sidekiq-gelf/middleware.rb

@@ -0,0 +1,83 @@
+module Sidekiq
+  module Middleware
+    module Server
+      class GELFLogging
+        def initialize(*args)
+          @args = *args
+        end
+
+        def call(worker, item, queue)
+          Sidekiq::Logging.with_context("#{worker.class.to_s} JID-#{item['jid']}") do
+            begin
+              logger.info({
+                short_message: "Start: #{worker.class.to_s} JID-#{item['jid']}",
+                jid: item['jid'],
+                pid: pid,
+                tid: tid,
+                context: context,
+                worker: worker.class.to_s,
+                queue: queue,
+                params: item['args']
+              })
+
+              start = Time.now
+
+              yield # Pass the torch
+
+              logger.info({
+                short_message: "Done: #{worker.class.to_s} JID-#{item['jid']}",
+                jid: item['jid'],
+                pid: pid,
+                tid: tid,
+                context: context,
+                worker: worker.class.to_s,
+                queue: queue,
+                params: item['args'],
+                runtime: elapsed(start)
+              })
+            rescue Exception => e
+              logger.error({
+                short_message: "Fail: #{worker.class.to_s} JID-#{item['jid']}",
+                jid: item['jid'],
+                pid: pid,
+                tid: tid,
+                context: context,
+                worker: worker.class.to_s,
+                queue: queue,
+                params: item['args'],
+                runtime: elapsed(start),
+                exception_class: e.class.to_s,
+                exception_message: e.message,
+                backtrace: e.backtrace.join("\n")
+              })
+
+              raise e
+            end
+          end
+        end
+
+        def logger
+          @logger ||= ::GELF::Logger.new(*@args)
+        end
+
+        private
+
+        def pid
+          Process.pid
+        end
+
+        def tid
+          Thread.current.object_id.to_s(36)
+        end
+
+        def context
+          Thread.current[:sidekiq_context]
+        end
+
+        def elapsed(start)
+          (Time.now - start).to_f.round(3)
+        end
+      end
+    end
+  end
+end

data/sidekiq-gelf.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "sidekiq-gelf"
-  s.version = "0.0.2"
+  s.version = "1.0.0"
 
   s.author = "Ryan LeFevre"
   s.date = "2014-04-21"
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.summary = "Format Sidekiq log messages for a GELF-supported logging server like Graylog2"
   s.license = 'MIT'
 
-  s.add_dependency "gelf", '~> 1.5'
+  s.add_dependency "gelf", '>= 1.4'
   s.add_dependency "sidekiq", '~> 3'
 
   s.add_development_dependency 'rake'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-gelf
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Ryan LeFevre
@@ -14,16 +14,16 @@ dependencies:
   name: gelf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ files:
 - README.md
 - Rakefile
 - lib/sidekiq-gelf.rb
-- lib/sidekiq-gelf/formatter.rb
+- lib/sidekiq-gelf/middleware.rb
 - sidekiq-gelf.gemspec
 homepage: http://github.com/layervault/sidekiq-gelf-rb
 licenses:

data/lib/sidekiq-gelf/formatter.rb

@@ -1,15 +0,0 @@
-module Sidekiq
-  module Logging
-    module GELF
-      class Formatter < Logger::Formatter
-        def call(severity, time, facility, message)
-          message.merge({
-            pid: Process.pid,
-            tid: Thread.current.object_id.to_s(36),
-            context: Thread.current[:sidekiq_context]
-          })
-        end
-      end
-    end
-  end
-end