Sha256: 06a1d558eee5909d2030938c46d8b9cc20e33b6dd8cbf21c92f3c30eaa06c727
Contents?: true
Size: 1.64 KB
Versions: 35
Compression:
Stored size: 1.64 KB
Contents
# frozen_string_literal: true
module Datadog
module Tracing
module Contrib
# Defines registerable behavior for integrations
module Registerable
def self.included(base)
base.extend(ClassMethods)
base.include(InstanceMethods)
end
# Class methods for registerable behavior
# @public_api
module ClassMethods
# Registers this integration in the global tracer registry.
# Once registered, this integration can be activated with:
#
# ```
# Datadog.configure do |c|
# c.tracing.instrument :name
# end
# ```
#
# @param [Symbol] name integration name. Used during activation.
# @param [Datadog::Tracing::Contrib::Registry] registry a custom registry.
# Defaults to the global tracing registry.
# @param [Boolean] auto_patch will this integration be activated during
# {file:docs/AutoInstrumentation.md Auto Instrumentation}?
# @param [Hash] options additional keyword options passed to the initializer of
# a custom {Registerable} instrumentation
# @see Datadog::Tracing::Contrib::Integration
def register_as(name, registry: Contrib::REGISTRY, auto_patch: false, **options)
registry.add(name, new(name, **options), auto_patch)
end
end
# Instance methods for registerable behavior
module InstanceMethods
attr_reader \
:name
def initialize(name, **options)
@name = name
end
end
end
end
end
end
Version data entries
35 entries across 35 versions & 2 rubygems