pliny-sidekiq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb79fb9d67b16721259bf2dd96c67be3641488c9
+  data.tar.gz: 60ff08f17f5ea9ac681ac44dd4e503f0edb56c9c
+SHA512:
+  metadata.gz: f657e177637640a732825faa13407bfcb5d5f6b18377f5b39bb833965be95cf399225838c882731616188670ccd090158093ff7c3f423f15290ca80805d01652
+  data.tar.gz: ab2ba97d3bc0c734b1f3b609b07149b4d2ab6156901347d69f312eaa3018118dbad5590999f12ce538718ea11552811f5952e1f21e3e1541c3b466e7ed7df76a

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Guðmundur Bjarni Ólafsson
+
+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,58 @@
+# Pliny::Sidekiq
+
+Sidekiq middlewares for making life nicer when using Pliny
+
+ - Passes `request_id`s to and between jobs.
+ - logfmts when jobs are enqueued and being processed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pliny-sidekiq'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pliny-sidekiq
+
+## Usage
+
+Create a `config/initializers/sidekiq.rb` and with the following contents
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Pliny::Sidekiq::Middleware::Server::RequestId
+    chain.add Pliny::Sidekiq::Middleware::Server::Log, metric_prefix: 'my-app'
+  end
+
+  config.client_middleware do |chain|
+    chain.add Pliny::Sidekiq::Middleware::Client::RequestId
+    chain.add Pliny::Sidekiq::Middleware::Client::Log
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Pliny::Sidekiq::Middleware::Client::RequestId
+    chain.add Pliny::Sidekiq::Middleware::Client::Log
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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/gudmundur/pliny-sidekiq.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pliny/sidekiq"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pliny/sidekiq.rb

@@ -0,0 +1,12 @@
+require "pliny/sidekiq/version"
+require "pliny/sidekiq/middleware/client/log"
+require "pliny/sidekiq/middleware/client/request_id"
+require "pliny/sidekiq/middleware/server/log"
+require "pliny/sidekiq/middleware/server/request_id"
+
+module Pliny
+  module Sidekiq
+    module Middleware
+    end
+  end
+end

data/lib/pliny/sidekiq/middleware/client/log.rb

@@ -0,0 +1,16 @@
+module Pliny::Sidekiq::Middleware
+  module Client
+    class Log
+      def call(worker_class, msg, queue, redis_pool)
+        yield.tap do
+          Pliny.log(
+            job:         msg['class'],
+            job_id:      msg['jid'],
+            enqueued:    true,
+            enqueued_at: Time.at(msg['enqueued_at'])
+          )
+        end
+      end
+    end
+  end
+end

data/lib/pliny/sidekiq/middleware/client/request_id.rb

@@ -0,0 +1,26 @@
+module Pliny::Sidekiq::Middleware
+  module Client
+    class RequestId
+      def call(worker_class, msg, queue, redis_pool)
+        @args = msg['args']
+        msg['request_ids'] = request_id.split(',') if request_id
+        yield
+      end
+
+      private
+
+      attr_reader :args
+
+      def request_id
+        @request_id ||=
+          request_id_args || Pliny::RequestStore.store[:request_id]
+      end
+
+      def request_id_args
+        return nil if !args.last.is_a?(Hash)
+        options = args.last
+        options[:request_id] || options['request_id']
+      end
+    end
+  end
+end

data/lib/pliny/sidekiq/middleware/server/log.rb

@@ -0,0 +1,35 @@
+module Pliny::Sidekiq::Middleware
+  module Server
+    class Log
+      def initialize(metric_prefix: nil)
+        @metric_prefix = metric_prefix
+      end
+
+      def call(worker, job, queue)
+        context = {
+          sidekiq: true,
+          job_id:  job['jid'],
+        }
+
+        Pliny.context(context) do
+          count("worker.#{worker.class.to_s.gsub('::', '.')}")
+          count("queue.#{queue}")
+
+          Pliny.log(job: job['class'], job_retry: job['retry']) do
+            yield
+          end
+        end
+      end
+
+      private
+
+      def count(key, value=1)
+        Pliny.log("count##{metric_prefix}sidekiq.#{key}" => value)
+      end
+
+      def metric_prefix
+        @metric_prefix.nil? ? '' : "#{@metric_prefix}."
+      end
+    end
+  end
+end

data/lib/pliny/sidekiq/middleware/server/request_id.rb

@@ -0,0 +1,18 @@
+module Pliny::Sidekiq::Middleware
+  module Server
+    class RequestId
+      def initialize(store: Pliny::RequestStore)
+        @store = store
+      end
+
+      def call(worker, job, queue)
+        @store.clear!
+        @store.seed({
+          'REQUEST_IDS' => job['request_ids']
+        }) if job.include?('request_ids')
+
+        yield
+      end
+    end
+  end
+end

data/lib/pliny/sidekiq/version.rb

@@ -0,0 +1,5 @@
+module Pliny
+  module Sidekiq
+    VERSION = "0.1.0"
+  end
+end

data/pliny-sidekiq.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pliny/sidekiq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pliny-sidekiq"
+  spec.version       = Pliny::Sidekiq::VERSION
+  spec.license       = 'MIT'
+  spec.authors       = ["Guðmundur Bjarni Ólafsson"]
+  spec.email         = ["gudmundur.bjarni@gmail.com"]
+
+  spec.summary       = %q{Pliny logging and request_id support for Sidekiq}
+  spec.homepage      = "https://github.com/gudmundur/pliny-sidekiq"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pliny"
+  spec.add_dependency "sidekiq"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: pliny-sidekiq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guðmundur Bjarni Ólafsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pliny
+  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: 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-byebug
+  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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: 
+email:
+- gudmundur.bjarni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pliny/sidekiq.rb
+- lib/pliny/sidekiq/middleware/client/log.rb
+- lib/pliny/sidekiq/middleware/client/request_id.rb
+- lib/pliny/sidekiq/middleware/server/log.rb
+- lib/pliny/sidekiq/middleware/server/request_id.rb
+- lib/pliny/sidekiq/version.rb
+- pliny-sidekiq.gemspec
+homepage: https://github.com/gudmundur/pliny-sidekiq
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Pliny logging and request_id support for Sidekiq
+test_files: []
+has_rdoc: