mnemosyne-ruby 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0366be612fd9619593a970098205515b3e361bca87359e4f52d44f0fb2324f35
-  data.tar.gz: ba0c6a47f4fa471fbfee289f60992c75c6b1dff50380134a4c3f4568436c8a16
+  metadata.gz: 43c02b1229d902d187dee8281c88820a95d13a30ee594af7ca131645ffd85485
+  data.tar.gz: c6ebd7b760e56adacacbb89390d5abc463ded7a72e37d346de0d51fb615a6582
 SHA512:
-  metadata.gz: aabbd8356edee9ca7ddca04641c5623f6c164679145d9f8ac91d7fab8fc7a0647e9d026603f45677bdfb996d1d414889537e4ad46b1cae12d7d5401633da31dd
-  data.tar.gz: 401dea26b2ab32e8e55ae34f3b168657a1123415aed59eb4c5883fbcf39b60c8b7b2cea7b17a61691850d1eed44c391bfbd463265b9503139f94f5f244db1338
+  metadata.gz: 14220075cac092132c13d0c6d82bdfbc374c0c7a50db0d3e0d07e950fae0eda073b6958c30657f3bb089cbfcc0137d18fd56ae2f505e1f16d61917b929d25a6e
+  data.tar.gz: a568b0e9ea1b96549ed78082c9ccef3946a5a8dbd8b7b9dc231a609a52d59c928069d7f7a5cf4c99f509589830279ff16b1e05a055114674d5dac8d2ccf85274

data/.github/workflows/test.yml

@@ -28,9 +28,11 @@ jobs:
           - rails-7.0
           - redis-4.0
           - redis-5.0
+          - redis-client
           - restify
           - sidekiq-5
           - sidekiq-6
+          - sidekiq-7
         include:
           - suite: core
             spec: --tag ~probe
@@ -65,6 +67,9 @@ jobs:
           - suite: redis-5.0
             spec: --tag probe:redis
             gemfile: gemfiles/redis_50.gemfile
+          - suite: redis-client
+            spec: --tag probe:redis_client
+            gemfile: gemfiles/core.gemfile
           - suite: restify
             spec: --tag probe:restify
             gemfile: gemfiles/core.gemfile
@@ -74,6 +79,9 @@ jobs:
           - suite: sidekiq-6
             spec: --tag probe:sidekiq
             gemfile: gemfiles/sidekiq_60.gemfile
+          - suite: sidekiq-7
+            spec: --tag probe:sidekiq
+            gemfile: gemfiles/sidekiq_70.gemfile
         exclude:
           - suite: rails-5.2
             ruby: '3.2'

data/Appraisals

@@ -87,3 +87,11 @@ appraise 'sidekiq-60' do
     gem 'sidekiq', '~> 6.0'
   end
 end
+
+appraise 'sidekiq-70' do
+  remove_gem 'rubocop'
+
+  group :test do
+    gem 'sidekiq', '~> 7.0'
+  end
+end

data/CHANGELOG.md

@@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+## [1.16.0] - 2023-08-24
+
+### Added
+
+- Separate new tracing for `redis-client` gem
+
+### Fixed
+
+- `NoMethodError` when `RedisClient` is used directly
+
 ## [1.15.0] - 2023-08-23
 
 ### Added
@@ -192,7 +202,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Add platform identifier
 
-[Unreleased]: https://github.com/mnemosyne-mon/mnemosyne-ruby/compare/v1.15.0...HEAD
+[Unreleased]: https://github.com/mnemosyne-mon/mnemosyne-ruby/compare/v1.16.0...HEAD
+[1.16.0]: https://github.com/mnemosyne-mon/mnemosyne-ruby/compare/v1.15.0...v1.16.0
 [1.15.0]: https://github.com/mnemosyne-mon/mnemosyne-ruby/compare/v1.14.0...v1.15.0
 [1.14.0]: https://github.com/mnemosyne-mon/mnemosyne-ruby/compare/v1.14.0...v1.13.0
 [1.13.0]: https://github.com/mnemosyne-mon/mnemosyne-ruby/compare/v1.13.0...v1.12.1

data/Gemfile

