opentelemetry-instrumentation-redis 0.7.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91d520ee35bf02a65866bcd28970e55a938fc8598b2d00596268465537242ec8
-  data.tar.gz: 6ef70eb9f8c56c9792b831c82212560232c9097c669b9aacdc3caa566ba2d5b0
+  metadata.gz: 78f4cc4746e23f027e95d4f684fefb8700bcd7c95a027fd71bae15c92cdde480
+  data.tar.gz: bc7ca066ca09e317d869a8d219b5d2c4b54f0d4e003a38a7e91240db50c49579
 SHA512:
-  metadata.gz: ea046671b54c38bf743ce7f54bc1be72be456bc0865e6525adce728d2e7c6f0157c878e85c3b28e2183dd28064cfa7dd5144fb4cd68e0fed087475e2ccc817fd
-  data.tar.gz: 76458adee32440f760d8d64d036ac720f9e24d4788281f9f49e436c9c7fe05af21e0fac17ff4009dc677c3cdd3a7759dbae4b4f893d89a3372cab21b107c4ff9
+  metadata.gz: d03b391f9c894ecb908d321a3c415224ef45413f93ad678d8dfa33d8201a23590c20488ec29bd55d4872823b18fb81fcddcd193a0f9ec9565e42a7d899ade7ca
+  data.tar.gz: 82f24a709bdd20b8fb1332136534d9da7b09f083b8a27222291a4f542492a9efea2c76fd45ff44a056c0150abdbf69da243b142ea7d602368623240d3f995c39

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Release History: opentelemetry-instrumentation-redis
 
+### v0.11.0 / 2020-12-11
+
+* ADDED: Accept config for redis peer service attribute 
+* ADDED: Move utf8 encoding to common utils 
+* FIXED: Copyright comments to not reference year 
+
+### v0.10.1 / 2020-12-09
+
+* FIXED: Semantic conventions db.type -> db.system 
+
+### 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 

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 OpenTelemetry Authors
+   Copyright The OpenTelemetry Authors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/instrumentation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/instrumentation/redis.rb

@@ -1,15 +1,55 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
 require 'opentelemetry'
+require 'opentelemetry/common'
 
 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/instrumentation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -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,18 +48,24 @@ module OpenTelemetry
             host = options[:host]
             port = options[:port]
 
-            {
-              'db.type' => 'redis',
+            attributes = {
+              'db.system' => 'redis',
               'db.instance' => options[:db].to_s,
               'db.url' => "redis://#{host}:#{port}",
               'net.peer.name' => host,
               'net.peer.port' => port
             }
+            attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+            attributes.merge(OpenTelemetry::Instrumentation::Redis.attributes)
           end
 
           def tracer
             Redis::Instrumentation.instance.tracer
           end
+
+          def config
+            Redis::Instrumentation.instance.config
+          end
         end
       end
     end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -11,7 +11,6 @@ module OpenTelemetry
       module Utils
         extend self
 
-        STRING_PLACEHOLDER = ''.encode(::Encoding::UTF_8).freeze
         PLACEHOLDER = '?'
         VALUE_MAX_LEN = 50
         CMD_MAX_LEN = 500
@@ -36,7 +35,7 @@ module OpenTelemetry
 
         def format_arg(arg)
           str = arg.is_a?(Symbol) ? arg.to_s.upcase : arg.to_s
-          str = utf8_encode(str, binary: true, placeholder: PLACEHOLDER)
+          str = OpenTelemetry::Common::Utilities.utf8_encode(str, binary: true)
           truncate(str, VALUE_MAX_LEN)
         rescue StandardError => e
           OpenTelemetry.logger.debug("non formattable Redis arg #{str}: #{e}")
@@ -60,24 +59,6 @@ module OpenTelemetry
         def truncate(string, size)
           string.size > size ? "#{string[0...size - 3]}..." : string
         end
-
-        def utf8_encode(str, options = {})
-          str = str.to_s
-
-          if options[:binary]
-            # This option is useful for "gracefully" displaying binary data that
-            # often contains text such as marshalled objects
-            str.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
-          elsif str.encoding == ::Encoding::UTF_8
-            str
-          else
-            str.encode(::Encoding::UTF_8)
-          end
-        rescue StandardError => e
-          OpenTelemetry.logger.debug("Error encoding string in UTF-8: #{e}")
-
-          options.fetch(:placeholder, STRING_PLACEHOLDER)
-        end
       end
     end
   end

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
 module OpenTelemetry
   module Instrumentation
     module Redis
-      VERSION = '0.7.0'
+      VERSION = '0.11.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-redis
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.11.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-08 00:00:00.000000000 Z
+date: 2020-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -185,7 +199,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.11.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.11.0
 post_install_message: 
 rdoc_options: []
 require_paths: