opentelemetry-instrumentation-redis 0.18.0 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b97d1d7565c42c6b2a1c5a3d351c1b289c958de50295fdc5b75bcb04dd08e90f
-  data.tar.gz: '0901c065c1a7cb6bd7412ea275a836b6575e2ae52096047822cc980963c187e0'
+  metadata.gz: ce59915631b4057f1b6c69b9faec92c2a9afa40260c3332c53006b82d2d85438
+  data.tar.gz: 22cde24339c23d879768c39bd7ddf7f473ba395472d391b77e1fb3297a102b5f
 SHA512:
-  metadata.gz: d068fef46b939f32433777e0d2a361f8108eae305c9c019817efc67ecb86b4d147591200b6fe6699e801b1c2d3884a34c3c07f2c1816f1948e7008b60d79bbac
-  data.tar.gz: e15af756ab9191474be4ba2b5783158288553ca34a6563a518159825f165663bbc13260901b2bdf58abac84712db8b922bb739f6bd2712d4dc740c2634dc964f
+  metadata.gz: 5f4ee78dc5643b5078cbe89eef588d4814c8265001b51f04b8fe7d150bcd37fbdc0add788d858610348f3aaa5c87e66b1ad5fd8139f9878e2ad68e52d04e3d7d
+  data.tar.gz: e7c732d1e5083df3cdb2a541f1039486d0c15f2f3f9ac328fe3fd40e50108bb4d68f08c0034c6a57ffc1a502f986bcf3342018fe9342ea6f4affda2dbfa310ff

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Release History: opentelemetry-instrumentation-redis
 
+### v0.21.1 / 2021-09-29
+
+* (No significant changes)
+
+### v0.21.0 / 2021-08-12
+
+* ADDED: Add toggle for redis db.statement attribute 
+
+### v0.20.0 / 2021-06-23
+
+* BREAKING CHANGE: Total order constraint on span.status= 
+
+* FIXED: Total order constraint on span.status= 
+
+### v0.19.0 / 2021-05-28
+
+* ADDED: Configuration option to enable or disable redis root spans [#777](https://github.com/open-telemetry/opentelemetry-ruby/pull/777)
+
 ### v0.18.0 / 2021-05-21
 
 * ADDED: Updated API depedency for 1.0.0.rc1

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

@@ -19,8 +19,9 @@ module OpenTelemetry
           defined?(::Redis)
         end
 
-        option :peer_service, default: nil, validate: :string
-        option :enable_statement_obfuscation, default: true, validate: :boolean
+        option :peer_service,                 default: nil,   validate: :string
+        option :trace_root_spans,             default: true,  validate: :boolean
+        option :db_statement,                 default: :obfuscate, validate: ->(opt) { %I[omit include obfuscate].include?(opt) }
 
         private
 

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

@@ -13,7 +13,9 @@ module OpenTelemetry
           MAX_STATEMENT_LENGTH = 500
           private_constant :MAX_STATEMENT_LENGTH
 
-          def process(commands) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          def process(commands) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+            return super unless config[:trace_root_spans] || OpenTelemetry::Trace.current_span.context.valid?
+
             host = options[:host]
             port = options[:port]
 
@@ -27,10 +29,12 @@ module OpenTelemetry
             attributes['peer.service'] = config[:peer_service] if config[:peer_service]
             attributes.merge!(OpenTelemetry::Instrumentation::Redis.attributes)
 
-            parsed_commands = parse_commands(commands)
-            parsed_commands = OpenTelemetry::Common::Utilities.truncate(parsed_commands, MAX_STATEMENT_LENGTH)
-            parsed_commands = OpenTelemetry::Common::Utilities.utf8_encode(parsed_commands, binary: true)
-            attributes['db.statement'] = parsed_commands
+            unless config[:db_statement] == :omit
+              parsed_commands = parse_commands(commands)
+              parsed_commands = OpenTelemetry::Common::Utilities.truncate(parsed_commands, MAX_STATEMENT_LENGTH)
+              parsed_commands = OpenTelemetry::Common::Utilities.utf8_encode(parsed_commands, binary: true)
+              attributes['db.statement'] = parsed_commands
+            end
 
             span_name = if commands.length == 1
                           commands[0][0].to_s.upcase
@@ -42,10 +46,7 @@ module OpenTelemetry
               super(commands).tap do |reply|
                 if reply.is_a?(::Redis::CommandError)
                   s.record_exception(reply)
-                  s.status = Trace::Status.new(
-                    Trace::Status::ERROR,
-                    description: reply.message
-                  )
+                  s.status = Trace::Status.error(reply.message)
                 end
               end
             end
@@ -71,7 +72,7 @@ module OpenTelemetry
               return 'AUTH ?' if command[0] == :auth
 
               command[0] = command[0].to_s.upcase
-              if config[:enable_statement_obfuscation]
+              if config[:db_statement] == :obfuscate
                 command[0] + ' ?' * (command.size - 1)
               else
                 command.join(' ')

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Redis
-      VERSION = '0.18.0'
+      VERSION = '0.21.1'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-redis
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.21.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2021-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.2
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.18.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.18.3
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -199,10 +199,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.18.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-redis/v0.21.1/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/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.18.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-redis/v0.21.1
 post_install_message: 
 rdoc_options: []
 require_paths: