sidekiq-slog 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e842a966cac561877e31c025cee57f4493d184f
+  data.tar.gz: 3ef4cd328fb14b99a7b3ab19d21f5f1c9214a854
+SHA512:
+  metadata.gz: 7ef9ae30819693b6561898feed119e16c2b05abf8bd1d10f238971b23172bb80969878b96b11168d5b267c895fb78fca98d1e31a5a92e61545423acb398add5e
+  data.tar.gz: 250ec0afee68cede16ba91d41a191abb70cff0c175351350143e05eef0a6563e55b2b99f3584bfe6a3bee0c0f091f75a9fbbad83fbc85123d878ca1efdf02d73

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yves Senn
+
+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,41 @@
+# Sidekiq::Slog
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sidekiq/slog`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-slog'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-slog
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sidekiq-slog.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/slog"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sidekiq-slog.rb

@@ -0,0 +1,24 @@
+require_relative 'sidekiq-slog/middleware'
+
+Sidekiq.configure_server do |config|
+  # Remove Sidekiqs default backtrace logging
+  unless Rails.env.development?
+    config.error_handlers.delete_if { |h| Sidekiq::ExceptionHandler::Logger === h }
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Slog::ClientMiddleware
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Slog::ClientMiddleware
+  end
+
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Slog::ServerMiddleware
+  end
+end

data/lib/sidekiq-slog/middleware.rb

@@ -0,0 +1,103 @@
+module Sidekiq
+  module Slog
+    def self.job_id(msg)
+      msg['jid']
+    end
+
+    def self.job_class(msg)
+      aj_job_class(msg) || msg['class']
+    end
+
+    def self.aj_job_class(msg)
+      msg['wrapped']
+    end
+
+    def self.job_args(msg)
+      args = msg['args']
+      aj_job_args(args) || args
+    end
+
+    def self.aj_job_args(args)
+      first_arg = args.first
+
+      # check if the first argument looks like a AJ metadata hash
+      if first_arg.is_a?(Hash) && first_arg.key?('arguments')
+        first_arg['arguments'].map do |arg|
+          if arg.is_a?(Hash) && arg.key?('_aj_globalid')
+            arg['_aj_globalid']
+          else
+            arg
+          end
+        end
+      end
+    end
+
+    class ClientMiddleware
+      def call(worker_class, msg, queue, _redis_pool)
+        context = {
+          queue: queue,
+          job_class: Sidekiq::Slog.job_class(msg),
+          job_id: Sidekiq::Slog.job_id(msg)
+        }
+        if at = msg['at']
+          context[:scheduled_at] = Time.at(at).utc
+          SLog.log('job_schedule', context)
+        else
+          context[:args] = Sidekiq::Slog.job_args(msg)
+          SLog.log('job_enqueue', context)
+        end
+        yield
+      end
+    end
+
+    class ServerMiddleware
+      def call(worker, msg, queue)
+        Thread.current[:aj_job_id] = Sidekiq::Slog.job_id(msg)
+        Thread.current[:aj_job_class] = Sidekiq::Slog.job_class(msg)
+
+        context = { queue: queue }
+
+        ts = Time.now.to_f
+        # We are currently not logging start events.
+        # This would most likely blow our SumoLogic limit.
+        # start context, ts
+        yield
+        stop context, msg, ts
+      rescue => ex
+        error context, ex, ts
+        raise ex
+      ensure
+        Thread.current[:aj_job_id] = nil
+        Thread.current[:aj_job_class] = nil
+      end
+
+      def start(context, _time)
+        SLog.log('job_start', context)
+      end
+
+      def error(context, error, start)
+        data = context.merge(
+          at: :error,
+          duration: duration_ms(start),
+          error: error.class.name,
+          message: error.message[/\A.+$/].inspect)
+        SLog.log('job_error', data)
+      end
+
+      def stop(context, _msg, start)
+        data = context.merge(
+          # It looks like this number is subject to clock drift.
+                             # TODO: Figure out a way to make this accurate.
+          # queued_duration: duration_ms(msg['enqueued_at'], start),
+                             duration: duration_ms(start))
+
+        SLog.log('job_stop', data)
+      end
+
+      def duration_ms(from, to = Time.now.to_f)
+        ((to - from) * 1000).round
+      end
+    end
+
+  end
+end

data/lib/sidekiq-slog/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Slog
+    VERSION = "0.0.1"
+  end
+end

data/sidekiq-slog.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq-slog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-slog"
+  spec.version       = Sidekiq::Slog::VERSION
+  spec.authors       = ["Yves Senn"]
+  spec.email         = ["yves.senn@gmail.com"]
+
+  spec.summary       = %q{Structured logging for Sidekiq}
+  spec.description   = %q{Implement a structured logging approach for sidekiq.}
+  spec.homepage      = "https://github.com/senny/sidekiq-slog"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq"
+  spec.add_dependency "rails"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-slog
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yves Senn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Implement a structured logging approach for sidekiq.
+email:
+- yves.senn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq-slog.rb
+- lib/sidekiq-slog/middleware.rb
+- lib/sidekiq-slog/version.rb
+- sidekiq-slog.gemspec
+homepage: https://github.com/senny/sidekiq-slog
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Structured logging for Sidekiq
+test_files: []
+has_rdoc: