Module: Helios::OpenTelemetry::SDK

Defined in:
lib/helios/opentelemetry/sdk.rb,
lib/helios/opentelemetry/sdk/version.rb

Constant Summary collapse

DEFAULT_COLLECTOR_ENDPOINT = 
'https://collector.gethelios.dev/v1/traces'.freeze
NAME = 
'helios-opentelemetry-sdk'.freeze
VERSION = 
'0.2.1'

Class Method Summary collapse

Class Method Details

.get_span_exporter(helios_config) ⇒ Object 



62
63
64
65
66
67
68
69
 
# File 'lib/helios/opentelemetry/sdk.rb', line 62

def self.get_span_exporter(helios_config)
  return helios_config[:span_exporter] if helios_config[:span_exporter]

  ::OpenTelemetry::Exporter::OTLP::Exporter.new(
    endpoint: Helios::OpenTelemetry::SDK::DEFAULT_COLLECTOR_ENDPOINT,
    headers: { Authorization: helios_config[:api_token] }
  )
end

.helios_disabled?(enabled_flag) ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
74
75
76
77
78
 
# File 'lib/helios/opentelemetry/sdk.rb', line 71

def self.helios_disabled?(enabled_flag)
  return true unless enabled_flag

  disabled_env_var = ENV['HS_DISABLED']
  return false unless disabled_env_var

  disabled_env_var.lowercase == 'true'
end

.initialize(helios_config = {}) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/helios/opentelemetry/sdk.rb', line 14

def self.initialize(helios_config = {})
  if helios_disabled?(helios_config[:enable])
    puts 'Helios instrumentation is disabled'
    return
  end

  api_token = helios_config[:api_token]
  service_name = helios_config[:service_name]
  if service_name.nil? || api_token.nil?
    puts "service_name and token can't be empty"
    return
  end

  debug = helios_config[:debug]
  ::OpenTelemetry.logger.level = ::Logger::Severity::DEBUG if debug
  environment = helios_config[:environment]
  ::OpenTelemetry::SDK.configure do |c|
    c.service_name = service_name
    resource_attrs = {
      ::OpenTelemetry::SemanticConventions::Resource::TELEMETRY_SDK_NAME => Helios::OpenTelemetry::SDK::NAME,
      ::OpenTelemetry::SemanticConventions::Resource::TELEMETRY_SDK_VERSION => Helios::OpenTelemetry::SDK::VERSION
    }
    unless environment.nil?
      resource_attrs[::OpenTelemetry::SemanticConventions::Resource::DEPLOYMENT_ENVIRONMENT] = environment
    end
    c.resource = ::OpenTelemetry::SDK::Resources::Resource.create(resource_attrs)
    apply_instrumentations(c)
    c.add_span_processor(HeliosProcessor.new(get_span_exporter(helios_config), helios_config[:metadata_only]))
    puts 'Helios tracing initialized (' \
      "service: #{service_name}, " \
      "token: #{api_token[0, 3]}*****, " \
      "environment: #{environment})"
  end

  send_debug_span
end

.send_debug_span ⇒ Object 



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/helios/opentelemetry/sdk.rb', line 51

def self.send_debug_span
  provider = ::OpenTelemetry.tracer_provider
  tracer = provider.tracer
  debug_span = tracer.start_span('debug span')
  debug_span.set_attribute('hs-debug-span', 'true')
  debug_span.finish
  provider.force_flush
rescue StandardError => e
  puts "Failed sending debug span: #{e.message}"
end