Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use direct method replacement for the redis patcher #56

Merged
merged 1 commit into from
Jan 17, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 0 additions & 72 deletions lib/ddtrace/contrib/redis/core.rb

This file was deleted.

81 changes: 78 additions & 3 deletions lib/ddtrace/contrib/redis/patcher.rb
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
# requirements should be kept minimal as Patcher is a shared requirement.

require 'ddtrace/ext/app_types'
require 'ddtrace/contrib/redis/tags'
require 'ddtrace/contrib/redis/quantize'

module Datadog
module Contrib
module Redis
SERVICE = 'redis'.freeze
DRIVER = 'redis.driver'.freeze

# Patcher enables patching of 'redis' module.
# This is used in monkey.rb to automatically apply patches
module Patcher
Expand All @@ -15,9 +22,9 @@ def patch
if !@patched && (defined?(::Redis::VERSION) && \
Gem::Version.new(::Redis::VERSION) >= Gem::Version.new('3.0.0'))
begin
require 'ddtrace/contrib/redis/core'
::Redis.prepend Datadog::Contrib::Redis::TracedRedis
::Redis::Client.prepend Datadog::Contrib::Redis::TracedRedisClient
patch_redis()
patch_redis_client()

@patched = true
rescue StandardError => e
Datadog::Tracer.log.error("Unable to apply Redis integration: #{e}")
Expand All @@ -26,6 +33,74 @@ def patch
@patched
end

def patch_redis
::Redis.module_eval do
def datadog_pin=(pin)
# Forward the pin to client, which actually traces calls.
Datadog::Pin.onto(client, pin)
end

def datadog_pin
# Get the pin from client, which actually traces calls.
Datadog::Pin.get_from(client)
end
end
end

# rubocop:disable Metrics/MethodLength
def patch_redis_client
::Redis::Client.class_eval do
alias_method :initialize_without_datadog, :initialize
remove_method :initialize
def initialize(*args)
pin = Datadog::Pin.new(SERVICE, app: 'redis', app_type: Datadog::Ext::AppTypes::DB)
pin.onto(self)
initialize_without_datadog(*args)
end

alias_method :call_without_datadog, :call
remove_method :call
def call(*args, &block)
pin = Datadog::Pin.get_from(self)
return call_without_datadog(*args, &block) unless pin

response = nil
pin.tracer.trace('redis.command') do |span|
span.service = pin.service
span.span_type = Datadog::Ext::Redis::TYPE
span.resource = Datadog::Contrib::Redis::Quantize.format_command_args(*args)
span.set_tag(Datadog::Ext::Redis::RAWCMD, span.resource)
Datadog::Contrib::Redis::Tags.set_common_tags(self, span)

response = call_without_datadog(*args, &block)
end

response
end

alias_method :call_pipeline_without_datadog, :call_pipeline
remove_method :call_pipeline
def call_pipeline(*args, &block)
pin = Datadog::Pin.get_from(self)
return call_pipeline_without_datadog(*args, &block) unless pin

response = nil
pin.tracer.trace('redis.command') do |span|
span.service = pin.service
span.span_type = Datadog::Ext::Redis::TYPE
commands = args[0].commands.map { |c| Datadog::Contrib::Redis::Quantize.format_command_args(c) }
span.resource = commands.join("\n")
span.set_tag(Datadog::Ext::Redis::RAWCMD, span.resource)
Datadog::Contrib::Redis::Tags.set_common_tags(self, span)

response = call_pipeline_without_datadog(*args, &block)
end

response
end
end
end

# patched? tells wether patch has been successfully applied
def patched?
@patched
Expand Down
40 changes: 40 additions & 0 deletions test/contrib/redis/method_replaced.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@

require 'contrib/redis/test_helper'
require 'helper'

class RedisMethodReplacedTest < Minitest::Test
# We want to make sure that the patcher works even when the patched methods
# have already been replaced by another library.

REDIS_HOST = '127.0.0.1'.freeze
REDIS_PORT = 46379

def setup
::Redis::Client.class_eval do
alias_method :call_original, :call
remove_method :call
def call(*args, &block)
@datadog_test_called ||= false
if @datadog_test_called
raise Minitest::Assertion, 'patched methods called in infinite loop'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

end
@datadog_test_called = true

call_original(*args, &block)
end
end
end

def test_main
redis = Redis.new(host: REDIS_HOST, port: REDIS_PORT)
redis.call(['ping', 'hello world'])
end

def teardown
::Redis::Client.class_eval do
remove_method :call
alias_method :call, :call_original
remove_method :call_original
end
end
end