opentelemetry-instrumentation-redis 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3e631a5b9876f26498dfe8efd928cc664c5de73975b6a8c1921514b4cf87550
-  data.tar.gz: f6d40b30457ea65d8d19d3d349d4e4dad7b5ea36549f85b067338396b2384afd
+  metadata.gz: 1920f7074fc5c2fd6af2d2ecdda802d5206e5badfd43ad5ac645af1d0cac5a0e
+  data.tar.gz: af34ef6574c6425486f273b6d219f89314ea001575fb1057eb94e60a4f47b6df
 SHA512:
-  metadata.gz: c2358a85cc9562c6e1a675e549746154da8f72877317e4055cf6582121c3c61e303e92d2d01840af213ad27f07dbd507d80707ab7a79bc0adb1994cb6cfddcf9
-  data.tar.gz: aad5ddbe0c9465fc2cee76886535d20f88b61ab1bdc6a27340f9de76c27efbddfbf9fcf23c52f1021d8e819d3d46e631b39b77b211b81a5fb70b917fd77efb28
+  metadata.gz: 4cabad81823ae23a7355bf9eb22611eaa6b86b646741651e72f49e08acb42efd196d5a8a1f4adde5b6c63415208ded15697f4869e70a29b0e629973955ba67ad
+  data.tar.gz: 4bd86b68fc024dddd1f91f6f1fa430a54696f4b63fff102a14d3badc6920bd3ab28df32c2632636b173e52074792fc1df4a88d3317b91f9f17d84f35d1d9385a

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Release History: opentelemetry-instrumentation-redis
 
+### 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 

data/README.md

@@ -30,6 +30,17 @@ OpenTelemetry::SDK.configure do |c|
 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).

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.8.0'
+      VERSION = '0.9.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-redis
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-27 00:00:00.000000000 Z
+date: 2020-11-28 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.8.0
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -186,10 +186,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-redis/v0.8.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-redis/v0.9.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.8.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-redis/v0.9.0
 post_install_message: 
 rdoc_options: []
 require_paths: