Class: OpenTelemetry::SDK::Configurator

Inherits:
Object
  • Object
show all
Defined in:
lib/opentelemetry/sdk/configurator.rb

Overview

The configurator provides defaults and facilitates configuring the SDK for use.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configurator

Returns a new instance of Configurator.



20
21
22
23
24
25
26
27
28
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 20

def initialize
  @instrumentation_names = []
  @instrumentation_config_map = {}
  @propagators = nil
  @span_processors = []
  @use_mode = USE_MODE_UNSPECIFIED
  @resource = Resources::Resource.default
  @id_generator = OpenTelemetry::Trace
end

Instance Attribute Details

#error_handler ⇒ Object 



43
44
45
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 43

def error_handler
  @error_handler ||= OpenTelemetry.error_handler
end

#id_generator=(value) ⇒ Object (writeonly)

Sets the attribute id_generator

Parameters:

  • value —

    the value to set the attribute id_generator to.



18
19
20
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 18

def id_generator=(value)
  @id_generator = value
end

#propagators=(value) ⇒ Object (writeonly)

Sets the attribute propagators

Parameters:

  • value —

    the value to set the attribute propagators to.



18
19
20
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 18

def propagators=(value)
  @propagators = value
end

Instance Method Details

#add_span_processor(span_processor) ⇒ Object

Add a span processor to the export pipeline

Parameters:

  • span_processor (#on_start, #on_finish, #shutdown, #force_flush) —

    A span_processor that satisfies the duck type #on_start, #on_finish, #shutdown, #force_flush. See SimpleSpanProcessor for an example.



109
110
111
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 109

def add_span_processor(span_processor)
  @span_processors << span_processor
end

#configure ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The configure method is where we define the setup process. This allows us to make certain guarantees about which systems and globals are setup at each stage. The setup process is: - setup logging - setup propagation - setup tracer_provider and meter_provider - install instrumentation



121
122
123
124
125
126
127
128
129
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 121

def configure
  OpenTelemetry.logger = logger
  OpenTelemetry.error_handler = error_handler
  configure_propagation
  configure_span_processors
  tracer_provider.id_generator = @id_generator
  OpenTelemetry.tracer_provider = tracer_provider
  install_instrumentation
end

#logger ⇒ Object 



30
31
32
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 30

def logger
  @logger ||= OpenTelemetry.logger
end

#logger=(new_logger) ⇒ Object

Accepts a logger and wraps it in the ForwardingLogger which allows for controlling the severity level emitted by the OpenTelemetry.logger independently of the supplied logger.

Parameters:

  • new_logger (Logger) —

    The logger for OpenTelemetry to use



39
40
41
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 39

def logger=(new_logger)
  @logger = ForwardingLogger.new(new_logger, level: ENV['OTEL_LOG_LEVEL'] || Logger::INFO)
end

#resource=(new_resource) ⇒ Object

Accepts a resource object that is merged with the default telemetry sdk resource. The use of this method is optional, and is provided as means to include additional resource information. If a resource key collision occurs the passed in resource takes priority.

Parameters:

  • new_resource (Resource) —

    The resource to be merged



53
54
55
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 53

def resource=(new_resource)
  @resource = @resource.merge(new_resource)
end

#service_name=(service_name) ⇒ Object

Accepts a string that is merged in as the service.name resource attribute. The most recent assigned value will be used in the event of repeated calls to this setter.

Parameters:

  • service_name (String) —

    The value to be used as the service name



61
62
63
64
65
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 61

def service_name=(service_name)
  self.resource = OpenTelemetry::SDK::Resources::Resource.create(
    OpenTelemetry::SDK::Resources::Constants::SERVICE_RESOURCE[:name] => service_name
  )
end

#service_version=(service_version) ⇒ Object

Accepts a string that is merged in as the service.version resource attribute. The most recent assigned value will be used in the event of repeated calls to this setter.

Parameters:

  • service_version (String) —

    The value to be used as the service version



71
72
73
74
75
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 71

def service_version=(service_version)
  self.resource = OpenTelemetry::SDK::Resources::Resource.create(
    OpenTelemetry::SDK::Resources::Constants::SERVICE_RESOURCE[:version] => service_version
  )
end

#use(instrumentation_name, config = nil) ⇒ Object

Install an instrumentation with specificied optional config. Use can be called multiple times to install multiple instrumentation. Only use or use_all, but not both when installing instrumentation. A call to use_all after use will result in an exception.

Parameters:

  • instrumentation_name (String) —

    The name of the instrumentation

  • config (optional Hash) (defaults to: nil) —

    The config for this instrumentation



85
86
87
88
89
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 85

def use(instrumentation_name, config = nil)
  check_use_mode!(USE_MODE_ONE)
  @instrumentation_names << instrumentation_name
  @instrumentation_config_map[instrumentation_name] = config if config
end

#use_all(instrumentation_config_map = {}) ⇒ Object

Install all registered instrumentation. Configuration for specific instrumentation can be provided with the optional instrumentation_config_map parameter. Only use or use_all, but not both when installing instrumentation. A call to use after use_all will result in an exception.

Parameters:

  • instrumentation_config_map (optional Hash<String,Hash>) (defaults to: {}) —

    A map with string keys representing the instrumentation name and values specifying the instrumentation config



99
100
101
102
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 99

def use_all(instrumentation_config_map = {})
  check_use_mode!(USE_MODE_ALL)
  @instrumentation_config_map = instrumentation_config_map
end