Module: Foam::Ruby

Defined in:
lib/foam/ruby.rb,
lib/foam/ruby/version.rb,
lib/foam/ruby/middleware.rb,
lib/foam/ruby/otel_setup.rb,
lib/foam/ruby/configuration.rb,
lib/foam/ruby/log_subscriber.rb

Defined Under Namespace

Modules: OtelSetup Classes: Configuration, Middleware, NullLogDevice, OtelLogDevice, OtelLogger

Constant Summary collapse

VERSION = 
"0.1.0.alpha11"

Class Method Summary collapse

Class Method Details

.capture_exception(error, attributes: {}) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/foam/ruby.rb', line 59

def capture_exception(error, attributes: {})
  return unless initialized?

  span = OpenTelemetry::Trace.current_span
  return unless span && span.context.valid?

  raw_parent = span.instance_variable_get(:@parent_span_id)
  parent_id = raw_parent&.unpack1("H*")
  parent_id = nil if parent_id.nil? || parent_id == ("0" * 16)

  attrs = attributes.merge(
    "trace_id" => span.context.hex_trace_id,
    "span_id" => span.context.hex_span_id
  )
  attrs["parent_span_id"] = parent_id if parent_id

  span.record_exception(error, attributes: attrs)
  span.status = OpenTelemetry::Trace::Status.error(error.message)
rescue Exception # rubocop:disable Lint/RescueException
  nil
end

.ensure_worker_setup! ⇒ Object

Ensures Foam’s processors and logger broadcast are attached in the current process. Called by Middleware on the first request per worker PID — a single integer comparison on every subsequent request. Public so non-Rails apps can call it from custom fork hooks.



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/foam/ruby.rb', line 45

def ensure_worker_setup!
  return unless initialized?

  pid = Process.pid
  return if @worker_pid == pid
  @worker_pid = pid

  OtelSetup.ensure_processor_attached!
  OtelSetup.ensure_log_processor_attached!
  attach_otel_logger!
rescue Exception # rubocop:disable Lint/RescueException
  nil
end

.init(token: nil, service_name: nil) ⇒ Object 



13
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
 
# File 'lib/foam/ruby.rb', line 13

def init(token: nil, service_name: nil)
  return if initialized?
  return unless production?

  config = configuration
  config.token = token if token
  config.service_name = service_name if service_name

  unless config.valid?
    warn "[foam-ruby] Missing required config — set OTEL_FOAM_COLLECTOR_BEARER_TOKEN and OTEL_SERVICE_NAME, " \
         "or pass token: and service_name: to Foam::Ruby.init"
    return
  end

  require_relative "ruby/otel_setup"
  require_relative "ruby/log_subscriber"
  require_relative "ruby/middleware"

  OtelSetup.configure!(config)
  insert_middleware!
  schedule_logger_attach!
  bridge_sentry!
  @initialized = true
rescue Exception => e # rubocop:disable Lint/RescueException
  warn "[foam-ruby] init failed: #{e.message}"
  @initialized = false
end

.initialized? ⇒ Boolean

Returns:

  • (Boolean) 


9
10
11
 
# File 'lib/foam/ruby.rb', line 9

def initialized?
  @initialized == true
end