redis-rails-instrumentation 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f77ad22f3ab95a646a40999de5e772ac9eca1107
-  data.tar.gz: 0ae988ec9866cb2443aee39a0c2d4d046fa0c499
+SHA256:
+  metadata.gz: b0066f547a9c55c043c785fc3d811ade63174793c6c15e46609dc3fe7ce34a9c
+  data.tar.gz: a2b8dd463d10f4352b4957c4d266f906d7c3b424e722a6216b3231e810cb0428
 SHA512:
-  metadata.gz: bb535484b3e4870dc4ed2f784fc443264924df4a324dceedf2a888b4d8ff436357f2da65af48a605032fa8671877672f12c10d276669acc8df8b1b4c7ffafc94
-  data.tar.gz: 7511ba14bc0345597d7da545e84dbad4bc895ea16595c362b8788cccb5cd5d03218c48bf87518a7f19760a8ff42c6c9a320d09ce8710f040a05838bbffc5b055
+  metadata.gz: 2c045781ddca460be310dbe70b445207499fb0b93571fbfd31814112cacdb33ab5cb0388dc900eafa301f025668d235d7db2a4fa665feb4c5282bb5ce84e4077
+  data.tar.gz: d09c1414b73011e358410ed9baf6f0543ea78db2ab3f03c7e576fcd75194c10f9228298aeec516acf0aacfa131242516245bfcde8361d2196a27d0c50dd06879

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: >-
+      Test (${{ matrix.ruby }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "3.1"
+          - "3.2"
+          - "3.3"
+          - "3.4"
+    steps:
+      - uses: actions/checkout@v2
+      - uses: supercharge/redis-github-action@1.8.0
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake

data/README.md

@@ -1,7 +1,9 @@
-# Redis Rails Instrumentation [![Build Status](https://travis-ci.org/lautis/redis-rails-instrumentation.svg?branch=master)](https://travis-ci.org/lautis/redis-rails-instrumentation)
+# Redis Rails Instrumentation
 
 Railtie to include Redis commands in Rails logging.
 
+Version 2.0 and newer only supports redis-rb 5.x. If you need older version, please use 1.0.1.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/redis/rails/instrumentation/middleware.rb

@@ -0,0 +1,21 @@
+class Redis
+  module Rails
+    module Middleware
+      def connect(redis_config)
+        ActiveSupport::Notifications.instrument("connect.redis") { super }
+      end
+
+      def call(command, redis_config)
+        ActiveSupport::Notifications.instrument('command.redis', commands: [command]) do
+            super
+          end
+      end
+
+      def call_pipelined(commands, redis_config)
+        ActiveSupport::Notifications.instrument('command.redis', commands: commands) do
+            super
+          end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 class Redis
   module Rails
     module Instrumentation
-      VERSION = "1.0.0".freeze
+      VERSION = "2.0.0".freeze
     end
   end
 end

data/lib/redis/rails/instrumentation.rb

@@ -1,5 +1,5 @@
 require 'redis'
-require 'redis/rails/instrumentation/logging'
+require 'redis/rails/instrumentation/middleware'
 require 'redis/rails/instrumentation/version'
 require 'active_support'
 require 'sweet_notifications'
@@ -17,7 +17,7 @@ class Redis
 
           output = cmds.map do |name, *args|
             if !args.empty?
-              "[ #{name.to_s.upcase} #{args.join(' ')} ]"
+              "[ #{name.to_s.upcase} #{format_arguments(args)} ]"
             else
               "[ #{name.to_s.upcase} ]"
             end
@@ -25,9 +25,21 @@ class Redis
 
           debug message(event, 'Redis', output)
         end
+
+        private
+
+        def format_arguments(args)
+          args.map do |arg|
+            if arg.respond_to?(:encoding) && arg.encoding == Encoding::ASCII_8BIT
+              '<BINARY DATA>'
+            else
+              arg
+            end
+          end.join(' ')
+        end
       end
     end
   end
 end
 
-Redis::Client.send(:prepend, Redis::Rails::Instrumentation::Logging)
+RedisClient.register(Redis::Rails::Middleware)

data/redis-rails-instrumentation.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'redis', '>= 3.0', '< 5'
+  spec.add_dependency 'redis', '>= 5', '< 6'
   spec.add_dependency 'activesupport', '>= 3.0'
   spec.add_dependency 'sweet_notifications', '~> 1.0'
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'bundler', '>= 1.6'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.required_ruby_version = '>= 2.0.0'

data/spec/redis/rails/instrumentation_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'redis'
+require 'base64'
 
 class Redis
   module Rails
@@ -26,9 +27,9 @@ class Redis
       it 'logs pipelined commands to a single line' do
         @logger.level = Logger::DEBUG
         Instrumentation::Railtie.run_initializers
-        redis.pipelined do
-          redis.get('test1')
-          redis.get('test2')
+        redis.pipelined do |pipeline|
+          pipeline.get('test1')
+          pipeline.get('test2')
         end
         expect(@logger.logged(:debug)[0])
           .to match(/Redis \(\d+\.\d+ms\)  \[ GET test1 \] \[ GET test2 \]/)
@@ -42,6 +43,14 @@ class Redis
           .to match(/Redis \(\d+\.\d+ms\)  \[ GET test \]/)
       end
 
+      it 'truncates binary data' do
+        @logger.level = Logger::DEBUG
+        Instrumentation::Railtie.run_initializers
+        redis.set('test', Base64.decode64("R0lGODlhAQABAPAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="))
+        expect(@logger.logged(:debug)[0])
+          .to match(/Redis \(\d+\.\d+ms\)  \[ SET test <BINARY DATA> \]/)
+      end
+
       it 'omits debug logging in production' do
         @logger.level = Logger::ERROR
         Instrumentation::Railtie.run_initializers

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: redis-rails-instrumentation
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ville Lautanala
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-18 00:00:00.000000000 Z
+date: 2025-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -16,20 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -62,14 +61,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
@@ -107,16 +106,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/redis-rails-instrumentation.rb
 - lib/redis/rails/instrumentation.rb
-- lib/redis/rails/instrumentation/logging.rb
+- lib/redis/rails/instrumentation/middleware.rb
 - lib/redis/rails/instrumentation/version.rb
 - redis-rails-instrumentation.gemspec
 - spec/redis/rails/instrumentation_spec.rb
@@ -125,7 +124,6 @@ homepage: https://github.com/lautis/redis-rails-instrumentation
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -140,9 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Railtie to include Redis commands in Rails logging.
 test_files:

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-sudo: false
-cache: bundler
-rvm:
-  - 2.1.10
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
-  - jruby-9.1.7.0
-services:
-  - redis-server

data/lib/redis/rails/instrumentation/logging.rb

@@ -1,15 +0,0 @@
-class Redis
-  module Rails
-    module Instrumentation
-      # Logging monkeypatch for Redis to emit ActiveSupport::Notification events
-      module Logging
-        def logging(commands, &block)
-          ActiveSupport::Notifications.instrument('command.redis',
-                                                  commands: commands) do
-            return super(commands, &block)
-          end
-        end
-      end
-    end
-  end
-end