opentelemetry-instrumentation-redis 0.17.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f308b21893c76a482cbed3e42ce6f72b6a5c435aedabdee8a3d5f886f289273
-  data.tar.gz: 79fc2ad085205197ca11e452bf2f7c240fa939a6bb77287eb076e1b66c7b084f
+  metadata.gz: 623d653fb0f83f2c6587fab77efa962491d5eb034cd4e8c98dda39b572d1a613
+  data.tar.gz: 74e7a1a810ad625768eec316a4b16ec8ece8ae4a93b3c3cc1b16da135d3c6bc8
 SHA512:
-  metadata.gz: 3b90442147ac86fa19c49c2bb7a60f3c3a6b67fce95abd2d31ac5a29e729d51d0eb43c583066be34b0eff5c1878f8af69fef2309a487c7a34cb0f107a93566de
-  data.tar.gz: d9389b133663fae2be0460663a7dac48dc69ed5d4162409524aa8e74d7a645bd4263623e8e879250ce8ba72792e186324250f41e2903612581660bf6c991ebe2
+  metadata.gz: 601147ca939a22bf4654dfba53675f56800ddf0ca3cc995e9321843e5738200e775c3dc9ac3f49cb9d2b0c62728ddc391b3f12d80ec46a4689d8a6ba22793f20
+  data.tar.gz: 5bb1f8966cecfce7d81a1c8124545394df58c720b5a4730dad944cca488a9e53336be896490137151a812fbb2f555c3125d61ba21001c789ed52a18e15595d6f

data/CHANGELOG.md

@@ -1,18 +1,41 @@
 # Release History: opentelemetry-instrumentation-redis
 
