redis-instrumentation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8d1dd9a6aa8c0a4aa6b9fd5988af8b0e28169d4
+  data.tar.gz: 9891668d902bf5462119661664e51cca97c9fd60
+SHA512:
+  metadata.gz: 4d4f427caf286cb9c81ca64fdb8721a5c65fd314b378c841bd3c58f0cba8a46a3e0ef01a65f6a022e3976e5d23df822626ff661b2836550130c98654f571d5c2
+  data.tar.gz: c8aeb182985266ff38c7de8b8d09c3f7fa0918e44e3e5d8179dec3603ba17e8f5d80a8c45c447e07cfd1e27b9aba9c5bb1584e4196317b0e9e2021b9dcc87674

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Appraisals

@@ -0,0 +1,11 @@
+appraise 'redis-latest' do
+  gem 'redis'
+end
+
+appraise 'redis-4.1.0' do
+  gem 'redis', '4.1.0'
+end
+
+appraise 'redis-4.0.1' do
+  gem 'redis', '4.0.1'
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in redis-instrumentation.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ashwin Chandrasekar
+
+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,49 @@
+# Redis::Instrumentation
+
+This gem provides OpenTracing auto-instrumentation for commands send through the Redis client.
+
+## Supported Versions
+
+- MRI 2.0 and newer
+- Redis 4.0.1 and newer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis-instrumentation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-instrumentation
+
+## Usage
+
+```ruby
+require 'redis/instrumentation'
+
+Redis::Instrumentation.instrument
+```
+
+`instrument` takes an optional argument, `tracer`, to set a custom OpenTracing
+tracer. It will default to `OpenTracing.global_tracer`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/signalfx/ruby-redis-instrumentation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis/instrumentation"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redis/instrumentation.rb

@@ -0,0 +1,80 @@
+require "redis/instrumentation/version"
+require "opentracing"
+require "redis"
+
+# this is a class instead of module to match how Redis does it
+# otherwise this name will collide
+class Redis
+  module Instrumentation
+    COMMON_TAGS = {
+      'span.kind' => 'client',
+      'component' => 'ruby-redis',
+      'db.type' => 'redis',
+    }.freeze
+
+    class << self
+
+      attr_accessor :tracer
+
+      def instrument(tracer: OpenTracing.global_tracer)
+        begin
+          require 'redis'
+        rescue LoadError => e
+          return
+        end
+
+        @tracer = tracer
+
+        patch_client if !@patched_client
+        @patched_client = true
+      end
+
+      def patch_client
+        ::Redis::Client.class_eval do
+          alias_method :call_original, :call
+          alias_method :call_pipeline_original, :call_pipeline
+
+          def call(command, trace: true)
+            tags = ::Redis::Instrumentation::COMMON_TAGS.dup
+            tags['db.statement'] = command.join(' ')
+            tags['db.instance'] = db
+            tags['peer.address'] = "redis://#{host}:#{port}"
+
+            # command[0] is usually the actual command name
+            scope = ::Redis::Instrumentation.tracer.start_active_span("redis.#{command[0]}", tags: tags)
+
+            call_original(command)
+          rescue => e
+            if scope
+              scope.span.set_tag("error", true)
+              scope.span.log_kv(key: "message", value: e.message)
+            end
+            raise e
+          ensure
+            scope.close if scope
+          end
+
+          def call_pipeline(pipeline)
+            commands = pipeline.commands
+            tags = ::Redis::Instrumentation::COMMON_TAGS.dup
+            tags['db.statement'] = commands.empty? ? "" : commands.map{ |arr| arr.join(' ') }.join(', ')
+            tags['db.instance'] = db
+            tags['peer.address'] = "redis://#{host}:#{port}"
+
+            scope = ::Redis::Instrumentation.tracer.start_active_span("redis.pipelined", tags: tags)
+
+            call_pipeline_original(pipeline)
+          rescue => e
+            if scope
+              scope.span.set_tag("error", true)
+              scope.span.log_kv(key: "message", value: e.message)
+            end
+            raise e
+          ensure
+            scope.close if scope
+          end
+        end
+      end # patch_client
+    end
+  end
+end

data/lib/redis/instrumentation/version.rb

@@ -0,0 +1,3 @@
+module RedisInstrumentation
+    VERSION = "0.1.0"
+end

data/redis-instrumentation.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redis/instrumentation/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis-instrumentation"
+  spec.version       = RedisInstrumentation::VERSION
+  spec.authors       = ["Ashwin Chandrasekar"]
+  spec.email         = ["achandrasekar@signalfx.com"]
+
+  spec.summary       = %q{OpenTracing instrumentation for the Redis Ruby client.}
+  spec.homepage      = "https://github.com/signalfx/ruby-redis-instrumentation"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "opentracing", "> 0.3"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "appraisal", "~> 2.2"
+  spec.add_development_dependency "opentracing_test_tracer", "~> 0.1"
+  spec.add_development_dependency "redis", "~> 4.1.0"
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: redis-instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ashwin Chandrasekar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: opentracing_test_tracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+description: 
+email:
+- achandrasekar@signalfx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redis/instrumentation.rb
+- lib/redis/instrumentation/version.rb
+- redis-instrumentation.gemspec
+homepage: https://github.com/signalfx/ruby-redis-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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: OpenTracing instrumentation for the Redis Ruby client.
+test_files: []