mnemosyne-ruby 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d21523f741fef0a9443c7c93e81f220183ffd1cf19f7cdd985d69c76dee0ec51
-  data.tar.gz: ab0c1a21e65bf42ad5bb9eb92539421246643ec195257ca95a5024aa6217589b
+  metadata.gz: 4d19d4ccfaefb38e5aaa82b739e3c9b6af039b2195e366fc2a6a396acd109607
+  data.tar.gz: 0fec33a1d6e555fc5412f45d49f229cccca250f4cd875d4de3c34a2e46afe0c8
 SHA512:
-  metadata.gz: af9d3e285a017330119b9ced137fb3cf4c0059789359620170df6e4a26897036dda5ff787ee5d77d6e6960a77fc6b86443215d46f14def921ba7cbd737edc410
-  data.tar.gz: 9a36770c25abbdeb8c3ddb38a0fb4424228065fd3c58c364aa52538d0ddf5ca5ead683da36a18604ee71ff08880a9a65c461b536cddeb914d370c03655a34b73
+  metadata.gz: c57a3f90a19fa96f4dc5d7ebe77de3245d2d2fd133c7b97126b5025b6cf27a5fcb25125728f67c7aaa770e48774536bb51f604fd3586318c54982bb8f01076e7
+  data.tar.gz: a9c53ad0842c57890d9ceab21addb781297029a3dd82a22beaf213190bcb285a0e8c3de74db4491cfa46eb2c3b154354387de063096f7459f0d1b42966d60924

data/.github/workflows/build.yml

@@ -22,6 +22,7 @@ jobs:
           - rails-5.1
           - rails-5.2
           - rails-6.0
+          - redis-4.0
           - restify
           - sidekiq-5
           - sidekiq-6
@@ -50,6 +51,9 @@ jobs:
           - suite: rails-6.0
             spec: --tag probe:rails --tag ~probe
             env: BUNDLE_GEMFILE=gemfiles/rails_60.gemfile
+          - suite: redis-4.0
+            spec: --tag probe:redis
+            env: REDIS_VERSION='~> 4.0'
           - suite: restify
             spec: --tag probe:restify
           - suite: sidekiq-5
@@ -73,14 +77,15 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
 
-      - uses: actions/cache@v1
+      - uses: actions/cache@v2
         with:
           path: vendor
           key: v1-ruby-${{ matrix.ruby }}-suite-${{ matrix.suite }}
 
-      - name: Install Ruby dependencies
+      - name: Install dependencies
         run: |
           set -x
+          sudo apt install -y redis-server
           gem install bundler --version '1.17.3'
           bundle config path "$(pwd)/vendor/bundle"
           bundle config without development

data/.github/workflows/lint.yml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/setup-ruby@v1
         with:
           ruby-version: 2.6
-      - uses: actions/cache@v1
+      - uses: actions/cache@v2
         with:
           path: vendor
           key: v1-ruby-2.6

data/.rubocop.yml

@@ -3,7 +3,8 @@ AllCops:
   Exclude:
     - 'vendor/**/*'
     - 'gemfiles/**/*'
-
+  NewCops: enable
+  SuggestExtensions: False
 
 Layout/ArgumentAlignment:
   EnforcedStyle: with_fixed_indentation
@@ -26,24 +27,24 @@ Layout/MultilineMethodCallIndentation:
 Layout/SpaceInsideBlockBraces:
   EnforcedStyle: space
   EnforcedStyleForEmptyBraces: no_space
-  SpaceBeforeBlockParameters: false
+  SpaceBeforeBlockParameters: False
 
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
 
 Metrics/AbcSize:
-  Enabled: false
+  Enabled: False
 
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
 Metrics/ParameterLists:
-  Enabled: false
+  Enabled: False
 
 Metrics/MethodLength:
-  Enabled: false
+  Enabled: False
 
 
 Naming/FileName:
@@ -51,17 +52,21 @@ Naming/FileName:
     - lib/mnemosyne-ruby.rb
 
 
+# Single attr_reader statements allow easy documentation of attributes.
+Style/AccessorGrouping:
+  Enabled: False
+
 Style/Documentation:
-  Enabled: false
+  Enabled: False
 
 Style/HashEachMethods:
-  Enabled: false
+  Enabled: False
 
 Style/HashTransformKeys:
-  Enabled: false
+  Enabled: False
 
 Style/HashTransformValues:
-  Enabled: false
+  Enabled: False
 
 Style/RaiseArgs:
   EnforcedStyle: compact

data/CHANGELOG.md

