opentelemetry-instrumentation-sidekiq 0.5.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a4372caa4ce93660a0272de62ff47b1fd0f897b10e34b4c4713e86886dcb661
-  data.tar.gz: 454e13a799f4bcc980cc2cfc2f7d07380bec8be88005a2c09e1a109e95269874
+  metadata.gz: f1348a87123eadcb378d285875b8aa056d1504ba7570119fc0198798d0eab42d
+  data.tar.gz: 389b4b4c843538e106383f75c9eb82e17bc60b74952f5fdd9a6e39d3fa57e6f6
 SHA512:
-  metadata.gz: '08ca6e4746b64d3db1fe66a007427c2c79e95babfb38000365e4d1e76572979f7bab14775e1b53e59d49c41a577194454a98e08fe1aa4a33f359c6e99901a7d7'
-  data.tar.gz: acd6f8ec2c30bc02adb91e85c6ce5ea211c74e8f7ea6405e2ca98d384e4438ddc8b0144a350676a17ef91678d0fa92b5d6239de8611c6207452df24d0eb8622d
+  metadata.gz: 52f9e6cb70e5702f000af558efef43e3ad7389e5ccdb2b9c77b61cc5ca6b2d92588dedabc882dd90360f319ea93fddf3d3f53f9b4d062fe7aa3ccb1da2dd096b
+  data.tar.gz: a305271c481c84204b0adce8eb062ba0db0f8ade6204560fe2dd95c6652bbc12609319afd7906a9721d5f54930964939eb85dc9a7182ffaf42d629775cfa153a

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--title=OpenTelemetry Sidekiq Instrumentation
+--markup=markdown
+--main=README.md
+./lib/opentelemetry/instrumentation/**/*.rb
+./lib/opentelemetry/instrumentation.rb
+-
+README.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Release History: opentelemetry-instrumentation-sidekiq
+
+### v0.10.0 / 2020-12-03
+
+* (No significant changes)
+
+### v0.9.0 / 2020-11-27
+
+* BREAKING CHANGE: Add timeout for force_flush and shutdown 
+
+* ADDED: Add timeout for force_flush and shutdown 
+
+### v0.8.0 / 2020-10-27
+
+* (No significant changes)
+
+### v0.7.0 / 2020-10-07
+
+* DOCS: Adding README for Sidekiq instrumentation 
+* DOCS: Remove duplicate reference in Sidekiq README 
+* DOCS: Standardize toplevel docs structure and readme 
+
+### v0.6.0 / 2020-09-10
+
+* (No significant changes)

data/README.md

@@ -0,0 +1,52 @@
+# OpenTelemetry Sidekiq Instrumentation
+
+The Sidekiq instrumentation is a community-maintained instrumentation for the [Sidekiq][sidekiq-home] Ruby jobs system.
+
+## How do I get started?
+
+Install the gem using:
+
+```
+gem install opentelemetry-instrumentation-sidekiq
+```
+
+Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-sidekiq` in your `Gemfile`.
+
+## Usage
+
+To use the instrumentation, call `use` with the name of the instrumentation:
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::Sidekiq'
+end
+```
+
+Alternatively, you can also call `use_all` to install all the available instrumentation.
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use_all
+end
+```
+## Examples
+
+Example usage can be seen in the `./example/sidekiq.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby/blob/master/instrumentation/sidekiq/example/sidekiq.rb)
+
+## How can I get invovled?
+
+The `opentelemetry-instrumentation-sidekiq` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
+
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+
+## License
+
+The `opentelemetry-instrumentation-sidekiq` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
+
+[sidekiq-home]: https://github.com/mperham/sidekiq
+[bundler-home]: https://bundler.io
+[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/master/LICENSE
+[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
+[community-meetings]: https://github.com/open-telemetry/community#community-meetings
+[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby

data/lib/opentelemetry/instrumentation.rb

@@ -4,6 +4,12 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+# OpenTelemetry is an open source observability framework, providing a
+# general-purpose API, SDK, and related tools required for the instrumentation
+# of cloud-native software, frameworks, and libraries.
+#
+# The OpenTelemetry module provides global accessors for telemetry objects.
+# See the documentation for the `opentelemetry-api` gem for details.
 module OpenTelemetry
   # "Instrumentation" are specified by
   # https://github.com/open-telemetry/opentelemetry-specification/blob/784635d01d8690c8f5fcd1f55bdbc8a13cf2f4f2/specification/glossary.md#instrumentation-library

data/lib/opentelemetry/instrumentation/sidekiq/instrumentation.rb

@@ -45,7 +45,7 @@ module OpenTelemetry
             end
           end
 
-          if defined?(::Sidekiq::Testing)
+          if defined?(::Sidekiq::Testing) # rubocop:disable Style/GuardClause
             ::Sidekiq::Testing.server_middleware do |chain|
               chain.add Middlewares::Server::TracerMiddleware
             end

data/lib/opentelemetry/instrumentation/sidekiq/middlewares/client/tracer_middleware.rb

@@ -9,18 +9,20 @@ module OpenTelemetry
     module Sidekiq
       module Middlewares
         module Client
+          # TracerMiddleware propagates context and instruments Sidekiq client
+          # by way of its middleware system
           class TracerMiddleware
             def call(_worker_class, job, _queue, _redis_pool)
               tracer.in_span(
                 job['wrapped']&.to_s || job['class'],
                 attributes: {
                   'messaging.message_id' => job['jid'],
-                  'messaging.destination' => job['queue'],
+                  'messaging.destination' => job['queue']
                 },
                 kind: :producer
               ) do |span|
                 OpenTelemetry.propagation.text.inject(job)
-                span.add_event(name: 'created_at', timestamp: job['created_at'])
+                span.add_event('created_at', timestamp: job['created_at'])
                 yield
               end
             end

data/lib/opentelemetry/instrumentation/sidekiq/middlewares/server/tracer_middleware.rb

@@ -9,6 +9,8 @@ module OpenTelemetry
     module Sidekiq
       module Middlewares
         module Server
+          # TracerMiddleware propagates context and instruments Sidekiq requests
+          # by way of its middleware system
           class TracerMiddleware
             def call(_worker, msg, _queue)
               parent_context = OpenTelemetry.propagation.text.extract(msg)
@@ -16,13 +18,13 @@ module OpenTelemetry
                 msg['wrapped']&.to_s || msg['class'],
                 attributes: {
                   'messaging.message_id' => msg['jid'],
-                  'messaging.destination' => msg['queue'],
+                  'messaging.destination' => msg['queue']
                 },
-                with_parent_context: parent_context,
+                with_parent: parent_context,
                 kind: :consumer
               ) do |span|
-                span.add_event(name: 'created_at', timestamp: msg['created_at'])
-                span.add_event(name: 'enqueued_at', timestamp: msg['enqueued_at'])
+                span.add_event('created_at', timestamp: msg['created_at'])
+                span.add_event('enqueued_at', timestamp: msg['enqueued_at'])
                 yield
               end
             end

data/lib/opentelemetry/instrumentation/sidekiq/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Sidekiq
-      VERSION = '0.5.0'
+      VERSION = '0.10.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.10.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -157,7 +157,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
+- CHANGELOG.md
 - LICENSE
+- README.md
 - lib/opentelemetry-instrumentation-sidekiq.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/sidekiq.rb
@@ -168,7 +171,11 @@ files:
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-sidekiq/v0.10.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/instrumentation/sidekiq
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-sidekiq/v0.10.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -184,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Sidekiq instrumentation for the OpenTelemetry framework