sidekiq-instrumentation 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25b3b21f6becf08c671e2ea732966e440cb6069a55b4a686998e9bc35b31e7b6
+  data.tar.gz: 5f123ced7f7e8abea18048085e83dfc932fdb779712d455d1c0b6d53c4c9c935
+SHA512:
+  metadata.gz: 2628bc838cd6eb2aaf60d6745adcdf40d80c48ea3ad789b498aba02da57b89839af1388eccdaa7dbfd4e40bef223a3f12b1edd5ded3e2fbdd8a7be971b6e8c92
+  data.tar.gz: f2aa11692bd31b2cc0d168dc64447c999ea063f55e838cc52649d3ef5ded5953c67b872312d4073248ea49d5c89e5bbd127df96c75b96db7b8e5a524e278cb57

data/.circleci/config.yml

@@ -0,0 +1,129 @@
+version: 2.1
+
+orbs:
+  gem: doximity/gem-publisher@0
+
+executors:
+  ruby-latest:
+    resource_class: small
+    docker:
+      - image: circleci/ruby:latest
+        environment:
+          BUNDLE_VERSION: "~> 1.17"
+
+# yaml anchor filters
+master_only: &master_only
+  filters:
+    branches:
+      only: master
+    tags:
+      ignore: /.*/
+pr_only: &pr_only
+  filters:
+    branches:
+      ignore: master
+    tags:
+      ignore: /.*/
+version_tags_only: &version_tags_only
+  filters:
+    branches:
+      ignore: /.*/
+    tags:
+      only: /^v.*/
+
+jobs:
+  build:
+    executor: ruby-latest
+    steps:
+      - checkout
+      - run:
+          name: Install Bundler specific version
+          command: |
+            gem install bundler --version "${BUNDLE_VERSION}" --force
+      - restore_cache:
+          keys:
+            - v1-bundle-{{ checksum "Gemfile.lock" }}-
+      - run:
+          name: Install Ruby Dependencies
+          command: bundle check --path=vendor/bundle || bundle install --local --frozen --path=vendor/bundle --jobs=4 --retry=3
+      - save_cache:
+          key: v1-bundle-{{ checksum "Gemfile.lock" }}-
+          paths:
+            - vendor/bundle
+      - run:
+          name: Run Tests
+          command: bundle exec rake ci:specs
+      - store_test_results:
+          name: Store test results
+          path: tmp/test-results
+      - run:
+          name: Run Rubocop
+          command: bundle exec rake ci:rubocop
+      - run:
+          name: Build documentation
+          command: bundle exec rake ci:doc
+      - store_artifacts:
+          name: Saves documentation
+          path: doc
+      - persist_to_workspace:
+          root: .
+          paths:
+            - vendor/bundle
+      
+
+workflows:
+  version: 2
+
+  trunk:
+    jobs:
+      - build:
+          <<: *master_only
+      - gem/build:
+          <<: *master_only
+          executor: ruby-latest
+          name: gem-build
+          requires:
+            - build
+
+  pull-requests:
+    jobs:
+      - build:
+          <<: *pr_only
+      - gem/build:
+          <<: *pr_only
+          executor: ruby-latest
+          name: gem-build
+          requires:
+            - build
+      - pre-release-approval:
+          <<: *pr_only
+          type: approval
+          requires:
+            - gem-build
+      - gem/publish:
+          <<: *pr_only
+          name: gem-publish
+          to_rubygems: true
+          pre_release: true
+          requires:
+            - pre-release-approval
+          context: artifact_publishing
+
+  final-release:
+    jobs:
+      - build:
+          <<: *version_tags_only
+      - gem/build:
+          <<: *version_tags_only
+          executor: ruby-latest
+          name: gem-build
+          requires:
+            - build
+      - gem/publish:
+          <<: *version_tags_only
+          name: gem-publish
+          to_rubygems: true
+          pre_release: false
+          requires:
+            - gem-build
+          context: artifact_publishing

