resque-logstash 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b18485e48d33c757334ae4e942731d81d8aee89
-  data.tar.gz: 39750b6d4041405197fe1c13dc0cb9de91bb679c
+  metadata.gz: 8d7683274d9a2840ce11a0c75b7ccd636deed5f1
+  data.tar.gz: 2c06920d8aa5ef793360abc0d65d117ad0638466
 SHA512:
-  metadata.gz: 0cee284bd671941f94e7d5bade7d0c064a7336550f013925ce029e1923b08807f4eee0899f391f2c0e1658c7a5721357d57eace9cf3c8ac7b4b00bc9dbe7ce5e
-  data.tar.gz: 6a0840047311870353ad81c89d88efe03dc111f36f4e41a40bc48a6da4d506486e7eff907e1aeff1f7ddb0f6c9bd0566436b0e402ef4af8f53237aa57d6f1a6f
+  metadata.gz: 45f909fdba3149e175c47eb371444816e79a97bfaca0a2b533f6d79455781c3eda46289cd5e7cee91ea4a02a2733ae871ddd66446e727d2febd34b0886b99084
+  data.tar.gz: a527be77f93cc7bc6b9f746277d482ef139ccbc1f6c3cefede2e1cac616d67e271a450b3eabe8f6c01c50f047cfe7dde2172fdd08d961e95463e9cff928dede7

data/lib/resque/logstash.rb

@@ -27,21 +27,36 @@ module Resque::Plugins
     def around_perform_logstash_measure(*args)
       started_at = Time.now
       yield
+    rescue Exception => e
+      raise
     ensure
-      logstash_push_duration Time.now - started_at, args
+      logstash_push_duration Time.now - started_at, args, e
     end
 
-    def logstash_push_duration(duration, args)
+    def logstash_push_duration(duration, args, exception)
       return if Logstash.config.disabled?
-      Logstash.config.transport.push logstash_create_event(duration, args)
+      Logstash.config.transport.push logstash_create_event(duration, args, exception)
     end
 
-    def logstash_create_event(duration, args)
-      LogStash::Event.new "message" => "Job #{self.name} finished in #{duration}s",
+    def logstash_create_event(duration, args, exception)
+      if exception.nil?
+        params = {'status' => 'success'}
+        verb = 'finished'
+      else
+        params = {
+          'status' => 'failure',
+          'exception' => "#{exception.class}: #{exception.message}"
+        }
+        verb = 'failed'
+      end
+
+      params = params.merge "message" => "Job #{self.name} #{verb} in #{duration}s",
         "job" => self.name,
         "duration" => duration,
         "job_arguments" => args.map { |a| a.to_s },
         "tags" => Logstash.config.tags
+
+      LogStash::Event.new params
     end
   end
 end

data/lib/resque/logstash/transport/redis.rb

@@ -2,16 +2,37 @@ module Resque::Plugins
   module Logstash
     module Transport
       class Redis
-        def initialize(host, port, key = 'logstash')
-          @host = host
-          @port = port
+        def initialize(host, port = nil, key = 'logstash')
+          if host.is_a?(Hash)
+            initialize_with_keyword_arguments(host)
+          else
+            @redis_options = { host: host, port: port }
+            @key = key
+          end
+        end
+
+        def initialize_with_keyword_arguments(key: 'logstash', redis: nil, **redis_options)
           @key = key
+
+          if redis
+            @redis = redis
+          else
+            @redis_options = redis_options
+          end
         end
 
-        attr_accessor :host, :port, :key
+        attr_reader :key
 
         def redis
-          @redis ||= ::Redis.new(host: host, port: port)
+          @redis ||= ::Redis.new(@redis_options)
+        end
+
+        def host
+          @redis_options[:host]
+        end
+
+        def port
+          @redis_options[:port]
         end
 
         def push(value)

data/lib/resque/logstash/version.rb

@@ -1,7 +1,7 @@
 module Resque
   module Plugins
     module Logstash
-      VERSION = "0.0.2"
+      VERSION = "0.0.3"
     end
   end
 end

data/spec/logstash_spec.rb

@@ -17,19 +17,24 @@ describe Resque::Plugins::Logstash do
 
   describe '#around_perform_logstash_measure' do
     it 'calls logstash_push_time with the duration' do
