juan_pelota 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 775db30433abf9c077d94b7f31005eaf7bf27511
+  data.tar.gz: 87c6efdefee9cc7b2f06a85283508433427c206e
+SHA512:
+  metadata.gz: f6151cfaece2183e9f03ea56c233330ada563c71a13aca7987d67674697f194a713ff6397d2bd3b2557b0a1f0d767b872e797d204babd50a2acaf4ec4982e475
+  data.tar.gz: 54c8a9a2c8ae575dd61dc15ba7901c6bf813c8afedff37261c936a29ddf39e6c9ce695e245cecb4101f964cdd847c413e36704cd07155c92695abfa7b8c2c50d

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jeff Felchner
+
+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,63 @@
+# JuanPelota
+
+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.
+
+### Example log entry:
+
+```json
+{
+  "@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
+}
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'juan_pelota'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install juan_pelota
+```
+
+## Usage
+
+Add this to your Sidekiq configuration:
+
+```ruby
+require 'juan_pelota'
+
+Sidekiq.logger.formatter = JuanPelota::Logger.new
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/juan_pelota/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 @@
+require 'bundler/gem_tasks'

data/lib/juan_pelota.rb

@@ -0,0 +1,2 @@
+require 'juan_pelota/middlewares/logging'
+require 'juan_pelota/logger'

data/lib/juan_pelota/logger.rb

@@ -0,0 +1,90 @@
+require 'juan_pelota/version'
+require 'juan_pelota'
+require 'json'
+
+module  JuanPelota
+class   Logger < Sidekiq::Logging::Pretty
+  attr_accessor :severity,
+                :timestamp,
+                :program_name,
+                :raw_message
+
+  def call(severity, time, program_name, message)
+    self.severity     = severity
+    self.timestamp    = time.utc.iso8601
+    self.program_name = program_name
+    self.raw_message  = message
+
+    {
+      '@type'      => 'sidekiq',
+      '@timestamp' => timestamp,
+      '@status'    => status,
+      '@severity'  => severity.downcase,
+      '@run_time'  => run_time,
+      '@message'   => message,
+      '@fields'    => {
+        pid:          self.class.pid,
+        tid:          self.class.tid,
+        context:      context,
+        program_name: program_name,
+        worker:       worker_name,
+        arguments:    arguments,
+      },
+    }.to_json + "\n"
+  end
+
+  private
+
+  def raw_message
+    if @raw_message.is_a? Hash
+      @raw_message
+    elsif @raw_message.respond_to?(:match) &&
+          @raw_message.match(/^queueing/)
+      {
+        'status' => 'queueing',
+        'class'  => @raw_message.split(' ')[1],
+      }
+    else
+      {
+        'message' => @raw_message,
+      }
+    end
+  end
+
+  def status
+    return 'exception' if message.is_a? Exception
+
+    if raw_message['retry']
+      'retry'
+    elsif raw_message['status']
+      raw_message['status']
+    else
+      'dead'
+    end
+  end
+
+  def message
+    raw_message['message']
+  end
+
+  def arguments
+    raw_message['args']
+  end
+
+  def run_time
+    raw_message['run_time']
+  end
+
+  def worker_name
+    raw_message['class']
+  end
+
+  def self.pid
+    ::Process.pid
+  end
+
+  def self.tid
+    ::Thread.current.object_id.to_s(36)
+  end
+end
+end

data/lib/juan_pelota/middlewares/logging.rb

@@ -0,0 +1,50 @@
+module  JuanPelota
+module  Middlewares
+class   Logging
+  # rubocop:disable Lint/RescueException, Metrics/AbcSize
+  def call(worker, job, _queue)
+    start = Time.now
+
+    logger.info(
+      'status'   => 'start',
+      'jid'      => job['jid'],
+      'bid'      => job['bid'],
+      'run_time' => nil,
+      'class'    => worker.class.to_s,
+      'args'     => job['args'],
+    )
+
+    yield
+
+    logger.info(
+      'status'   => 'done',
+      'jid'      => job['jid'],
+      'bid'      => job['bid'],
+      'run_time' => elapsed(start),
+      'class'    => worker.class.to_s,
+      'args'     => job['args'],
+    )
+  rescue Exception
+    logger.info(
+      'status'   => 'fail',
+      'jid'      => job['jid'],
+      'bid'      => job['bid'],
+      'run_time' => elapsed(start),
+      'class'    => worker.class.to_s,
+      'args'     => job['args'],
+    )
+
+    raise
+  end
+  # rubocop:enable Lint/RescueException, Metrics/AbcSize
+
+  def elapsed(start)
+    (Time.now - start).to_f.round(3)
+  end
+
+  def logger
+    Sidekiq.logger
+  end
+end
+end
+end

data/lib/juan_pelota/version.rb

@@ -0,0 +1,3 @@
+module JuanPelota
+  VERSION = '0.0.2'
+end

data/spec/juan_pelota/logger_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+module    JuanPelota
+describe  Logger do
+  it 'takes message as a hash and logs what we want', :time_mock do
+    json = JuanPelota::Logger.new.call('high',
+                                       Time.now.utc,
+                                       'our tests',
+                                       'args'     => 'my_args',
+                                       'class'    => 'my_worker',
+                                       'run_time' => 100,
+                                       'message'  => 'my message',
+                                       'status'   => 'my_status')
+
+    json_data = JSON.parse(json)
+
+    expect(json_data).to include(
+      '@type'      => 'sidekiq',
+      '@timestamp' => '2012-07-26T18:00:00Z',
+      '@status'    => 'my_status',
+      '@severity'  => 'high',
+      '@run_time'  => 100,
+      '@message'   => {
+        'args'     => 'my_args',
+        'class'    => 'my_worker',
+        'run_time' => 100,
+        'message'  => 'my message',
+        'status'   => 'my_status',
+      },
+      '@fields'    => include(
+        'pid'          => be_a(Integer),
+        'tid'          => match(/[a-z0-9]+/),
+        'context'      => nil,
+        'program_name' => 'our tests',
+        'worker'       => 'my_worker',
+        'arguments'    => 'my_args',
+      ),
+    )
+  end
+
+  it 'take message as a string and picks up if its a worker that is being queued',
+     :time_mock do
+
+    json = JuanPelota::Logger.new.call('high',
+                                       Time.now.utc,
+                                       'our tests',
+                                       'queueing MyWorkerClass')
+
+    json_data = JSON.parse(json)
+
+    expect(json_data).to include(
+      '@status'  => 'queueing',
+      '@message' => 'queueing MyWorkerClass',
+      '@fields'  => include(
+        'worker'       => 'MyWorkerClass',
+      ),
+    )
+  end
+
+  it 'set the status to dead and returns a nil worker if it gets a string without ' \
+     '"queueing" in the message',
+     :time_mock do
+
+    json = JuanPelota::Logger.new.call('high',
+                                       Time.now.utc,
+                                       'our tests',
+                                       'My Message')
+
+    json_data = JSON.parse(json)
+
+    expect(json_data).to include(
+      '@status'  => 'dead',
+      '@message' => 'My Message',
+      '@fields'  => include(
+        'worker'       => nil,
+      ),
+    )
+  end
+
+  it 'set the status to "Exception" if the message is one', :time_mock do
+    json = JuanPelota::Logger.new.call('high',
+                                       Time.now.utc,
+                                       'our tests',
+                                       Exception.new)
+
+    json_data = JSON.parse(json)
+
+    expect(json_data).to include(
+      '@status' => 'exception',
+    )
+  end
+
+  it 'sets the status to retry if retry is passed in as key to the message', :time_mock do
+    json = JuanPelota::Logger.new.call('high',
+                                       Time.now.utc,
+                                       'our tests',
+                                       'retry' => true)
+
+    json_data = JSON.parse(json)
+
+    expect(json_data).to include(
+      '@status' => 'retry',
+    )
+  end
+end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspectacular'
+require 'sidekiq'
+require 'juan_pelota'

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: juan_pelota
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- thekompanee
+- goodscout
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspectacular
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.0
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+description: ''
+email: scoutsquad@goodscout.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/juan_pelota.rb
+- lib/juan_pelota/logger.rb
+- lib/juan_pelota/middlewares/logging.rb
+- lib/juan_pelota/version.rb
+- spec/juan_pelota/logger_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/goodscout/juan_pelota
+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: Log Sidekiq messages in JSON format
+test_files:
+- spec/juan_pelota/logger_spec.rb
+- spec/spec_helper.rb
+has_rdoc: