Module: Datadog::Tracing::Contrib::Patchable::InstanceMethods

Defined in:

lib/datadog/tracing/contrib/patchable.rb

Overview

Instance methods for integrations

Instance Method Summary

• #auto_instrument? ⇒ Boolean

  Can the patch for this integration be applied automatically? For example: test integrations should only be applied by the user explicitly setting ‘c.ci.instrument :rspec` and rails sub-modules are auto-instrumented by enabling rails so auto-instrumenting them on their own will cause changes in service naming behavior.

• #patcher ⇒ Contrib::Patcher

  The patcher module to inject instrumented objects into the instrumentation target.

Instance Method Details

#auto_instrument? ⇒ Boolean

Can the patch for this integration be applied automatically? For example: test integrations should only be applied by the user explicitly setting ‘c.ci.instrument :rspec` and rails sub-modules are auto-instrumented by enabling rails so auto-instrumenting them on their own will cause changes in service naming behavior

Returns:

• (Boolean) —

  can the tracer activate this instrumentation without explicit user input?

# File 'lib/datadog/tracing/contrib/patchable.rb', line 102

def auto_instrument?
  true
end

#patcher ⇒ Contrib::Patcher

The patcher module to inject instrumented objects into the instrumentation target.

Datadog::Tracing::Contrib::Patcher includes the basic functionality of a patcher. ‘include`ing Datadog::Tracing::Contrib::Patcher into a new module is the recommend way to create a custom patcher.

Returns:

• (Contrib::Patcher) —

  a module that ‘include`s Datadog::Tracing::Contrib::Patcher

# File 'lib/datadog/tracing/contrib/patchable.rb', line 75

def patcher
  nil
end