@@ -4,6 +4,15 @@ 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]
+
+## [1.12.0] - 2021-08-24
+### Added
+- Support for `redis` gem (#34)
+
+### Removed
+- Support for Ruby 2.4 (hard gem requirement)
+
+## [1.11.0] - 2020-12-18
 ### Removed
 - Support for Ruby 2.4 and Rails 4.2
 
@@ -102,7 +111,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Added
 - Add platform identifier
 
-[Unreleased]: https://github.com/mnemosyne-mon/mnemosyne-ruby/compare/v1.10.0...HEAD
+[Unreleased]: https://github.com/mnemosyne-mon/mnemosyne-ruby/compare/v1.12.0...HEAD
+[1.12.0]: https://github.com/mnemosyne-mon/mnemosyne-ruby/compare/v1.10.0...v1.12.0
+[1.11.0]: https://github.com/mnemosyne-mon/mnemosyne-ruby/compare/v1.10.0...v1.11.0
 [1.10.0]: https://github.com/mnemosyne-mon/mnemosyne-ruby/compare/v1.9.0...v1.10.0
 [1.9.0]: https://github.com/mnemosyne-mon/mnemosyne-ruby/compare/v1.8.0...v1.9.0
 [1.8.0]: https://github.com/mnemosyne-mon/mnemosyne-ruby/compare/v1.7.1...v1.8.0

data/Gemfile

@@ -5,14 +5,15 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in mnemosyne.gemspec
 gemspec
 
-gem 'rake', '~> 12.0'
+gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.6'
-gem 'rubocop', '~> 0.80.1'
+gem 'rubocop', '~> 1.19.0'
 gem 'timecop', '~> 0.9.1'
 
 group :test do
   gem 'faraday', ENV['FARADAY_VERSION'], require: false
   gem 'msgr',    ENV['MSGR_VERSION'],    require: false
+  gem 'redis',   ENV['REDIS_VERSION'],   require: false
   gem 'restify', ENV['RESTIFY_VERSION'], require: false
   gem 'sidekiq', ENV['SIDEKIQ_VERSION'], require: false
 
@@ -23,7 +24,7 @@ end
 
 group :development do
   gem 'appraisal'
-  gem 'rake-release', '~> 1.2.1'
+  gem 'rake-release', '~> 1.3.0'
 
   gem 'pry', require: false
   gem 'pry-byebug', require: false

data/gemfiles/rails_50.gemfile

@@ -2,14 +2,15 @@
 
 source "https://rubygems.org"
 
-gem "rake", "~> 12.0"
+gem "rake", "~> 13.0"
 gem "rspec", "~> 3.6"
-gem "rubocop", "~> 0.80.1"
+gem "rubocop", "~> 1.19.0"
 gem "timecop", "~> 0.9.1"
 
 group :test do
   gem "faraday", nil, require: false
   gem "msgr", nil, require: false
+  gem "redis", nil, require: false
   gem "restify", nil, require: false
   gem "sidekiq", nil, require: false
   gem "rails", "~> 5.0.0", require: false
@@ -19,7 +20,7 @@ end
 
 group :development do
   gem "appraisal"
-  gem "rake-release", "~> 1.2.1"
+  gem "rake-release", "~> 1.3.0"
   gem "pry", require: false
   gem "pry-byebug", require: false
 end

data/gemfiles/rails_51.gemfile

@@ -2,14 +2,15 @@
 
 source "https://rubygems.org"
 
-gem "rake", "~> 12.0"
+gem "rake", "~> 13.0"
 gem "rspec", "~> 3.6"
-gem "rubocop", "~> 0.80.1"
+gem "rubocop", "~> 1.19.0"
 gem "timecop", "~> 0.9.1"
 
 group :test do
   gem "faraday", nil, require: false
   gem "msgr", nil, require: false
+  gem "redis", nil, require: false
   gem "restify", nil, require: false
   gem "sidekiq", nil, require: false
   gem "rails", "~> 5.1.0", require: false
@@ -19,7 +20,7 @@ end
 
 group :development do
   gem "appraisal"
-  gem "rake-release", "~> 1.2.1"
+  gem "rake-release", "~> 1.3.0"
   gem "pry", require: false
   gem "pry-byebug", require: false
 end

data/gemfiles/rails_52.gemfile

@@ -2,14 +2,15 @@
 
 source "https://rubygems.org"
 
-gem "rake", "~> 12.0"
+gem "rake", "~> 13.0"
 gem "rspec", "~> 3.6"
-gem "rubocop", "~> 0.80.1"
+gem "rubocop", "~> 1.19.0"
 gem "timecop", "~> 0.9.1"
 
 group :test do
   gem "faraday", nil, require: false
   gem "msgr", nil, require: false
+  gem "redis", nil, require: false
   gem "restify", nil, require: false
   gem "sidekiq", nil, require: false
   gem "rails", "~> 5.2.0", require: false
@@ -19,7 +20,7 @@ end
 
 group :development do
   gem "appraisal"
-  gem "rake-release", "~> 1.2.1"
+  gem "rake-release", "~> 1.3.0"
   gem "pry", require: false
   gem "pry-byebug", require: false
 end

data/gemfiles/rails_60.gemfile

@@ -2,14 +2,15 @@
 
 source "https://rubygems.org"
 
-gem "rake", "~> 12.0"
+gem "rake", "~> 13.0"
 gem "rspec", "~> 3.6"
-gem "rubocop", "~> 0.80.1"
+gem "rubocop", "~> 1.19.0"
 gem "timecop", "~> 0.9.1"
 
 group :test do
   gem "faraday", nil, require: false
   gem "msgr", nil, require: false
+  gem "redis", nil, require: false
   gem "restify", nil, require: false
   gem "sidekiq", nil, require: false
   gem "rails", "~> 6.0.0", require: false
@@ -19,7 +20,7 @@ end
 
 group :development do
   gem "appraisal"
-  gem "rake-release", "~> 1.2.1"
+  gem "rake-release", "~> 1.3.0"
   gem "pry", require: false
   gem "pry-byebug", require: false
 end

data/lib/mnemosyne/configuration.rb

@@ -33,7 +33,7 @@ module Mnemosyne
           'Platform may only contain alphanumeric characters'
       end
 
-      unless @platform =~ /\A[a-zA-Z0-9]+(\-[a-zA-Z0-9]+)*\z/
+      unless @platform =~ /\A[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\z/
         raise ArgumentError.new \
           'Platform must start and end with a alphanumeric characters'
       end
@@ -64,7 +64,7 @@ module Mnemosyne
       uri.user = amqp[:user]
       uri.host = amqp[:host]
       uri.port = amqp[:port] if amqp[:port] != DEFAULT_PORTS[uri.scheme]
-      uri.path = '/' + ::CGI.escape(amqp[:vhost]) if amqp[:vhost] != '/'
+      uri.path = "/#{::CGI.escape(amqp[:vhost])}" if amqp[:vhost] != '/'
 
       uri
     end

data/lib/mnemosyne/global.rb

@@ -2,11 +2,9 @@
 
 module Mnemosyne
   module Global
-    def trace(name, meta: {})
+    def trace(name, meta: {}, &block)
       ::ActiveSupport::Notifications.instrument 'trace.mnemosyne',
-        name: name, meta: meta do
-        yield
-      end
+        name: name, meta: meta, &block
     end
 
     def attach_error(err)

data/lib/mnemosyne/middleware/faraday.rb

@@ -5,10 +5,6 @@ require 'faraday'
 module Mnemosyne
   module Middleware
     class Faraday < ::Faraday::Middleware
-      def initialize(app)
-        @app = app
-      end
-
       def call(env)
         trace = ::Mnemosyne::Instrumenter.current_trace
 
@@ -22,7 +18,7 @@ module Mnemosyne
         env[:request_headers].merge!({
           'X-Mnemosyne-Transaction' => trace.transaction,
           'X-Mnemosyne-Origin' => span.uuid
-        }.reject {|_, v| v.nil? })
+        }.compact)
 
         @app.call(env).on_complete do |env| # rubocop:disable Lint/ShadowingOuterLocalVariable
           span.meta[:status] = env[:status]

