redis-rails-instrumentation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7433588470767e405e31709a7097bcd0c7292fc0
+  data.tar.gz: bbc5150918bec83f6811f5d4f4d5b1f0089f96df
+SHA512:
+  metadata.gz: 6e1971b2b6612aa338375c4062e9e7007c690d0b65c0a5704572d712333d5b96c91da21d7f1074bcdb7aee717ca31aff1e2d0874456f3e7b5afc7e0e8ab79c86
+  data.tar.gz: d30fbd89664d94ef8757e3f159c431cbd8c53a209a601b9c4ebde9963418e97c4eea8279f5765b28a3c88d7322f38614a64a2820abb5ccd943e4c1463e1be679

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  Exclude:
+    - redis-rails-instrumentation.gemspec
+    - lib/redis/rails/instrumentation/version.rb
+    - "vendor/**/*"
+    - "gemfiles/vendor/**/*"
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/ConstantName:
+  Enabled: false
+
+Style/FileName:
+  Exclude:
+    - 'lib/redis-rails-instrumentation.rb'
+
+Style/LineLength:
+  Exclude:
+    - 'redis-rails-instrumentation.gemspec'

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis-rails-instrumentation.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ville Lautanala
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Redis Rails Instrumentation [![Build Status](https://travis-ci.org/lautis/redis-rails-instrumentation.svg?branch=master)](https://travis-ci.org/lautis/redis-rails-instrumentation)
+
+Railtie to include Redis commands in Rails logging.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis-rails-instrumentation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-rails-instrumentation
+
+After you've started your Rails application, your Rails logs should include
+Redis commands.
+
+If you have debug logging enabled, individual commands are printed out:
+
+      Redis (1.12ms)  [ GET test ]
+
+A total runtime is also included per each request:
+
+      Completed 200 OK in 1ms (Views: 0.2ms | ActiveRecord: 0.4ms | Redis: 1.12ms)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/redis-rails-instrumentation/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/redis-rails-instrumentation.rb

@@ -0,0 +1 @@
+require 'redis/rails/instrumentation'

data/lib/redis/rails/instrumentation.rb

@@ -0,0 +1,33 @@
+require 'redis'
+require 'redis/rails/instrumentation/logging'
+require 'redis/rails/instrumentation/version'
+require 'active_support'
+require 'sweet_notifications'
+
+class Redis
+  module Rails
+    module Instrumentation
+      Railtie, LogSubscriber = SweetNotifications.subscribe :redis,
+                                                            label: 'Redis' do
+        color ActiveSupport::LogSubscriber::RED
+
+        event :command do |event|
+          next unless logger.debug?
+          cmds = event.payload[:commands]
+
+          output = cmds.map do |name, *args|
+            if args.present?
+              "[ #{name.to_s.upcase} #{args.join(' ')} ]"
+            else
+              "[ #{name.to_s.upcase} ]"
+            end
+          end.join(' ')
+
+          debug message(event, 'Redis', output)
+        end
+      end
+    end
+  end
+end
+
+Redis::Client.send(:prepend, Redis::Rails::Instrumentation::Logging)

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

@@ -0,0 +1,15 @@
+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

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

@@ -0,0 +1,7 @@
+class Redis
+  module Rails
+    module Instrumentation
+      VERSION = "0.1.0"
+    end
+  end
+end

data/redis-rails-instrumentation.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis/rails/instrumentation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redis-rails-instrumentation'
+  spec.version       = Redis::Rails::Instrumentation::VERSION
+  spec.authors       = ['Ville Lautanala']
+  spec.email         = ['lautis@gmail.com']
+  spec.summary       = 'Railtie to include Redis commands in Rails logging.'
+  spec.description   = 'Log Redis commands and their total runtime in Rails request log.'
+  spec.homepage      = 'https://github.com/lautis/redis-rails-instrumentation'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'redis', '~> 3.0'
+  spec.add_dependency 'activesupport', '>= 3.0'
+  spec.add_dependency 'sweet_notifications', '~> 0.2'
+  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'
+end

data/spec/redis/rails/instrumentation_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'redis'
+
+class Redis
+  module Rails
+    describe Instrumentation do
+      let(:redis) { Redis.new }
+      let(:railtie) { Instrumentation::Railtie }
+
+      after do
+        if railtie.instance.send(:instance_variable_defined?, :@ran)
+          railtie.instance.send(:remove_instance_variable, :@ran)
+        end
+      end
+
+      it 'initializes a Railtie' do
+        expect(railtie.superclass).to eq(::Rails::Railtie)
+      end
+
+      it 'logs runtimes' do
+        Instrumentation::Railtie.run_initializers
+        redis.get('test')
+        expect(Instrumentation::LogSubscriber.runtime).to be > 0
+      end
+
+      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')
+        end
+        expect(@logger.logged(:debug)[0])
+          .to match(/Redis \(\d+\.\d+ms\)  \[ GET test1 \] \[ GET test2 \]/)
+      end
+
+      it 'logs commands to logger' do
+        @logger.level = Logger::DEBUG
+        Instrumentation::Railtie.run_initializers
+        redis.get('test')
+        expect(@logger.logged(:debug)[0])
+          .to match(/Redis \(\d+\.\d+ms\)  \[ GET test \]/)
+      end
+
+      it 'omits debug logging in production' do
+        @logger.level = Logger::ERROR
+        Instrumentation::Railtie.run_initializers
+        redis.get('test')
+        expect(@logger.logged(:debug)).to be_empty
+        expect(@logger.logged(:info)).to be_empty
+        expect(@logger.logged(:error)).to be_empty
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'active_support/log_subscriber/test_helper'
+require 'redis-rails-instrumentation'
+
+RSpec.configure do |config|
+  config.include ActiveSupport::LogSubscriber::TestHelper
+  config.profile_examples = 10
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+
+  config.before do
+    setup # Setup LogSubscriber::TestHelper
+    allow(Redis::Rails::Instrumentation::LogSubscriber).to receive(:logger)
+      .and_return(ActiveSupport::LogSubscriber::TestHelper::MockLogger.new)
+  end
+
+  config.after do
+    teardown # Tear down LogSubscriber::TestHelper
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: redis-rails-instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ville Lautanala
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sweet_notifications
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  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
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Log Redis commands and their total runtime in Rails request log.
+email:
+- lautis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".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/version.rb
+- redis-rails-instrumentation.gemspec
+- spec/redis/rails/instrumentation_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lautis/redis-rails-instrumentation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Railtie to include Redis commands in Rails logging.
+test_files:
+- spec/redis/rails/instrumentation_spec.rb
+- spec/spec_helper.rb