opentelemetry-instrumentation-sidekiq 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90f59b0c373512a72d8b43705d86cd176e8c9c3c98daaf268b6a6e9ae6f1c8f3
-  data.tar.gz: 23474ce25ad1da1527cbb6c528a12f31d674468fafd43e36edd1ce420d1a2098
+  metadata.gz: 19be10d7b509dcfe2968686c052f8981011f03af26499b44500d3e62e8fac924
+  data.tar.gz: 1492ec12727b1f0b5b558d235de2618034d3506de5b12cad8acc067f4165929c
 SHA512:
-  metadata.gz: 67cb2fe1ea747b32529bde4f95c2be62b145bc1c9d8456e66321b28d2debe8cfa6245ebc5364fd9283f59e2a12cbfb992d1a067e10cf7de48855a948a3d97250
-  data.tar.gz: e4444ce255afde7f1d6cd7874126318d7adb3d8f1de76e694b3598d985921911ad9d2a90838cd336fefdac6369e7821714ab91156bd363d4c6ddcc554851f4a3
+  metadata.gz: af23ab6ba1356dd84cf22c62eab3f4e6736c3d8da685e826a58ee42b225345cc76456d774bf4453099995fc044a9143e645a8087a2ddf37880cd97f21efb86d8
+  data.tar.gz: 31315345ca6e85e7ee96bfde7d7e287a1348377037ec41b2308587a0884671bf0203382e2b356e8b17ce38fa5ce4e12a623c72eeea09068eafa561e90c7ef7bd

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

@@ -1,5 +1,11 @@
 # Release History: opentelemetry-instrumentation-sidekiq
 
+### 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/middlewares/server/tracer_middleware.rb

@@ -20,7 +20,7 @@ module OpenTelemetry
                   'messaging.message_id' => msg['jid'],
                   'messaging.destination' => msg['queue']
                 },
-                with_parent_context: parent_context,
+                with_parent: parent_context,
                 kind: :consumer
               ) do |span|
                 span.add_event('created_at', timestamp: msg['created_at'])

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Sidekiq
-      VERSION = '0.6.0'
+      VERSION = '0.7.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-10-08 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.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -157,8 +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
@@ -185,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Sidekiq instrumentation for the OpenTelemetry framework