+### 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
+refactor: redis attribute utils [#760](https://github.com/open-telemetry/opentelemetry-ruby/pull/760)
+refactor: simplify redis attribute assignment [#758](https://github.com/open-telemetry/opentelemetry-ruby/pull/758)
+test: split redis instrumentation test [#754](https://github.com/open-telemetry/opentelemetry-ruby/pull/754)
+* ADDED: Option to obfuscate redis arguments
+* FIXED: Instrument Redis more thoroughly by patching Client#process.
+
 ### v0.17.0 / 2021-04-22
 
 * (No significant changes)
 
 ### v0.16.0 / 2021-03-17
 
-* FIXED: Update DB semantic conventions 
-* FIXED: Example scripts now reference local common lib 
-* DOCS: Replace Gitter with GitHub Discussions 
+* FIXED: Update DB semantic conventions
+* FIXED: Example scripts now reference local common lib
+* DOCS: Replace Gitter with GitHub Discussions
 
 ### v0.15.0 / 2021-02-18
 
-* ADDED: Add instrumentation config validation 
+* ADDED: Add instrumentation config validation
 
 ### v0.14.0 / 2021-02-03
 
@@ -28,13 +51,13 @@
 
 ### 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 
+* 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 
+* FIXED: Semantic conventions db.type -> db.system
 
 ### v0.10.0 / 2020-12-03
 
@@ -42,21 +65,21 @@
 
 ### v0.9.0 / 2020-11-27
 
-* BREAKING CHANGE: Add timeout for force_flush and shutdown 
+* BREAKING CHANGE: Add timeout for force_flush and shutdown
 
-* ADDED: Redis attribute propagation 
-* ADDED: 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 
+* BREAKING CHANGE: Remove 'canonical' from status codes
 
-* FIXED: 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 
+* DOCS: Added redis documentation
+* DOCS: Standardize toplevel docs structure and readme
 
 ### v0.6.0 / 2020-09-10
 

data/README.md

@@ -41,6 +41,18 @@ OpenTelemetry::Instrumentation::Redis.with_attributes('peer.service' => 'cache')
 end
 ```
 
+### Configuration options
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::Redis', {
+    # The obfuscation of arguments in the db.statement attribute is enabled by default.
+    # To disable, set enable_statement_obfuscation to false.
+    enable_statement_obfuscation: true,
+  }
+end
+```
+
 ## Example
 
 An example of usage can be seen in [`example/redis.rb`](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/instrumentation/redis/example/redis.rb).
@@ -48,11 +60,7 @@ An example of usage can be seen in [`example/redis.rb`](https://github.com/open-
 ## Development
 
 You'll need Redis installed locally to run the test suite. Once you've
-installed it, start it with the included configuration:
-
-```
-redis-server test/redis.conf
-```
+installed it, it will start and stop automatically when you run `rake`.
 
 ## How can I get involved?
 

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

@@ -19,12 +19,13 @@ module OpenTelemetry
           defined?(::Redis)
         end
 
-        option :peer_service, default: nil, validate: :string
+        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
 
         def require_dependencies
-          require_relative 'utils'
           require_relative 'patches/client'
         end
 

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

@@ -10,41 +10,12 @@ module OpenTelemetry
       module Patches
         # Module to prepend to Redis::Client for instrumentation
         module Client
-          def call(*args, &block)
-            response = nil
+          MAX_STATEMENT_LENGTH = 500
+          private_constant :MAX_STATEMENT_LENGTH
 
-            attributes = client_attributes
-            attributes['db.statement'] = Utils.format_statement(args)
-            tracer.in_span(
-              Utils.format_command(args),
-              attributes: attributes,
-              kind: :client
-            ) do
-              response = super(*args, &block)
-            end
-
-            response
-          end
-
-          def call_pipeline(*args, &block)
-            response = nil
-
-            attributes = client_attributes
-            attributes['db.statement'] = Utils.format_pipeline_statement(args)
-            tracer.in_span(
-              'pipeline',
-              attributes: attributes,
-              kind: :client
-            ) do
-              response = super(*args, &block)
-            end
+          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?
 
-            response
-          end
-
-          private
-
-          def client_attributes
             host = options[:host]
             port = options[:port]
 
@@ -53,9 +24,60 @@ module OpenTelemetry
               'net.peer.name' => host,
               'net.peer.port' => port
             }
+
             attributes['db.redis.database_index'] = options[:db] unless options[:db].zero?
             attributes['peer.service'] = config[:peer_service] if config[:peer_service]
-            attributes.merge(OpenTelemetry::Instrumentation::Redis.attributes)
+            attributes.merge!(OpenTelemetry::Instrumentation::Redis.attributes)
+
+            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
+                        else
+                          'PIPELINED'
+                        end
+
+            tracer.in_span(span_name, attributes: attributes, kind: :client) do |s|
+              super(commands).tap do |reply|
+                if reply.is_a?(::Redis::CommandError)
+                  s.record_exception(reply)
+                  s.status = Trace::Status.error(reply.message)
+                end
+              end
+            end
+          end
+
+          private
+
+          # Examples of commands received for parsing
+          # Redis#queue     [[[:set, "v1", "0"]], [[:incr, "v1"]], [[:get, "v1"]]]
+          # Redis#pipeline: [[:set, "v1", "0"], [:incr, "v1"], [:get, "v1"]]
+          # Redis#hmset     [[:hmset, "hash", "f1", 1234567890.0987654]]
+          # Redis#set       [[:set, "K", "x"]]
+          def parse_commands(commands) # rubocop:disable Metrics/AbcSize
+            commands.map do |command|
+              # We are checking for the use of Redis#queue command, if we detect the
+              # extra level of array nesting we return the first element so it
+              # can be parsed.
+              command = command[0] if command.is_a?(Array) && command[0].is_a?(Array)
+
+              # If we receive an authentication request command
+              # we want to short circuit parsing the commands
+              # and return the obfuscated command
+              return 'AUTH ?' if command[0] == :auth
+
+              command[0] = command[0].to_s.upcase
+              if config[:db_statement] == :obfuscate
+                command[0] + ' ?' * (command.size - 1)
+              else
+                command.join(' ')
+              end
+            end.join("\n")
           end
 
           def tracer

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Redis
-      VERSION = '0.17.0'
+      VERSION = '0.21.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-redis
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.21.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 1.0.0.rc3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 1.0.0.rc3
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.18.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.18.2
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -194,16 +194,15 @@ files:
 - lib/opentelemetry/instrumentation/redis.rb
 - lib/opentelemetry/instrumentation/redis/instrumentation.rb
 - lib/opentelemetry/instrumentation/redis/patches/client.rb
-- lib/opentelemetry/instrumentation/redis/utils.rb
 - lib/opentelemetry/instrumentation/redis/version.rb
 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.17.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-redis/v0.21.0/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.17.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-redis/v0.21.0
 post_install_message: 
 rdoc_options: []
 require_paths:

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

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Instrumentation
-    module Redis
-      # Utility functions
-      module Utils
-        extend self
-
-        PLACEHOLDER = '?'
-        VALUE_MAX_LEN = 50
-        CMD_MAX_LEN = 500
-
-        def format_command(command_args)
-          format_arg(resolve_command_args(command_args).first)
-        end
-
-        def format_pipeline_statement(command_args)
-          command_args[0].commands.map do |args|
-            format_statement(args)
-          end.join("\n")
-        end
-
-        def format_statement(command_args)
-          command_args = resolve_command_args(command_args)
-          return 'AUTH ?' if auth_command?(command_args)
-
-          cmd = command_args.map { |x| format_arg(x) }.join(' ')
-          OpenTelemetry::Common::Utilities.truncate(cmd, CMD_MAX_LEN)
-        end
-
-        def format_arg(arg)
-          str = arg.is_a?(Symbol) ? arg.to_s.upcase : arg.to_s
-          str = OpenTelemetry::Common::Utilities.utf8_encode(str, binary: true)
-          OpenTelemetry::Common::Utilities.truncate(str, VALUE_MAX_LEN)
-        rescue StandardError => e
-          OpenTelemetry.logger.debug("non formattable Redis arg #{str}: #{e}")
-          PLACEHOLDER
-        end
-
-        def auth_command?(command_args)
-          return false unless command_args.is_a?(Array) && !command_args.empty?
-
-          command_args.first.to_sym == :auth
-        end
-
-        # Unwraps command array when Redis is called with the following syntax:
-        #   redis.call([:cmd, 'arg1', ...])
-        def resolve_command_args(command_args)
-          return command_args.first if command_args.is_a?(Array) && command_args.first.is_a?(Array)
-
-          command_args
-        end
-      end
-    end
-  end
-end