data/lib/mnemosyne/middleware/rack.rb

@@ -101,8 +101,8 @@ module Mnemosyne
         trace.meta[:query] = env['QUERY_STRING']
         trace.meta[:protocol] = env['SERVER_PROTOCOL']
         trace.meta[:headers] = {
-          'Accept': env['HTTP_ACCEPT'],
-          'Host': env['HTTP_HOST'],
+          Accept: env['HTTP_ACCEPT'],
+          Host: env['HTTP_HOST'],
           'User-Agent': env['HTTP_USER_AGENT']
         }
       end

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

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Mnemosyne
+  module Probes
+    module Redis
+      module Command
+        class Probe < ::Mnemosyne::Probe
+          def setup
+            ::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.
+            #
+            KNOWN_ARGUMENTS = {
+              'GET' => [0],
+              'SET' => [0]
+            }.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 = command.each_with_index.map do |arg, index|
+                allowed.include?(index) ? arg : '?'
+              end.join(' ')
+
+              [name, args]
+            end
+          end
+        end
+      end
+    end
+
+    register 'Redis::Client',
+      'redis',
+      Redis::Command::Probe.new
+  end
+end

data/lib/mnemosyne/trace.rb

@@ -2,6 +2,8 @@
 
 module Mnemosyne
   class Trace < Span