@@ -16,6 +16,7 @@ group :test do
   gem 'msgr'
   gem 'rails'
   gem 'redis'
+  gem 'redis-client'
   gem 'restify'
   gem 'sidekiq'
   gem 'sqlite3'

data/gemfiles/sidekiq_70.gemfile

@@ -0,0 +1,27 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 13.0"
+
+group :test do
+  gem "rspec", "~> 3.6"
+  gem "timecop", "~> 0.9.1"
+  gem "faraday"
+  gem "msgr"
+  gem "rails"
+  gem "redis"
+  gem "restify"
+  gem "sidekiq", "~> 7.0"
+  gem "sqlite3"
+  gem "webmock"
+end
+
+group :development do
+  gem "appraisal"
+  gem "rake-release", "~> 1.3.0"
+  gem "pry", require: false
+  gem "pry-byebug", require: false
+end
+
+gemspec path: "../"

data/lib/mnemosyne/probes/redis/command.rb

@@ -6,147 +6,15 @@ module Mnemosyne
       module Command
         class Probe < ::Mnemosyne::Probe
           def setup
-            if Gem::Version.new(::Redis::VERSION) >= Gem::Version.new('5')
-              ::RedisClient.register Instrumentation
-            else
-              ::Redis::Client.prepend ClientPatch
-            end
-          end
-
-          module Instrumentation
-            def call(command, redis_config)
-              Instrumentation.instrument([command], client.server_url) { super }
-            end
-
-            def call_pipelined(commands, redis_config)
-              Instrumentation.instrument(commands, client.server_url) { super }
-            end
-
-            class << self
-              def instrument(commands, server_url)
-                trace = ::Mnemosyne::Instrumenter.current_trace
-                return yield unless trace
-
-                span = ::Mnemosyne::Span.new 'db.query.redis',
-                  meta: extract_span_meta(commands, server_url)
-
-                span.start!
-
-                begin
-                  yield.tap do |retval|
-                    span.meta[:error] = retval.message if retval.is_a?(::Redis::CommandError)
-
-                    trace << span.finish!
-                  end
-                rescue StandardError => e
-                  span.meta[:error] = e.message
-                  trace << span.finish!
-                  raise
-                end
-              end
-
-              private
+            # Redis v5+ used redis-client, which has it's own probe
+            return if Gem::Version.new(::Redis::VERSION) >= Gem::Version.new('5')
 
-              def extract_span_meta(commands, server_url)
-                {
-                  server: server_url,
-
-                  # Each command is an array, consisting of the command name and any
-                  # arguments. We are only interested in the command name.
-                  commands: extract_command_names(commands),
-
-                  # If there are multiple commands, that must mean they were pipelined
-                  # (i.e. run in parallel).
-                  pipelined: commands.length > 1
-                }
-              end
-
-              def extract_command_names(commands)
-                commands.map do |c|
-                  # Depending on how the methods on the Redis gem are called,
-                  # there may be an additional level of nesting.
-                  c = c[0] if c[0].is_a?(Array)
-
-                  # For some commands, we also extract *some* of the arguments.
-                  name, args = parse_name_and_args(c)
-
-                  "#{name} #{args}".strip
-                end.join("\n")
-              end
-
-              ##
-              # A map of known commands to the arguments (identified by position)
-              # that should be included verbatim in the metadata. Arguments not
-              # listed here will be replaced by a "?" character.
-              #
-              # The value can be a list of safe argument indices, or "*" (all).
-              #
-              KNOWN_ARGUMENTS = {
-                'BLPOP' => '*',
-                'BRPOP' => '*',
-                'EVALSHA' => [0, 1],
-                'EXISTS' => '*',
-                'EXPIRE' => '*',
-                'GET' => '*',
-                'HGET' => '*',
-                'HGETALL' => '*',
-                'HMGET' => '*',
-                'HMSET' => [0, 1],
-                'HSCAN' => '*',
-                'INCRBY' => '*',
-                'LLEN' => '*',
-                'LPUSH' => [0],
-                'LRANGE' => '*',
-                'LREM' => [0, 1],
-                'MGET' => '*',
-                'MSET' => [0],
-                'RPUSH' => [0],
-                'RPOP' => '*',
-                'SADD' => [0],
-                'SCARD' => '*',
-                'SCAN' => '*',
-                'SCRIPT LOAD' => [],
-                'SET' => [0],
-                'SREM' => [0],
-                'SSCAN' => '*',
-                'UNLINK' => '*',
-                'ZADD' => [0],
-                'ZCARD' => '*',
-                'ZINCRBY' => [0, 1],
-                'ZRANGE' => '*',
-                'ZRANGEBYSCORE' => '*',
-                'ZREM' => [0],
-                'ZREMRANGEBYSCORE' => '*',
-                'ZREVRANGE' => '*',
-                'ZSCAN' => '*'
-              }.freeze
-
-              def parse_name_and_args(command)
-                command = command.dup
-
-                # Symbols and lower-case names are allowed
-                name = command.delete_at(0).to_s.upcase
-
-                allowed = KNOWN_ARGUMENTS[name] || []
-                args = case allowed
-                         when '*' # All arguments considered safe
-                           command
-                         when Array # A list of allowed argument indices
-                           command.each_with_index.map do |arg, index|
-                             allowed.include?(index) ? arg : '?'
-                           end
-                         else # Unknown command - assume nothing is safe
-                           Array.new(command.length, '?')
-                       end.join(' ')
-
-                [name, args]
-              end
-            end
+            ::Redis::Client.prepend ClientPatch
           end
 
           module ClientPatch
             def process(commands)
