sidekiq-tracer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e44e41b425b76ef703d37afa180e4276159dcce
+  data.tar.gz: '081e3ba96fcb5f23056264a22ab27289f7099311'
+SHA512:
+  metadata.gz: 61457298631770addafa03b7ab54249de66cceddff512eb275e9b4ee947876b01b76c3e64edfe14d758a5f86a39a87a375c637db726e2eaa37e771ee8a600795
+  data.tar.gz: 27126a9e38300aaa9f642adaadc7499399616e6ae9fad49280f8cb6af628492b6c7d417bb1fbc12aa815863cd3d5504f165a824ca31bf12989b2861897f3deff

data/.gitignore

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

data/.gitlab-ci.yml

@@ -0,0 +1,8 @@
+image: ruby:2.3
+before_script:
+  - apt-get update -qq
+  - ruby -v
+  - gem install bundler --no-ri --no-rdoc
+  - bin/setup
+tests:
+  script: bin/rake

data/CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sidekiqtracer@darrencoxall.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,71 @@
+[![build status](https://gitlab.com/dcoxall/sidekiq-tracer/badges/master/build.svg)](https://gitlab.com/dcoxall/sidekiq-tracer/commits/master)
+
+# Sidekiq Tracer
+
+Sidekiq Tracer aims to provide better logging for sidekiq jobs to make debugging issues easier. It does this by either generating a tracing id which is included in the logs. If a job is then created during the execution of another then the tracing id is passed down.
+
+On it's own it does little but when the tracing ID is pulled into logs then it becomes possible to follow complex chains of jobs when 1 worker will queue up multiple others.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-tracer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-tracer
+
+## Usage
+
+The easiest way to configure and use sidekiq-tracer is to add the following to you Gemfile
+
+```ruby
+gem "sidekiq-tracer", require: "sidekiq/tracer/auto"
+```
+
+This will then require and configure the gem in the standard way.
+
+If you want more control over the configuration however then include sidekiq-tracer in your Gemfile
+in the standard way and then use the following to enable it for Sidekiq.
+
+```ruby
+require "sidekiq/tracer"
+
+Sidekiq.logger.formatter = Sidekiq::Tracer::JsonLogFormatter.new
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Tracer::ClientMiddleware
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Tracer::ClientMiddleware
+  end
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Tracer::ServerMiddleware
+  end
+end
+```
+
+## 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.
+
+## Contributing
+
+First, please read and understand the Code of Conduct for this project. This project is open to contribution from all and to ensure that everyone feels welcome then following the code of conduct is very important.
+
+Bug reports and pull requests are welcome at https://gitlab.com/dcoxall/sidekiq-tracer.
+
+When reporting an issue be descriptive and provide as much information as possible to re-create it.
+
+When submitting a pull request then feel free to create the request early and ask for feedback or advice. New additions should be covered with tests and the community should be more than happy to help if you are unsure how best to achieve that.

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,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/tracer"
+require "pry"
+
+Pry.start

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/sidekiq/tracer/auto.rb

@@ -0,0 +1,18 @@
+require "sidekiq/tracer"
+
+Sidekiq.logger.formatter = Sidekiq::Tracer::JsonLogFormatter.new
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Tracer::ClientMiddleware
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Tracer::ClientMiddleware
+  end
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Tracer::ServerMiddleware
+  end
+end

data/lib/sidekiq/tracer/client_middleware.rb

@@ -0,0 +1,20 @@
+module Sidekiq
+  module Tracer
+    class ClientMiddleware
+      def call(_worker_class, job, _queue, _redis_pool)
+        job["root_trace"] = root_trace
+        yield
+      end
+
+      private
+
+      def root_trace
+        if Thread.current[:sidekiq_root_trace] &&
+            Thread.current[:sidekiq_root_trace].last
+          return Thread.current[:sidekiq_root_trace].last
+        end
+        SecureRandom.uuid
+      end
+    end
+  end
+end

data/lib/sidekiq/tracer/json_log_formatter.rb

@@ -0,0 +1,42 @@
+require "multi_json"
+
+module Sidekiq
+  module Tracer
+    class JsonLogFormatter < ::Logger::Formatter
+      def initialize(pretty: false)
+        @pretty = !!pretty
+      end
+
+      def call(severity, time, _progname, msg)
+        MultiJson.dump({
+          tms: time.utc.iso8601(3),
+          pid: pid,
+          tid: format("TID-%s", thread_id),
+          cxt: context,
+          sev: severity,
+          msg: msg,
+          trc: trace,
+        }, pretty: @pretty)
+      end
+
+      private
+
+      def pid
+        ::Process.pid
+      end
+
+      def thread_id
+        Thread.current.object_id.to_s(36)
+      end
+
+      def context
+        Thread.current[:sidekiq_context]
+      end
+
+      def trace
+        trace_id = Thread.current[:sidekiq_root_trace]
+        trace_id.last unless trace_id.nil?
+      end
+    end
+  end
+end

data/lib/sidekiq/tracer/server_middleware.rb

@@ -0,0 +1,19 @@
+module Sidekiq
+  module Tracer
+    class ServerMiddleware
+      def call(worker, msg, queue)
+        with_trace(msg["root_trace"]) { yield }
+      end
+
+      private
+
+      def with_trace(value)
+        Thread.current[:sidekiq_root_trace] ||= []
+        Thread.current[:sidekiq_root_trace] << value unless value.nil?
+        yield
+      ensure
+        Thread.current[:sidekiq_root_trace].pop
+      end
+    end
+  end
+end

data/lib/sidekiq/tracer/version.rb

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

data/lib/sidekiq/tracer.rb

@@ -0,0 +1,9 @@
+require "sidekiq/tracer/version"
+require "sidekiq/tracer/json_log_formatter"
+require "sidekiq/tracer/client_middleware"
+require "sidekiq/tracer/server_middleware"
+
+module Sidekiq
+  module Tracer
+  end
+end

data/sidekiq-tracer.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/tracer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-tracer"
+  spec.version       = Sidekiq::Tracer::VERSION
+  spec.authors       = ["Darren Coxall"]
+  spec.email         = ["darren@darrencoxall.com"]
+
+  spec.summary       = %q{Sidekiq middleware to better trace how jobs are executed}
+  spec.description   = %q{Sidekiq middleware that adds JSON logging and job tracing for better debugging}
+  spec.homepage      = "https://gitlab.com/dcoxall/sidekiq-tracer"
+
+  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_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry", "> 0"
+  spec.add_development_dependency "timecop", "~> 0.8.0"
+  spec.add_runtime_dependency     "sidekiq", ">= 2.0"
+  spec.add_runtime_dependency     "multi_json", "~> 1.0"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-tracer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Darren Coxall
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-24 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Sidekiq middleware that adds JSON logging and job tracing for better
+  debugging
+email:
+- darren@darrencoxall.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- lib/sidekiq/tracer.rb
+- lib/sidekiq/tracer/auto.rb
+- lib/sidekiq/tracer/client_middleware.rb
+- lib/sidekiq/tracer/json_log_formatter.rb
+- lib/sidekiq/tracer/server_middleware.rb
+- lib/sidekiq/tracer/version.rb
+- sidekiq-tracer.gemspec
+homepage: https://gitlab.com/dcoxall/sidekiq-tracer
+licenses: []
+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.2
+signing_key: 
+specification_version: 4
+summary: Sidekiq middleware to better trace how jobs are executed
+test_files: []