opentelemetry-instrumentation-redis 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 937f6a419159634ade0e277a99a58c4b8785b14c3491e415329935eb2c9fc02c
-  data.tar.gz: ac69c4394f828efac7721e866e3378c069771eca9077aa917d21d7bd07e971da
+  metadata.gz: a27919563509bb9c0d19f5bc59e1d8ead18713a166791473b8bbd6ff5f3ca78a
+  data.tar.gz: 2649f5632d81c557b9a0cd8ad6431650c11d9b91ff705cb1eb3419407384e422
 SHA512:
-  metadata.gz: 25d8f3a30e519ff944d8bab87b4e9b76ecc24154ec9428c146ced15bbd1e06e9fb2bedc1573909c0c46f3b00c36ed6ba695cc883ed5314767fee1ce5a02e5dad
-  data.tar.gz: 03a3a534df7e50e237cb611a81a6360fc99600410df85f38535c49ef76f80e121127f70d861d8d1258f88cad57dd83e95251a51ef98b79460ffabf0a9d194e06
+  metadata.gz: 4a7aa1b2145bd567b87fa1cc6d51ac12d2accc52d05e58dc17a8cfe9f6225cd28c80ba4d1e8facc3f2991fe78f0b6835f26d152437e0d02db86e3e96f39750b7
+  data.tar.gz: 96c048eaa579ca59c1010950a36119e80695401218721ca95179d2dca7ba399a9c1bec16e68b4e22a152f433c12d053082fd601ff57c48702b0d4941fb7089b9

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-redis
 
+### v0.24.0 / 2022-09-14
+
+* ADDED: Redis-rb 5.0 and redis-client support 
+
 ### v0.23.0 / 2022-06-09
 
 * Upgrading Base dependency version

data/README.md

@@ -57,7 +57,7 @@ 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).
+An example of usage can be seen in [`example/redis.rb`](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/redis/example/redis.rb).
 
 ## Development
 
@@ -77,7 +77,7 @@ 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/main/LICENSE
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

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

@@ -16,7 +16,7 @@ module OpenTelemetry
         end
 
         present do
-          defined?(::Redis)
+          defined?(::Redis) || defined?(::RedisClient)
         end
 
         option :peer_service,                 default: nil,   validate: :string
@@ -26,11 +26,13 @@ module OpenTelemetry
         private
 
         def require_dependencies
-          require_relative 'patches/client'
+          require_relative 'patches/redis_v4_client' if defined?(::Redis) && ::Redis::VERSION < '5'
+          require_relative 'middlewares/redis_client' if defined?(::RedisClient)
         end
 
         def patch_client
-          ::Redis::Client.prepend(Patches::Client)
+          ::RedisClient.register(Middlewares::RedisClientInstrumentation) if defined?(::RedisClient)
+          ::Redis::Client.prepend(Patches::RedisV4Client) if defined?(::Redis) && ::Redis::VERSION < '5'
         end
       end
     end

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Redis
+      module Middlewares
+        # Adapter for redis-client instrumentation interface
+        module RedisClientInstrumentation
+          MAX_STATEMENT_LENGTH = 500
+          private_constant :MAX_STATEMENT_LENGTH
+
+          def call(command, redis_config)
+            return super unless instrumentation.config[:trace_root_spans] || OpenTelemetry::Trace.current_span.context.valid?
+
+            attributes = span_attributes(redis_config)
+
+            attributes['db.statement'] = serialize_commands([command]) unless instrumentation.config[:db_statement] == :omit
+
+            span_name = command[0].to_s.upcase
+            instrumentation.tracer.in_span(span_name, attributes: attributes, kind: :client) do
+              super
+            end
+          end
+
+          def call_pipelined(commands, redis_config)
+            return super unless instrumentation.config[:trace_root_spans] || OpenTelemetry::Trace.current_span.context.valid?
+
+            attributes = span_attributes(redis_config)
+
+            attributes['db.statement'] = serialize_commands(commands) unless instrumentation.config[:db_statement] == :omit
+
+            instrumentation.tracer.in_span('PIPELINED', attributes: attributes, kind: :client) do
+              super
+            end
+          end
+
+          private
+
+          def span_attributes(redis_config)
+            attributes = {
+              'db.system' => 'redis',
+              'net.peer.name' => redis_config.host,
+              'net.peer.port' => redis_config.port
+            }
+
+            attributes['db.redis.database_index'] = redis_config.db unless redis_config.db.zero?
+            attributes['peer.service'] = instrumentation.config[:peer_service] if instrumentation.config[:peer_service]
+            attributes.merge!(OpenTelemetry::Instrumentation::Redis.attributes)
+            attributes
+          end
+
+          def serialize_commands(commands)
+            obfuscate = instrumentation.config[:db_statement] == :obfuscate
+
+            serialized_commands = commands.map do |command|
+              # If we receive an authentication request command we want to obfuscate it
+              if obfuscate || command[0].match?(/\A(AUTH|HELLO)\z/)
+                command[0].to_s.upcase + ' ?' * (command.size - 1)
+              else
+                command_copy = command.dup
+                command_copy[0] = command_copy[0].to_s.upcase
+                command_copy.join(' ')
+              end
+            end.join("\n")
+            serialized_commands = OpenTelemetry::Common::Utilities.truncate(serialized_commands, MAX_STATEMENT_LENGTH)
+            OpenTelemetry::Common::Utilities.utf8_encode(serialized_commands, binary: true)
+          end
+
+          def instrumentation
+            Redis::Instrumentation.instance
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/redis/patches/{client.rb → redis_v4_client.rb}