+    BT_REGEXP = /^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$/.freeze
+
     attr_reader :uuid, :transaction, :origin, :span, :errors
 
     def initialize(instrumenter, name, transaction: nil, origin: nil, **kwargs)
@@ -57,8 +59,6 @@ module Mnemosyne
     end
 
     Error = Struct.new(:error) do
-      BT_REGEXP = /^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$/.freeze
-
       def serialize
         {
           type: error.class.name,

data/lib/mnemosyne/version.rb

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

data/lib/mnemosyne.rb

@@ -42,6 +42,7 @@ module Mnemosyne
     require 'mnemosyne/probes/grape/endpoint_run_filters'
     require 'mnemosyne/probes/msgr/client'
     require 'mnemosyne/probes/msgr/consumer'
+    require 'mnemosyne/probes/redis/command'
     require 'mnemosyne/probes/responder/respond'
     require 'mnemosyne/probes/restify/base'
     require 'mnemosyne/probes/sidekiq/client'

data/mnemosyne-ruby.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
   spec.require_paths = %w[lib]
 
+  spec.required_ruby_version = '>= 2.5'
   spec.add_runtime_dependency 'activesupport', '>= 4'
   spec.add_runtime_dependency 'bunny'
 

data/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mnemosyne-ruby
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2021-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -65,7 +65,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -106,6 +105,7 @@ files:
 - lib/mnemosyne/probes/mnemosyne/tracer.rb
 - lib/mnemosyne/probes/msgr/client.rb
 - lib/mnemosyne/probes/msgr/consumer.rb
+- lib/mnemosyne/probes/redis/command.rb
 - lib/mnemosyne/probes/responder/respond.rb
 - lib/mnemosyne/probes/restify/base.rb
 - lib/mnemosyne/probes/sidekiq/client.rb
@@ -116,6 +116,7 @@ files:
 - lib/mnemosyne/trace.rb
 - lib/mnemosyne/version.rb
 - mnemosyne-ruby.gemspec
+- renovate.json
 - scripts/console
 - scripts/setup
 homepage: http://github.com/jgraichen/mnemosyne-ruby
@@ -130,14 +131,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.1
+rubygems_version: 3.2.4
 signing_key: 
 specification_version: 4
 summary: Ruby/Rails client for Mnemosyne APM

data/.travis.yml

@@ -1,41 +0,0 @@
-language: ruby
-cache: bundler
-sudo: required
-services:
-  - rabbitmq
-addons:
-  apt:
-    packages:
-      - rabbitmq-server
-rvm:
-  - 2.7.0
-  - 2.6.5
-  - 2.5.7
-  - 2.4.9
-env:
-  - SPEC='--tag ~probe'
-  - SPEC='--tag probe:faraday' FARADAY_VERSION='~> 0.9'
-  - SPEC='--tag probe:faraday' FARADAY_VERSION='~> 1.0'
-  - SPEC='--tag probe:msgr'
-  - SPEC='--tag probe:rack'
-  - SPEC='--tag probe:rails --tag ~probe' BUNDLE_GEMFILE=gemfiles/rails_42.gemfile
-  - SPEC='--tag probe:rails --tag ~probe' BUNDLE_GEMFILE=gemfiles/rails_50.gemfile
-  - SPEC='--tag probe:rails --tag ~probe' BUNDLE_GEMFILE=gemfiles/rails_51.gemfile
-  - SPEC='--tag probe:rails --tag ~probe' BUNDLE_GEMFILE=gemfiles/rails_52.gemfile
-  - SPEC='--tag probe:rails --tag ~probe' BUNDLE_GEMFILE=gemfiles/rails_60.gemfile
-  - SPEC='--tag probe:restify'
-  - SPEC='--tag probe:sidekiq' SIDEKIQ_VERSION='~> 5.0'
-  - SPEC='--tag probe:sidekiq' SIDEKIQ_VERSION='~> 6.0'
-
-before_install:
-  - echo yes | rvm gemset delete global
-  - gem install bundler --version '~> 1.0'
-script:
-  - bundle exec rspec ${SPEC}
-
-matrix:
-  exclude:
-    - rvm: 2.4.9
-      env: SPEC='--tag probe:rails --tag ~probe' BUNDLE_GEMFILE=gemfiles/rails_60.gemfile
-    - rvm: 2.4.9
-      env: SPEC='--tag probe:sidekiq' SIDEKIQ_VERSION='~> 6.0'