Change the Redis client patch to use prepend #1743
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # typed: false | ||
| require 'ddtrace/contrib/patcher' | ||
| require 'ddtrace/contrib/redis/ext' | ||
| require 'ddtrace/contrib/redis/configuration/resolver' | ||
|
|
||
| module Datadog | ||
| module Contrib | ||
| module Redis | ||
| # Instrumentation for Redis | ||
| module Instrumentation | ||
| def self.included(base) | ||
| base.prepend(InstanceMethods) | ||
| end | ||
|
|
||
| # InstanceMethods - implementing instrumentation | ||
| module InstanceMethods | ||
|
There was a problem hiding this comment. The code in this module was moved verbatim from the patcher module except for the changes:
|
||
| def call(*args, &block) | ||
| pin = Datadog::Pin.get_from(self) | ||
| return super unless pin && pin.tracer | ||
|
|
||
| response = nil | ||
| pin.tracer.trace(Datadog::Contrib::Redis::Ext::SPAN_COMMAND) do |span| | ||
| span.service = pin.service | ||
| span.span_type = Datadog::Contrib::Redis::Ext::TYPE | ||
| span.resource = get_command(args) | ||
| Datadog::Contrib::Redis::Tags.set_common_tags(self, span) | ||
|
|
||
| response = super | ||
| end | ||
|
|
||
| response | ||
| end | ||
|
|
||
| def call_pipeline(*args, &block) | ||
| pin = Datadog::Pin.get_from(self) | ||
| return super unless pin && pin.tracer | ||
|
|
||
| response = nil | ||
| pin.tracer.trace(Datadog::Contrib::Redis::Ext::SPAN_COMMAND) do |span| | ||
| span.service = pin.service | ||
| span.span_type = Datadog::Contrib::Redis::Ext::TYPE | ||
| commands = get_pipeline_commands(args) | ||
| span.resource = commands.join("\n") | ||
| span.set_metric Datadog::Contrib::Redis::Ext::METRIC_PIPELINE_LEN, commands.length | ||
| Datadog::Contrib::Redis::Tags.set_common_tags(self, span) | ||
|
|
||
| response = super | ||
| end | ||
|
|
||
| response | ||
| end | ||
|
|
||
| def datadog_pin | ||
| @datadog_pin ||= begin | ||
| pin = Datadog::Pin.new( | ||
| datadog_configuration[:service_name], | ||
| app: Ext::APP, | ||
| app_type: Datadog::Ext::AppTypes::DB, | ||
| tracer: -> { datadog_configuration[:tracer] } | ||
| ) | ||
| pin.onto(self) | ||
| end | ||
| end | ||
|
|
||
| private | ||
|
|
||
| def get_command(args) | ||
| if datadog_configuration[:command_args] | ||
| Datadog::Contrib::Redis::Quantize.format_command_args(*args) | ||
| else | ||
| Datadog::Contrib::Redis::Quantize.get_verb(*args) | ||
| end | ||
| end | ||
|
|
||
| def get_pipeline_commands(args) | ||
| if datadog_configuration[:command_args] | ||
| args[0].commands.map { |c| Datadog::Contrib::Redis::Quantize.format_command_args(c) } | ||
| else | ||
| args[0].commands.map { |c| Datadog::Contrib::Redis::Quantize.get_verb(c) } | ||
| end | ||
| end | ||
|
|
||
| def datadog_configuration | ||
| Datadog.configuration[:redis, options] | ||
| end | ||
| end | ||
| end | ||
| end | ||
| end | ||
| end | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # typed: false | ||
| require 'ddtrace/contrib/support/spec_helper' | ||
| require 'ddtrace' | ||
|
|
||
| RSpec.describe Datadog::Contrib::Redis::Patcher do | ||
| describe '.patch' do | ||
| it 'adds Instrumentation methods to ancestors of Redis class' do | ||
|
There was a problem hiding this comment. This spec pattern is from the ethon patch |
||
| described_class.patch | ||
|
|
||
| expect(Redis::Client.ancestors).to include(Datadog::Contrib::Redis::Instrumentation) | ||
| expect(Redis::Client.ancestors).to include(Datadog::Contrib::Redis::Instrumentation) | ||
| end | ||
| end | ||
| end | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The pattern for this module and the patcher module are copied from the http patcher.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be fine.