@@ -9,12 +9,12 @@ module OpenTelemetry
     module Redis
       module Patches
         # Module to prepend to Redis::Client for instrumentation
-        module Client
+        module RedisV4Client
           MAX_STATEMENT_LENGTH = 500
           private_constant :MAX_STATEMENT_LENGTH
 
-          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?
+          def process(commands) # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+            return super unless instrumentation_config[:trace_root_spans] || OpenTelemetry::Trace.current_span.context.valid?
 
             host = options[:host]
             port = options[:port]
@@ -26,10 +26,10 @@ module OpenTelemetry
             }
 
             attributes['db.redis.database_index'] = options[:db] unless options[:db].zero?
-            attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+            attributes['peer.service'] = instrumentation_config[:peer_service] if instrumentation_config[:peer_service]
             attributes.merge!(OpenTelemetry::Instrumentation::Redis.attributes)
 
-            unless config[:db_statement] == :omit
+            unless instrumentation_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)
@@ -42,7 +42,7 @@ module OpenTelemetry
                           'PIPELINED'
                         end
 
-            tracer.in_span(span_name, attributes: attributes, kind: :client) do |s|
+            instrumentation_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)
@@ -59,7 +59,7 @@ module OpenTelemetry
           # 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
+          def parse_commands(commands)
             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
@@ -71,7 +71,7 @@ module OpenTelemetry
               # and return the obfuscated command
               return 'AUTH ?' if command[0] == :auth
 
-              if config[:db_statement] == :obfuscate
+              if instrumentation_config[:db_statement] == :obfuscate
                 command[0].to_s.upcase + ' ?' * (command.size - 1)
               else
                 command_copy = command.dup
@@ -81,11 +81,11 @@ module OpenTelemetry
             end.join("\n")
           end
 
-          def tracer
+          def instrumentation_tracer
             Redis::Instrumentation.instance.tracer
           end
 
-          def config
+          def instrumentation_config
             Redis::Instrumentation.instance.config
           end
         end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Redis
-      VERSION = '0.23.0'
+      VERSION = '0.24.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-redis
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -136,20 +136,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: redis-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -207,16 +221,17 @@ files:
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/redis.rb
 - lib/opentelemetry/instrumentation/redis/instrumentation.rb
-- lib/opentelemetry/instrumentation/redis/patches/client.rb
+- lib/opentelemetry/instrumentation/redis/middlewares/redis_client.rb
+- lib/opentelemetry/instrumentation/redis/patches/redis_v4_client.rb
 - lib/opentelemetry/instrumentation/redis/version.rb
-homepage: https://github.com/open-telemetry/opentelemetry-ruby
+homepage: https://github.com/open-telemetry/opentelemetry-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-redis/v0.23.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.23.0
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-redis/v0.24.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/redis
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-redis/v0.24.0
 post_install_message: 
 rdoc_options: []
 require_paths: