mnemosyne-ruby 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a1ccbc2b8a4f823ec3a848242e53f7b2a4fbd9001de8dda44a70011a90e8bbc
-  data.tar.gz: 58ee31014f79ca2a7c36f7d19625f2e8c81f1298276733ed37aa5296a420064e
+  metadata.gz: 0366be612fd9619593a970098205515b3e361bca87359e4f52d44f0fb2324f35
+  data.tar.gz: ba0c6a47f4fa471fbfee289f60992c75c6b1dff50380134a4c3f4568436c8a16
 SHA512:
-  metadata.gz: b9ec274a32fb1dfe5e9083b252246ff32a670de630d53f2bdb74e162d354d8b1fe314fe9a946fd70e70c309bfb7c7c1936d082460148102e8bde87d8c96158c2
-  data.tar.gz: 9fffad92d4957da1df5b6a7fe725bf728404716d349db348f85dff77c52730de4a8fcafb750f98d234c0cf90031a804da9a29ab7ebd928d7a84480e0cea6069f
+  metadata.gz: aabbd8356edee9ca7ddca04641c5623f6c164679145d9f8ac91d7fab8fc7a0647e9d026603f45677bdfb996d1d414889537e4ad46b1cae12d7d5401633da31dd
+  data.tar.gz: 401dea26b2ab32e8e55ae34f3b168657a1123415aed59eb4c5883fbcf39b60c8b7b2cea7b17a61691850d1eed44c391bfbd463265b9503139f94f5f244db1338

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,6 +27,7 @@ jobs:
           - rails-6.1
           - rails-7.0
           - redis-4.0
+          - redis-5.0
           - restify
           - sidekiq-5
           - sidekiq-6
@@ -61,6 +62,9 @@ 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: restify
             spec: --tag probe:restify
             gemfile: gemfiles/core.gemfile

data/.gitignore

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

data/Appraisals

@@ -56,29 +56,19 @@ appraise 'rails-52' do
   end
 end
 
-appraise 'rails-51' do
-  remove_gem 'rubocop'
-
-  group :test do
-    gem 'rails', '~> 5.1.0'
-    gem 'sqlite3', '~> 1.4'
-  end
-end
-
-appraise 'rails-50' do
+appraise 'redis-40' do
   remove_gem 'rubocop'
 
   group :test do
-    gem 'rails', '~> 5.0.0'
-    gem 'sqlite3', '~> 1.3.6'
+    gem 'redis', '~> 4.0'
   end
 end
 
-appraise 'redis-40' do
+appraise 'redis-50' do
   remove_gem 'rubocop'
 
   group :test do
-    gem 'redis', '~> 4.0'
+    gem 'redis', '~> 5.0'
   end
 end
 

data/CHANGELOG.md

@@ -4,27 +4,27 @@ 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.15.0] - 2023-08-23
 
-### New
+### Added
 
-### Changes
+- Support for `redis` gem v5+
 
-### Fixes
+### Fixed
 
-### Breaks
+- 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 +192,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
+[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'

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/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,147 @@ module Mnemosyne
       module Command
         class Probe < ::Mnemosyne::Probe
           def setup
-            ::Redis::Client.prepend ClientPatch
+            if Gem::Version.new(::Redis::VERSION) >= Gem::Version.new('5')
+              ::RedisClient.register Instrumentation
+            else
+              ::Redis::Client.prepend ClientPatch
+            end
           end
 
-          module ClientPatch
-            def process(commands)
-              trace = ::Mnemosyne::Instrumenter.current_trace
-              return super unless trace
+          module Instrumentation
+            def call(command, redis_config)
+              Instrumentation.instrument([command], client.server_url) { super }
+            end
 
-              span = ::Mnemosyne::Span.new 'db.query.redis',
-                meta: extract_span_meta(commands)
+            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.start!
+                span = ::Mnemosyne::Span.new 'db.query.redis',
+                  meta: extract_span_meta(commands, server_url)
 
-              super.tap do |retval|
-                span.meta[:error] = retval.message if retval.is_a?(::Redis::CommandError)
+                span.start!
 
-                trace << span.finish!
+                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
-            end
 
-            private
+              private
 
-            def extract_span_meta(commands)
-              {
-                server: id,
+              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),
+                  # 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
+                  # 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)
+              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)
+                  # For some commands, we also extract *some* of the arguments.
+                  name, args = parse_name_and_args(c)
+
+                  "#{name} #{args}".strip
+                end.join("\n")
+              end
 
-                "#{name} #{args}".strip
-              end.join("\n")
+              ##
+              # 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
+          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]
+          module ClientPatch
+            def process(commands)
+              Instrumentation.instrument(commands, id) { super }
             end
           end
         end

data/lib/mnemosyne/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mnemosyne-ruby
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-31 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -67,6 +67,7 @@ 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
 - lib/mnemosyne-ruby.rb
@@ -134,7 +135,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