Module: OpenTrace

Defined in:
lib/opentrace.rb,
lib/opentrace/rails.rb,
lib/opentrace/client.rb,
lib/opentrace/config.rb,
lib/opentrace/logger.rb,
lib/opentrace/version.rb,
lib/opentrace/middleware.rb,
lib/opentrace/log_forwarder.rb

Defined Under Namespace

Classes: Client, Config, LogForwarder, Logger, Middleware, Railtie

Constant Summary collapse

LEVEL_VALUES = 
{ "DEBUG" => 0, "INFO" => 1, "WARN" => 2, "ERROR" => 3, "FATAL" => 4 }.freeze
VERSION = 
"0.3.0"

Class Method Summary collapse

Class Method Details

.config ⇒ Object 



20
21
22
 
# File 'lib/opentrace.rb', line 20

def config
  @config ||= Config.new
end

.configure {|config| ... } ⇒ Object

Yields:



15
16
17
18
 
# File 'lib/opentrace.rb', line 15

def configure
  yield config
  reset_client!
end

.current_request_id ⇒ Object 



92
93
94
 
# File 'lib/opentrace.rb', line 92

def current_request_id
  Fiber[:opentrace_request_id]
end

.current_request_id=(id) ⇒ Object 



96
97
98
 
# File 'lib/opentrace.rb', line 96

def current_request_id=(id)
  Fiber[:opentrace_request_id] = id
end

.disable! ⇒ Object 



84
85
86
 
# File 'lib/opentrace.rb', line 84

def disable!
  config.enabled = false
end

.enable! ⇒ Object 



88
89
90
 
# File 'lib/opentrace.rb', line 88

def enable!
  config.enabled = true
end

.enabled? ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/opentrace.rb', line 80

def enabled?
  config.enabled?
end

.error(exception, metadata = {}) ⇒ Object 



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

def error(exception, metadata = {})
  return unless enabled?

  meta = metadata.is_a?(Hash) ? metadata.dup : {}
  meta[:exception_class]   = exception.class.name
  meta[:exception_message] = exception.message&.slice(0, 500)

  if exception.backtrace
    cleaned = if defined?(::Rails) && ::Rails.respond_to?(:backtrace_cleaner)
                ::Rails.backtrace_cleaner.clean(exception.backtrace)
              else
                exception.backtrace.reject { |l| l.include?("/gems/") }
              end
    meta[:backtrace] = cleaned.first(15)
  end

  log("ERROR", exception.message.to_s, meta)
rescue StandardError
  # Never raise to the host app
end

.log(level, message, metadata = {}) ⇒ Object 



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
50
51
52
53
54
55
56
57
 
# File 'lib/opentrace.rb', line 24

def log(level, message, metadata = {})
  return unless enabled?
  return unless level_meets_threshold?(level)

  # 1. Start with user-defined context (lowest priority)
  meta = resolve_context

  # 2. Merge caller-provided metadata (overrides context)
  meta.merge!(metadata) if metadata.is_a?(Hash)

  # 3. Static context — only fills in keys not already set
  static_context.each { |k, v| meta[k] ||= v }

  # 4. Request ID from middleware (if not already set by caller or context)
  meta[:request_id] ||= current_request_id if current_request_id

  # Extract trace_id to top level before building payload
  trace_id = meta.delete(:trace_id)

  payload = {
    timestamp: Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S.%6NZ"),
    level: level.to_s.upcase,
    service: config.service,
    environment: config.environment,
    message: message.to_s,
    metadata: meta.compact
  }

  payload[:trace_id] = trace_id.to_s if trace_id

  client.enqueue(payload)
rescue StandardError
  # Never raise to the host app
end

.reset! ⇒ Object 



104
105
106
107
108
109
110
 
# File 'lib/opentrace.rb', line 104

def reset!
  shutdown(timeout: 1)
  @config = nil
  @client = nil
  @static_context = nil
  @at_exit_registered = nil
end

.shutdown(timeout: 5) ⇒ Object 



100
101
102
 
# File 'lib/opentrace.rb', line 100

def shutdown(timeout: 5)
  @client&.shutdown(timeout: timeout)
end