resque-logstash 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b18485e48d33c757334ae4e942731d81d8aee89
+  data.tar.gz: 39750b6d4041405197fe1c13dc0cb9de91bb679c
+SHA512:
+  metadata.gz: 0cee284bd671941f94e7d5bade7d0c064a7336550f013925ce029e1923b08807f4eee0899f391f2c0e1658c7a5721357d57eace9cf3c8ac7b4b00bc9dbe7ce5e
+  data.tar.gz: 6a0840047311870353ad81c89d88efe03dc111f36f4e41a40bc48a6da4d506486e7eff907e1aeff1f7ddb0f6c9bd0566436b0e402ef4af8f53237aa57d6f1a6f

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eugene Pimenov
+
+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,42 @@
+# Resque::Logstash
+
+Logs duration of a resque job in logstash. At the moment only redis
+transport is supported.
+
+Depends on Resque 1.24
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'resque-logstash'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-logstash
+
+## Usage
+
+```ruby
+Resque::Plugins::Logstash.transport = Resque::Plugins::Logstash::Transport::Redis.new('localhost', 6379)
+
+class SomeJob
+  extend Resque::Plugins::Logstash
+
+  def self.perform
+    # do the heavy lifting here
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/resque/logstash/config.rb

@@ -0,0 +1,17 @@
+module Resque::Plugins
+  module Logstash
+    class Config
+      attr_accessor :transport, :disabled, :tags
+
+      def initialize
+        @transport = Transport::Redis.new('localhost', 6379)
+        @disabled = false
+        @tags = []
+      end
+
+      def disabled?
+        disabled
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Resque::Plugins
+  module Logstash
+    module Transport
+      class Redis
+        def initialize(host, port, key = 'logstash')
+          @host = host
+          @port = port
+          @key = key
+        end
+
+        attr_accessor :host, :port, :key
+
+        def redis
+          @redis ||= ::Redis.new(host: host, port: port)
+        end
+
+        def push(value)
+          redis.rpush @key, value.to_json
+        end
+      end
+    end
+  end
+end

data/lib/resque/logstash/version.rb

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

data/lib/resque/logstash.rb

@@ -0,0 +1,47 @@
+require "resque"
+require "logstash/event"
+require 'forwardable'
+
+require "resque/logstash/version"
+require 'resque/logstash/transport/redis'
+require 'resque/logstash/config'
+
+
+module Resque::Plugins
+  module Logstash
+    class << self
+      extend Forwardable
+
+      # support old API
+      def_delegators :config, :transport, :transport=, :tags, :tags=
+
+      def configure
+        yield config
+      end
+
+      def config
+        @config ||= Config.new
+      end
+    end
+
+    def around_perform_logstash_measure(*args)
+      started_at = Time.now
+      yield
+    ensure
+      logstash_push_duration Time.now - started_at, args
+    end
+
+    def logstash_push_duration(duration, args)
+      return if Logstash.config.disabled?
+      Logstash.config.transport.push logstash_create_event(duration, args)
+    end
+
+    def logstash_create_event(duration, args)
+      LogStash::Event.new "message" => "Job #{self.name} finished in #{duration}s",
+        "job" => self.name,
+        "duration" => duration,
+        "job_arguments" => args.map { |a| a.to_s },
+        "tags" => Logstash.config.tags
+    end
+  end
+end

data/resque-logstash.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque/logstash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resque-logstash"
+  spec.version       = Resque::Plugins::Logstash::VERSION
+  spec.authors       = ["Eugene Pimenov"]
+  spec.email         = ["eugene@libc.st"]
+  spec.description   = %q{Measure duration of a resque job and log it in the logstash}
+  spec.summary       = %q{A really simple logstash logger for resque}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency 'resque', '~> 1.24'
+  spec.add_dependency 'logstash-event', '~> 1.2'
+end

data/spec/logstash_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe Resque::Plugins::Logstash do
+  class JobLike
+    extend Resque::Plugins::Logstash
+  end
+
+  let(:job) { JobLike }
+
+  before do
+    Resque::Plugins::Logstash.transport = double(:push => nil)
+  end
+
+  it 'complient with resque plugin policy' do
+    expect { Resque::Plugin.lint(Resque::Plugins::Logstash) }.not_to raise_error
+  end
+
+  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), [])
+
+      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.around_perform_logstash_measure(:test, "blah") {} }.not_to raise_error
+    end
+  end
+
+  describe '#logstash_create_event' do
+    let(:event) { job.logstash_create_event 0.3, [:arg1, "arg2"] }
+
+    it 'puts classname as the job field' do
+      expect(event.fields['job']).to eq('JobLike')
+    end
+
+    it 'puts duration in the field' do
+      expect(event.fields['duration']).to eq(0.3)
+    end
+
+    it 'provides a nice message' do
+      expect(event['message']).to eq("Job JobLike finished in 0.3s")
+    end
+
+    it 'adds tags' do
+      Resque::Plugins::Logstash.tags = %w{tag1 tag2}
+
+      expect(event.tags).to include(*%w{tag1 tag2})
+    end
+
+    it 'adds job arguments as Strings' do
+      expect(event.fields['job_arguments']).to eq(%w{arg1 arg2})
+    end
+  end
+
+  describe '#logstash_push_duration' do
+    it 'calls push on @transport' do
+      Resque::Plugins::Logstash.transport = double
+      expect(Resque::Plugins::Logstash.transport).to receive(:push)
+
+      job.logstash_push_duration(0.3, [])
+    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, [])
+
+      Resque::Plugins::Logstash.configure { |c| c.disabled = false }
+    end
+  end
+
+  describe '#configure' do
+    it 'yields' do
+      yielded = false
+      Resque::Plugins::Logstash.configure { yielded = true }
+      expect(yielded).to be_true
+    end
+
+    it 'yield config object' do
+      Resque::Plugins::Logstash.configure do |c|
+        %w{transport tags disabled}.each do |method|
+          expect(c).to respond_to("#{method}=")
+          expect(c).to respond_to("#{method}")
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'resque/logstash'

data/spec/transport/redis_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Resque::Plugins::Logstash::Transport::Redis do
+  let(:transport) { Resque::Plugins::Logstash::Transport::Redis.new('localhost', 6379) }
+
+  describe '#initialize' do
+    it 'accepts host, port and the key' do
+      transport = Resque::Plugins::Logstash::Transport::Redis.new('host', 42, 'key')
+      expect(transport.host).to eq('host')
+      expect(transport.port).to eq(42)
+      expect(transport.key).to eq('key')
+    end
+  end
+
+  describe '#push' do
+    it 'calls rpush on redis' do
+      expect(transport.redis).to receive(:rpush).with('logstash', '{"a":1}')
+
+      transport.push(a: 1)
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: resque-logstash
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Eugene Pimenov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-13 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
+email:
+- eugene@libc.st
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/resque/logstash.rb
+- lib/resque/logstash/config.rb
+- lib/resque/logstash/transport/redis.rb
+- lib/resque/logstash/version.rb
+- resque-logstash.gemspec
+- spec/logstash_spec.rb
+- spec/spec_helper.rb
+- spec/transport/redis_spec.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A really simple logstash logger for resque
+test_files:
+- spec/logstash_spec.rb
+- spec/spec_helper.rb
+- spec/transport/redis_spec.rb