mnemosyne-ruby 1.14.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a1ccbc2b8a4f823ec3a848242e53f7b2a4fbd9001de8dda44a70011a90e8bbc
-  data.tar.gz: 58ee31014f79ca2a7c36f7d19625f2e8c81f1298276733ed37aa5296a420064e
+  metadata.gz: 43c02b1229d902d187dee8281c88820a95d13a30ee594af7ca131645ffd85485
+  data.tar.gz: c6ebd7b760e56adacacbb89390d5abc463ded7a72e37d346de0d51fb615a6582
 SHA512:
-  metadata.gz: b9ec274a32fb1dfe5e9083b252246ff32a670de630d53f2bdb74e162d354d8b1fe314fe9a946fd70e70c309bfb7c7c1936d082460148102e8bde87d8c96158c2
-  data.tar.gz: 9fffad92d4957da1df5b6a7fe725bf728404716d349db348f85dff77c52730de4a8fcafb750f98d234c0cf90031a804da9a29ab7ebd928d7a84480e0cea6069f
+  metadata.gz: 14220075cac092132c13d0c6d82bdfbc374c0c7a50db0d3e0d07e950fae0eda073b6958c30657f3bb089cbfcc0137d18fd56ae2f505e1f16d61917b929d25a6e
+  data.tar.gz: a568b0e9ea1b96549ed78082c9ccef3946a5a8dbd8b7b9dc231a609a52d59c928069d7f7a5cf4c99f509589830279ff16b1e05a055114674d5dac8d2ccf85274

data/.github/workflows/lint.yml

@@ -6,7 +6,7 @@ on:
 jobs:
   rubocop:
     name: rubocop
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     env:
       BUNDLE_WITHOUT: development test

data/.github/workflows/test.yml

@@ -6,7 +6,7 @@ on:
 jobs:
   test:
     name: Ruby ${{ matrix.ruby }} / ${{ matrix.suite }}
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     strategy:
       fail-fast: false
@@ -27,9 +27,12 @@ jobs:
           - rails-6.1
           - rails-7.0
           - redis-4.0
+          - redis-5.0
+          - redis-client
           - restify
           - sidekiq-5
           - sidekiq-6
+          - sidekiq-7
         include:
           - suite: core
             spec: --tag ~probe
@@ -61,6 +64,12 @@ jobs:
           - suite: redis-4.0
             spec: --tag probe:redis
             gemfile: gemfiles/redis_40.gemfile
+          - 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
@@ -70,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/.gitignore

@@ -4,6 +4,8 @@
 /coverage/
 /doc/
 /Gemfile.lock
+/gemfiles/.bundle/
+/log/
 /pkg/
 /spec/examples.txt
 /spec/reports/

data/Appraisals

@@ -56,44 +56,42 @@ appraise 'rails-52' do
   end
 end
 
-appraise 'rails-51' do
+appraise 'redis-40' do
   remove_gem 'rubocop'
 
   group :test do
-    gem 'rails', '~> 5.1.0'
-    gem 'sqlite3', '~> 1.4'
+    gem 'redis', '~> 4.0'
   end
 end
 
-appraise 'rails-50' do
+appraise 'redis-50' do
   remove_gem 'rubocop'
 
   group :test do
-    gem 'rails', '~> 5.0.0'
-    gem 'sqlite3', '~> 1.3.6'
+    gem 'redis', '~> 5.0'
   end
 end
 
-appraise 'redis-40' do
+appraise 'sidekiq-50' do
   remove_gem 'rubocop'
 
   group :test do
-    gem 'redis', '~> 4.0'
+    gem 'sidekiq', '~> 5.0'
   end
 end
 
-appraise 'sidekiq-50' do
+appraise 'sidekiq-60' do
   remove_gem 'rubocop'
 
   group :test do
-    gem 'sidekiq', '~> 5.0'
+    gem 'sidekiq', '~> 6.0'
   end
 end
 
-appraise 'sidekiq-60' do
+appraise 'sidekiq-70' do
   remove_gem 'rubocop'
 
   group :test do
-    gem 'sidekiq', '~> 6.0'
+    gem 'sidekiq', '~> 7.0'
   end
 end

data/CHANGELOG.md

@@ -4,27 +4,37 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Unreleased
+## [Unreleased]
 
----
+## [1.16.0] - 2023-08-24
 
-### New
+### Added
+
+- Separate new tracing for `redis-client` gem
+
+### Fixed
+
+- `NoMethodError` when `RedisClient` is used directly
 
-### Changes
+## [1.15.0] - 2023-08-23
 
-### Fixes
+### Added
+
+- Support for `redis` gem v5+
 
-### Breaks
+### Fixed
+
+- Method signature for `#publish` in MSGR probe
 
 ## [1.14.0] - (2023-07-31)
 
-### New
+### Added
 
 - Tests with Ruby 3.2
 
 ### Changed
 
-- Replace reprecated `!render.view_component` hook with `render.view_component`
+- Replace deprecated `!render.view_component` hook with `render.view_component`
 - Removed tests for Rails 5.0 and 5.1
 
 ## [1.13.0] - 2022-04-14
@@ -192,6 +202,9 @@ 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.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
 [1.12.1]: https://github.com/mnemosyne-mon/mnemosyne-ruby/compare/v1.12.1...v1.12.0

data/Gemfile

@@ -6,7 +6,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake', '~> 13.0'
-gem 'rubocop', '~> 1.54.0'
+gem 'rubocop', '~> 1.56.0'
 
 group :test do
   gem 'rspec', '~> 3.6'
@@ -16,6 +16,7 @@ group :test do
   gem 'msgr'
   gem 'rails'
   gem 'redis'
+  gem 'redis-client'
   gem 'restify'
   gem 'sidekiq'
   gem 'sqlite3'

data/gemfiles/redis_50.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", "~> 5.0"
+  gem "restify"
+  gem "sidekiq"
+  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/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/msgr/client.rb

@@ -13,7 +13,7 @@ module Mnemosyne
         end
 
         module Instrumentation
-          def publish(payload, **options)
+          def publish(payload, options = {})
             if (trace = ::Mnemosyne::Instrumenter.current_trace)
               meta = {}
               span = ::Mnemosyne::Span.new(NAME, meta: meta)

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

@@ -6,121 +6,15 @@ module Mnemosyne
       module Command
         class Probe < ::Mnemosyne::Probe
           def setup
+            # Redis v5+ used redis-client, which has it's own probe
+            return if Gem::Version.new(::Redis::VERSION) >= Gem::Version.new('5')
+
             ::Redis::Client.prepend ClientPatch
           end
 
           module ClientPatch
             def process(commands)
-              trace = ::Mnemosyne::Instrumenter.current_trace
-              return super unless trace
-
-              span = ::Mnemosyne::Span.new 'db.query.redis',
-                meta: extract_span_meta(commands)
-
-              span.start!
-
-              super.tap do |retval|
-                span.meta[:error] = retval.message if retval.is_a?(::Redis::CommandError)
-
-                trace << span.finish!
-              end
-            end
-
-            private
-
-            def extract_span_meta(commands)
-              {
-                server: id,
-
-                # 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]
+              ::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 = 14
+    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.14.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-31 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -67,8 +67,10 @@ files:
 - gemfiles/rails_61.gemfile
 - gemfiles/rails_70.gemfile
 - gemfiles/redis_40.gemfile
+- 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
@@ -99,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
@@ -108,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
@@ -134,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.18
 signing_key: 
 specification_version: 4
 summary: Ruby/Rails client for Mnemosyne APM