-              Instrumentation.instrument(commands, id) { super }
+              ::Mnemosyne::Support::Redis.instrument(commands, id) { super }
             end
           end
         end

data/lib/mnemosyne/probes/redis-client/command.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Mnemosyne
+  module Probes
+    module RedisClient
+      module Command
+        class Probe < ::Mnemosyne::Probe
+          def setup
+            ::RedisClient.register Instrumentation
+          end
+
+          module Instrumentation
+            def call(command, redis_config)
+              ::Mnemosyne::Support::Redis.instrument([command], redis_config.server_url) { super }
+            end
+
+            def call_pipelined(commands, redis_config)
+              ::Mnemosyne::Support::Redis.instrument(commands, redis_config.server_url) { super }
+            end
+          end
+        end
+      end
+    end
+
+    register 'RedisClient',
+      'redis_client',
+      RedisClient::Command::Probe.new
+  end
+end

data/lib/mnemosyne/support/redis.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Mnemosyne
+  module Support
+    module Redis
+      ##
+      # A map of known commands to the arguments (identified by position)
+      # that should be included verbatim in the metadata. Arguments not
+      # listed here will be replaced by a "?" character.
+      #
+      # The value can be a list of safe argument indices, or "*" (all).
+      #
+      KNOWN_ARGUMENTS = {
+        'BLPOP' => '*',
+        'BRPOP' => '*',
+        'EVALSHA' => [0, 1],
+        'EXISTS' => '*',
+        'EXPIRE' => '*',
+        'GET' => '*',
+        'HGET' => '*',
+        'HGETALL' => '*',
+        'HMGET' => '*',
+        'HMSET' => [0, 1],
+        'HSCAN' => '*',
+        'INCRBY' => '*',
+        'LLEN' => '*',
+        'LPUSH' => [0],
+        'LRANGE' => '*',
+        'LREM' => [0, 1],
+        'MGET' => '*',
+        'MSET' => [0],
+        'RPUSH' => [0],
+        'RPOP' => '*',
+        'SADD' => [0],
+        'SCARD' => '*',
+        'SCAN' => '*',
+        'SCRIPT LOAD' => [],
+        'SET' => [0],
+        'SREM' => [0],
+        'SSCAN' => '*',
+        'UNLINK' => '*',
+        'ZADD' => [0],
+        'ZCARD' => '*',
+        'ZINCRBY' => [0, 1],
+        'ZRANGE' => '*',
+        'ZRANGEBYSCORE' => '*',
+        'ZREM' => [0],
+        'ZREMRANGEBYSCORE' => '*',
+        'ZREVRANGE' => '*',
+        'ZSCAN' => '*'
+      }.freeze
+
+      class << self
+        def instrument(commands, server_url)
+          trace = ::Mnemosyne::Instrumenter.current_trace
+          return yield unless trace
+
+          span = ::Mnemosyne::Span.new 'db.query.redis',
+            meta: extract_span_meta(commands, server_url)
+
+          span.start!
+
+          begin
+            yield.tap do |retval|
+              if defined?(::Redis::CommandError) && retval.is_a?(::Redis::CommandError)
+                span.meta[:error] = retval.message
+              end
+
+              trace << span.finish!
+            end
+          rescue StandardError => e
+            span.meta[:error] = e.message
+            trace << span.finish!
+            raise
+          end
+        end
+
+        def extract_span_meta(commands, server_url)
+          {
+            server: server_url,
+
+            # Each command is an array, consisting of the command name and any
+            # arguments. We are only interested in the command name.
+            commands: extract_command_names(commands),
+
+            # If there are multiple commands, that must mean they were pipelined
+            # (i.e. run in parallel).
+            pipelined: commands.length > 1
+          }
+        end
+
+        def parse_name_and_args(command)
+          command = command.dup
+
+          # Symbols and lower-case names are allowed
+          name = command.delete_at(0).to_s.upcase
+
+          allowed = KNOWN_ARGUMENTS[name] || []
+          args = case allowed
+                   when '*' # All arguments considered safe
+                     command
+                   when Array # A list of allowed argument indices
+                     command.each_with_index.map do |arg, index|
+                       allowed.include?(index) ? arg : '?'
+                     end
+                   else # Unknown command - assume nothing is safe
+                     Array.new(command.length, '?')
+                 end.join(' ')
+
+          [name, args]
+        end
+
+        def extract_command_names(commands)
+          commands.map do |c|
+            # Depending on how the methods on the Redis gem are called,
+            # there may be an additional level of nesting.
+            c = c[0] if c[0].is_a?(Array)
+
+            # For some commands, we also extract *some* of the arguments.
+            name, args = parse_name_and_args(c)
+
+            "#{name} #{args}".strip
+          end.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/mnemosyne/version.rb