data/.gitignore

@@ -0,0 +1,13 @@
+/.ruby-version
+/*.gem
+/.bundle/
+/.yardoc	
+/_yardoc/	
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle/
+
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,35 @@
+---
+  inherit_gem:
+    dox-style:
+    - ".rubocop.yml"
+  
+  Env/OutsideConfig:
+    Exclude:
+      - "./tasks/ci.rake"
+  
+  Env/UndefinedVar:
+    Exclude:
+      - "./tasks/ci.rake"
+  
+  Env/UseFetch:
+    Exclude:
+      - "./bin/*"
+  
+  Metrics/BlockLength:
+    Exclude:
+      - "./**/*_spec*.rb"
+      - "./*.gemspec"
+      - "./spec/*_helper*.rb"
+      - "./tasks/ci.rake"
+      - "Gemfile"
+  
+  Metrics/ModuleLength:
+    Exclude:
+      - "./**/*_spec*.rb"
+  
+  Metrics/MethodLength:
+    Exclude:
+      - "./**/*_spec*.rb"
+
+  Rails/ApplicationRecord:
+    Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+before_install: gem install bundler -v 1.15.4

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+
+Changelog
+=========
+
+## 1.1.0 05/27/2020
+  * Set up build pipeline with circleci and gem-publisher
+  * Fixed linting issues
+  * Renamed gem to `sidekiq-instrumentation`

