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.



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

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

Instance Attribute Details

#error_handler ⇒ Object 



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

def error_handler
  @error_handler ||= OpenTelemetry.error_handler
end

#http_extractors=(value) ⇒ Object (writeonly)

Sets the attribute http_extractors

Parameters:

  • value —

    the value to set the attribute http_extractors to.



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

def http_extractors=(value)
  @http_extractors = value
end

#http_injectors=(value) ⇒ Object (writeonly)

Sets the attribute http_injectors

Parameters:

  • value —

    the value to set the attribute http_injectors to.



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

def http_injectors=(value)
  @http_injectors = value
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

#logger ⇒ Object 



34
35
36
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 34

def logger
  @logger ||= OpenTelemetry.logger
end

#text_map_extractors=(value) ⇒ Object (writeonly)

Sets the attribute text_map_extractors

Parameters:

  • value —

    the value to set the attribute text_map_extractors to.



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

def text_map_extractors=(value)
  @text_map_extractors = value
end

#text_map_injectors=(value) ⇒ Object (writeonly)

Sets the attribute text_map_injectors

Parameters:

  • value —

    the value to set the attribute text_map_injectors to.



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

def text_map_injectors=(value)
  @text_map_injectors = 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.



104
105
106
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 104

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



116
117
118
119
120
121
122
123
124
125
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 116

def configure
  OpenTelemetry.logger = logger
  OpenTelemetry.error_handler = error_handler
  OpenTelemetry.baggage = Baggage::Manager.new
  configure_propagation
  configure_span_processors
  tracer_provider.id_generator = @id_generator
  OpenTelemetry.tracer_provider = tracer_provider
  install_instrumentation
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



48
49
50
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 48

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



56
57
58
59
60
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 56

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



66
67
68
69
70
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 66

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



80
81
82
83
84
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 80

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



94
95
96
97
 
# File 'lib/opentelemetry/sdk/configurator.rb', line 94

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