@@ -3,7 +3,7 @@
 module Mnemosyne
   module VERSION
     MAJOR = 1
-    MINOR = 15
+    MINOR = 16
     PATCH = 0
     STAGE = nil
 

data/lib/mnemosyne.rb

@@ -43,6 +43,7 @@ module Mnemosyne
     require 'mnemosyne/probes/msgr/client'
     require 'mnemosyne/probes/msgr/consumer'
     require 'mnemosyne/probes/redis/command'
+    require 'mnemosyne/probes/redis-client/command'
     require 'mnemosyne/probes/responder/respond'
     require 'mnemosyne/probes/restify/base'
     require 'mnemosyne/probes/sidekiq/client'
@@ -54,5 +55,9 @@ module Mnemosyne
     require 'mnemosyne/middleware/rack'
   end
 
+  module Support
+    require 'mnemosyne/support/redis'
+  end
+
   require 'mnemosyne/railtie' if defined?(Rails)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mnemosyne-ruby
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-23 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,6 +70,7 @@ files:
 - gemfiles/redis_50.gemfile
 - gemfiles/sidekiq_50.gemfile
 - gemfiles/sidekiq_60.gemfile
+- gemfiles/sidekiq_70.gemfile
 - lib/mnemosyne-ruby.rb
 - lib/mnemosyne.rb
 - lib/mnemosyne/client.rb
@@ -100,6 +101,7 @@ files:
 - lib/mnemosyne/probes/mnemosyne/tracer.rb
 - lib/mnemosyne/probes/msgr/client.rb
 - lib/mnemosyne/probes/msgr/consumer.rb
+- lib/mnemosyne/probes/redis-client/command.rb
 - lib/mnemosyne/probes/redis/command.rb
 - lib/mnemosyne/probes/responder/respond.rb
 - lib/mnemosyne/probes/restify/base.rb
@@ -109,6 +111,7 @@ files:
 - lib/mnemosyne/railtie.rb
 - lib/mnemosyne/registry.rb
 - lib/mnemosyne/span.rb
+- lib/mnemosyne/support/redis.rb
 - lib/mnemosyne/trace.rb
 - lib/mnemosyne/version.rb
 - mnemosyne-ruby.gemspec