data/CODE_OF_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 bodziomista@gmail.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,6 @@
+# frozen_string_literal: true
+
+# BEFORE changing this file, read https://wiki.doximity.com/articles/gemfile-maintenance
+source "https://artifacts.dox.support/repository/gems"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-instrumentation (1.1.0)
+      opentracing (>= 0.3.1)
+      sidekiq
+
+GEM
+  remote: https://artifacts.dox.support/repository/gems/
+  specs:
+    ast (2.4.0)
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    dox-style (1.3.0)
+      rubocop (~> 0.77)
+      rubocop-performance (~> 1.5.1)
+      rubocop-rails (~> 2.2.0)
+      rubocop-rspec (~> 1.37.0)
+    opentracing (0.3.2)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    rack (2.2.2)
+    rack-protection (2.0.8.1)
+      rack
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rdoc (6.2.1)
+    redis (4.1.4)
+    rexml (3.2.4)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.84.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    rubocop-rails (2.2.1)
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    rubocop-rspec (1.37.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    sdoc (1.1.0)
+      rdoc (>= 5.0)
+    sidekiq (6.0.7)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
+    test-tracer (1.2.1)
+      opentracing (~> 0.3.1)
+    tracing-matchers (1.3.0)
+      rspec (>= 2.0)
+      test-tracer (~> 1.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  dox-style
+  rake
+  rspec
+  rspec_junit_formatter
+  sdoc
+  sidekiq-instrumentation!
+  test-tracer (~> 1.0, >= 1.2.1)
+  tracing-matchers (~> 1.0, >= 1.3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,79 @@
+# Sidekiq::Tracer
+
+OpenTracing instrumentation for Sidekiq (both client, and server-side).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-opentracing'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-opentracing
+
+## Usage
+
+The gem hooks up into Sidekiq through [middlewares](https://github.com/mperham/sidekiq/wiki/Middleware) - similar to Rack. Both server-side, and client-side middlewares are supported.
+
+* Client-side middleware runs before the pushing of the job to Redis and injects the current span context into the job's metadata.
+* Server-side runs around job processing, extracts the context from the job metadata and creates a new span for the server-side proessing.
+
+To instrument Sidekiq (both sides), you need to specify at least a tracer instance and optionally an active span provider - a proc which returns a current active span. The gem plays nicely with [spanmanager](https://github.com/iaintshine/ruby-spanmanager).
+
+```ruby
+require "sidekiq-opentracing"
+
+Sidekiq::Tracer.instrument(tracer: OpenTracing.global_tracer,
+                           active_span: -> { OpenTracing.global_tracer.active_span })
+```
+
+And you are all set.
+
+The code below shows how to register and manage middlewares on your own.
+
+Server-side:
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Tracer::ClientMiddleware, tracer: OpenTracing.global_tracer
+  end
+
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Tracer::ServerMiddleware, tracer: OpenTracing.global_tracer
+  end
+end
+```
+
+Client-side:
+
+```ruby
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Tracer::ClientMiddleware, tracer: OpenTracing.global_tracer
+  end
+end
+```
+
+# Development
+
+## Gem documentation
+
+You can find the documentation by going to CircleCI, looking for the `build` job, going to Artifacts and clicking on `index.html`. A visual guide on this can be found in our wiki at [Gems Development: Where to find documentation for our gems](https://wiki.doximity.com/articles/gems-development-where-to-find-documentation-for-our-gems).
+
+## Gem development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+You can also run `bundle console` for an interactive prompt that will allow you to experiment.
+
+This repository uses a gem publishing mechanism on the CI configuration, meaning most work related with cutting a new
+version is done automatically.
+
+To release a new version, follow the [wiki instructions](https://wiki.doximity.com/articles/gems-development-releasing-new-versions).

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rspec/core/rake_task"
+
+FileList["tasks/*.rake"].each { |task| load task }
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/sidekiq/tracer.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+
+require "sidekiq/tracer/version"
+require "sidekiq/tracer/constants"
+require "sidekiq/tracer/commons"
+require "sidekiq/tracer/client_middleware"
+require "sidekiq/tracer/server_middleware"
+
+module Sidekiq
+  module Tracer
+    class << self
+      def instrument(tracer: OpenTracing.global_tracer, active_span: nil)
+        instrument_client(tracer: tracer, active_span: active_span)
+        instrument_server(tracer: tracer, active_span: active_span)
+      end
+
+      def instrument_client(tracer: OpenTracing.global_tracer, active_span: nil)
+        Sidekiq.configure_client do |config|
+          config.client_middleware { |chain| add_client_middleware(chain, tracer, active_span) }
+        end
+      end
+
+      def instrument_server(tracer: OpenTracing.global_tracer, active_span: nil)
+        Sidekiq.configure_server do |config|
+          config.client_middleware { |chain| add_client_middleware(chain, tracer, active_span) }
+          config.server_middleware { |chain| add_server_middleware(chain, tracer, active_span) }
+        end
+
+        return unless defined?(Sidekiq::Testing)
+
+        Sidekiq::Testing.server_middleware { |chain| add_server_middleware(chain, tracer, active_span) }
+      end
+
+      def add_client_middleware(chain, tracer, active_span)
+        chain.add Sidekiq::Tracer::ClientMiddleware, tracer: tracer, active_span: active_span
+      end
+
+      def add_server_middleware(chain, tracer, active_span)
+        chain.add Sidekiq::Tracer::ServerMiddleware, tracer: tracer, active_span: active_span
+      end
+    end
+  end
+end

data/lib/sidekiq/tracer/client_middleware.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Tracer
+    class ClientMiddleware
+      include Commons
+
+      attr_reader :tracer, :active_span
+
+      def initialize(tracer:, active_span:)
+        @tracer = tracer
+        @active_span = active_span
+      end
+
+      def call(_worker_class, job, _queue, _redis_pool)
+        span = build_span(job)
+
+        inject(span, job)
+
+        yield
+      rescue StandardError => e
+        tag_errors(span, e) if span
+        raise
+      ensure
+        span&.finish
+      end
+
+      private
+
+      def build_span(job)
+        tracer.start_span(operation_name(job),
+                          child_of: active_span.respond_to?(:call) ? active_span.call : active_span,
+                          tags: tags(job, "producer"))
+      end
+
+      def tag_errors(span, error)
+        span.set_tag("error", true)
+        span.log(event: "error", 'error.object': error)
+      end
+
+      def inject(span, job)
+        carrier = {}
+        tracer.inject(span.context, OpenTracing::FORMAT_TEXT_MAP, carrier)
+        job[TRACE_CONTEXT_KEY] = carrier
+      end
+    end
+  end
+end

data/lib/sidekiq/tracer/commons.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Tracer
+    module Commons
+      def operation_name(job)
+        job["class"]
+      end
+
+      def tags(job, kind)
+        {
+          "component" => "Sidekiq",
+          "span.kind" => kind,
+          "sidekiq.queue" => job["queue"],
+          "sidekiq.jid" => job["jid"],
+          "sidekiq.retry" => job["retry"].to_s,
+          "sidekiq.args" => job["args"].join(", ")
+        }
+      end
+    end
+  end
+end

data/lib/sidekiq/tracer/constants.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Tracer
+    TRACE_CONTEXT_KEY = "Trace-Context"
+  end
+end

data/lib/sidekiq/tracer/server_middleware.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Tracer
+    class ServerMiddleware
+      include Commons
+
+      attr_reader :tracer, :active_span
+
+      def initialize(tracer:, active_span:)
+        @tracer = tracer
+        @active_span = active_span
+      end
+
+      def call(_worker, job, _queue)
+        span = build_span(job)
+
+        yield
+      rescue StandardError => e
+        tag_errors(span, e) if span
+        raise
+      ensure
+        span&.finish
+      end
+
+      private
+
+      def build_span(job)
+        parent_span_context = extract(job)
+
+        follows_from = OpenTracing::Reference.follows_from(parent_span_context)
+
+        tracer.start_span(operation_name(job),
+                          references: [follows_from],
+                          tags: tags(job, "consumer"))
+      end
+
+      def tag_errors(span, error)
+        span.set_tag("error", true)
+        span.log(event: "error", 'error.object': error)
+      end
+
+      def extract(job)
+        carrier = job[TRACE_CONTEXT_KEY]
+        return unless carrier
+
+        tracer.extract(OpenTracing::FORMAT_TEXT_MAP, carrier)
+      end
+    end
+  end
+end

data/lib/sidekiq/tracer/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Tracer
+    VERSION = "1.1.0"
+  end
+end

data/lib/sidekiq_instrumentation.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "sidekiq/tracer"

data/sidekiq-instrumentation.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sidekiq/tracer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-instrumentation"
+  spec.version       = Sidekiq::Tracer::VERSION
+  spec.authors       = %w[iaintshine Doximity]
+  spec.email         = ["ops@doximity.com"]
+  spec.license       = "Apache-2.0"
+
+  spec.summary       = "OpenTracing instrumentation for Sidekiq."
+  spec.description   = ""
+  spec.homepage      = "https://github.com/doximity/ruby-sidekiq-tracer"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(bin|test|spec|features|vendor|tasks|tmp)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "opentracing", ">= 0.3.1"
+  spec.add_dependency "sidekiq"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "dox-style"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "sdoc"
+  spec.add_development_dependency "test-tracer", "~> 1.0", ">= 1.2.1"
+  spec.add_development_dependency "tracing-matchers", "~> 1.0", ">= 1.3.0"
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-instrumentation
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- iaintshine
+- Doximity
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !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.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: dox-style
+  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: '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: rspec_junit_formatter
+  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: sdoc
+  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: test-tracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: tracing-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: ''
+email:
+- ops@doximity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/sidekiq/tracer.rb
+- lib/sidekiq/tracer/client_middleware.rb
+- lib/sidekiq/tracer/commons.rb
+- lib/sidekiq/tracer/constants.rb
+- lib/sidekiq/tracer/server_middleware.rb
+- lib/sidekiq/tracer/version.rb
+- lib/sidekiq_instrumentation.rb
+- sidekiq-instrumentation.gemspec
+homepage: https://github.com/doximity/ruby-sidekiq-tracer
+licenses:
+- Apache-2.0
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: OpenTracing instrumentation for Sidekiq.
+test_files: []