-      expect(job).to receive(:logstash_push_duration).with(be_within(0.01).of(0.3), [])
+      expect(job).to receive(:logstash_push_duration).with(be_within(0.01).of(0.3), [], nil)
 
       job.around_perform_logstash_measure { sleep 0.3 }
     end
 
     it 'logs job arguments' do
-      expect(job).to receive(:logstash_push_duration).with(kind_of(Numeric), [:test, "blah"])
+      expect(job).to receive(:logstash_push_duration).with(kind_of(Numeric), [:test, "blah"], nil)
       expect { job.around_perform_logstash_measure(:test, "blah") {} }.not_to raise_error
     end
+
+    it 'logs errors' do
+      expect(job).to receive(:logstash_push_duration).with(anything, anything, kind_of(Exception))
+      expect { job.around_perform_logstash_measure { raise "hello" } }.to raise_error
+    end
   end
 
   describe '#logstash_create_event' do
-    let(:event) { job.logstash_create_event 0.3, [:arg1, "arg2"] }
+    let(:event) { job.logstash_create_event 0.3, [:arg1, "arg2"], nil }
 
     it 'puts classname as the job field' do
       expect(event.fields['job']).to eq('JobLike')
@@ -52,6 +57,30 @@ describe Resque::Plugins::Logstash do
     it 'adds job arguments as Strings' do
       expect(event.fields['job_arguments']).to eq(%w{arg1 arg2})
     end
+
+    it 'includes status' do
+      expect(event.fields['status']).to eq('success')
+    end
+
+    it 'does not include exception key' do
+      expect(event.fields).not_to include('exception')
+    end
+
+    context 'when called with an exception' do
+      let(:event) { job.logstash_create_event 0.3, [:arg1, "arg2"],  ArgumentError.new("test") }
+
+      it 'includes status' do
+        expect(event.fields['status']).to eq('failure')
+      end
+
+      it 'includes the exception' do
+        expect(event.fields['exception']).to eq("ArgumentError: test")
+      end
+
+      it 'provides a nice message' do
+        expect(event['message']).to eq("Job JobLike failed in 0.3s")
+      end
+    end
   end
 
   describe '#logstash_push_duration' do
@@ -59,14 +88,14 @@ describe Resque::Plugins::Logstash do
       Resque::Plugins::Logstash.transport = double
       expect(Resque::Plugins::Logstash.transport).to receive(:push)
 
-      job.logstash_push_duration(0.3, [])
+      job.logstash_push_duration(0.3, [], nil)
     end
 
     it 'does not push if disabled' do
       Resque::Plugins::Logstash.configure { |c| c.disabled = true }
 
       expect(Resque::Plugins::Logstash.transport).not_to receive(:push)
-      job.logstash_push_duration(0.3, [])
+      job.logstash_push_duration(0.3, [], nil)
 
       Resque::Plugins::Logstash.configure { |c| c.disabled = false }
     end
@@ -76,7 +105,7 @@ describe Resque::Plugins::Logstash do
     it 'yields' do
       yielded = false
       Resque::Plugins::Logstash.configure { yielded = true }
-      expect(yielded).to be_true
+      expect(yielded).to be true
     end
 
     it 'yield config object' do

data/spec/transport/redis_spec.rb

@@ -10,6 +10,20 @@ describe Resque::Plugins::Logstash::Transport::Redis do
       expect(transport.port).to eq(42)
       expect(transport.key).to eq('key')
     end
+
+    it 'accepts host, port and the key as keyword arguments' do
+      transport = Resque::Plugins::Logstash::Transport::Redis.new(host: 'host', port: 42, key: 'key')
+      expect(transport.host).to eq('host')
+      expect(transport.port).to eq(42)
+      expect(transport.key).to eq('key')
+    end
+
+    it 'accepts redis and key as the parameters' do
+      transport = Resque::Plugins::Logstash::Transport::Redis.new(redis: double(rpush: 1), key: 'key')
+      expect(transport.key).to eq('key')
+
+      transport.push(a: 1)
+    end
   end
 
   describe '#push' do

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: resque-logstash
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Eugene Pimenov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-13 00:00:00.000000000 Z
+date: 2015-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.24'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.24'
 - !ruby/object:Gem::Dependency
   name: logstash-event
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 description: Measure duration of a resque job and log it in the logstash
@@ -87,8 +87,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -111,17 +111,17 @@ 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.0.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A really simple logstash logger for resque