opentelemetry-instrumentation-redis 0.5.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d87409ac9ebb5065f9eb91380b7faf74824a15f496596c96f3341eba53581e22
-  data.tar.gz: bc8d4e6f3a176662055cf4abb4c2d55a9a0aa8584d798f32cebca5cab19cb86b
+  metadata.gz: 114bcbc6abbcb6db657f2f04062d62c4c99b8122a0ade3a5da6fa611dd72e68c
+  data.tar.gz: 24b22dda3eaa35007d9d01278e3ccdd56d3dfd004117996726ef7dc9d95aa73e
 SHA512:
-  metadata.gz: 298cf5385ab6829c7c671ca09f12293c353d2eecf080f82500f48df84ddc925b091cf106db6673396be51eeb03aec5614ed1c3cf4d0e72bf23971bd669545acc
-  data.tar.gz: 44f0c89b788a0331077397c127ae5ed5942a16f099963904e2eba0a2c799d0c15fcb6a3d55f4a8dd1564006c35eb5c07077c75b23596c9124fdfae7e8e5c5e7d
+  metadata.gz: 04f036f00d5edb595d4eb25af5cb27f88c9cf71f9e2a5fbca3dde01ec5c43b297c8270fafb0444faad66e63671c6bf1dc0910315f8b2235c10ed20fe99c0eea5
+  data.tar.gz: fe136b8cdec06cb035e1c5678d2c5232c62e5d41d06ba336ad2c584c2d158b8f52a318414e1236681d1e4911d90a8b044ec620126052000bc2bd6b45821fdd6d

data/.yardopts

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

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Release History: opentelemetry-instrumentation-redis
+
+### 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: Redis attribute propagation 
+* ADDED: Add timeout for force_flush and shutdown 
+
+### v0.8.0 / 2020-10-27
+
+* BREAKING CHANGE: Remove 'canonical' from status codes 
+
+* FIXED: Remove 'canonical' from status codes 
+
+### v0.7.0 / 2020-10-07
+
+* DOCS: Added redis documentation 
+* DOCS: Standardize toplevel docs structure and readme 
+
+### v0.6.0 / 2020-09-10
+
+* (No significant changes)

data/README.md

@@ -0,0 +1,64 @@
+# OpenTelemetry Redis Instrumentation
+
+The OpenTelemetry Redis Ruby gem is a community maintained instrumentation for [Redis][redis-home]. This is an in-memory data store that is used as a database, cache, and message broker.
+
+## How do I get started?
+
+Install the gem using:
+
+```
+gem install opentelemetry-instrumentation-redis
+```
+
+Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-redis` in your `Gemfile`.
+
+## Usage
+
+To install the instrumentation, call `use` with the name of the instrumentation.
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::Redis'
+end
+```
+
+Alternatively, you can also call `use_all` to install all the available instrumentation.
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use_all
+end
+```
+
+The Redis instrumentation allows the user to supply additional attributes via context propagation. This may be used to propagate attributes from instrumentation for things like Resque and Sidekiq, for example, to attach to the Redis client spans.
+
+```ruby
+require 'opentelemetry/instrumentation/redis'
+
+redis = ::Redis.new
+OpenTelemetry::Instrumentation::Redis.with_attributes('peer.service' => 'cache') do
+  redis.set('K', 'x')
+end
+```
+
+## Example
+
+An example of usage can be seen in [`example/redis.rb`](https://github.com/open-telemetry/opentelemetry-ruby/blob/master/instrumentation/redis/example/redis.rb).
+
+## How can I get involved?
+
+The `opentelemetry-instrumentation-redis` 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
+
+Apache 2.0 license. See [LICENSE][license-github] for more information.
+
+[redis-home]: https://redis.io
+[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/redis.rb

@@ -10,6 +10,45 @@ module OpenTelemetry
   module Instrumentation
     # Contains the OpenTelemetry instrumentation for the Redis gem
     module Redis
+      extend self
+
+      CURRENT_ATTRIBUTES_HASH = Context.create_key('current-attributes-hash')
+
+      private_constant :CURRENT_ATTRIBUTES_HASH
+
+      # Returns the attributes hash representing the Redis client context found
+      # in the optional context or the current context if none is provided.
+      #
+      # @param [optional Context] context The context to lookup the current
+      #   attributes hash. Defaults to Context.current
+      def attributes(context = nil)
+        context ||= Context.current
+        context.value(CURRENT_ATTRIBUTES_HASH) || {}
+      end
+
+      # Returns a context containing the merged attributes hash, derived from the
+      # optional parent context, or the current context if one was not provided.
+      #
+      # @param [optional Context] context The context to use as the parent for
+      #   the returned context
+      def context_with_attributes(attributes_hash, parent_context: Context.current)
+        attributes_hash = attributes(parent_context).merge(attributes_hash)
+        parent_context.set_value(CURRENT_ATTRIBUTES_HASH, attributes_hash)
+      end
+
+      # Activates/deactivates the merged attributes hash within the current Context,
+      # which makes the "current attributes hash" available implicitly.
+      #
+      # On exit, the attributes hash that was active before calling this method
+      # will be reactivated.
+      #
+      # @param [Span] span the span to activate
+      # @yield [Hash, Context] yields attributes hash and a context containing the
+      #   attributes hash to the block.
+      def with_attributes(attributes_hash)
+        attributes_hash = attributes.merge(attributes_hash)
+        Context.with_value(CURRENT_ATTRIBUTES_HASH, attributes_hash) { |c, h| yield h, c }
+      end
     end
   end
 end

data/lib/opentelemetry/instrumentation/redis/patches/client.rb

@@ -13,11 +13,11 @@ module OpenTelemetry
           def call(*args, &block)
             response = nil
 
+            attributes = client_attributes
+            attributes['db.statement'] = Utils.format_statement(args)
             tracer.in_span(
               Utils.format_command(args),
-              attributes: client_attributes.merge(
-                'db.statement' => Utils.format_statement(args)
-              ),
+              attributes: attributes,
               kind: :client
             ) do
               response = super(*args, &block)
@@ -29,11 +29,11 @@ module OpenTelemetry
           def call_pipeline(*args, &block)
             response = nil
 
+            attributes = client_attributes
+            attributes['db.statement'] = Utils.format_pipeline_statement(args)
             tracer.in_span(
               'pipeline',
-              attributes: client_attributes.merge(
-                'db.statement' => Utils.format_pipeline_statement(args)
-              ),
+              attributes: attributes,
               kind: :client
             ) do
               response = super(*args, &block)
@@ -48,13 +48,13 @@ module OpenTelemetry
             host = options[:host]
             port = options[:port]
 
-            {
+            OpenTelemetry::Instrumentation::Redis.attributes.merge(
               'db.type' => 'redis',
               'db.instance' => options[:db].to_s,
               'db.url' => "redis://#{host}:#{port}",
               'net.peer.name' => host,
               'net.peer.port' => port
-            }
+            )
           end
 
           def tracer

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-redis
 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.5.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -171,7 +171,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
+- CHANGELOG.md
 - LICENSE
+- README.md
 - lib/opentelemetry-instrumentation-redis.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/redis.rb
@@ -182,7 +185,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-redis/v0.10.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/instrumentation/redis
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-redis/v0.10.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -198,7 +205,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: Redis instrumentation for the OpenTelemetry framework