Class: Vivarium::Correlator

Inherits:
Object
  • Object
show all
Defined in:
lib/vivarium/correlator.rb

Overview

Client-side consumer of the vivariumd event stream. Connects to the daemon’s Unix domain socket, reads chunked raw event_t records, accumulates them, and renders a tree on stop. It never touches BPF maps or the ring buffer directly.

Constant Summary collapse

DRAIN_SLEEP =

Grace period after stop to let trailing events drain through the stream.

0.3
SAVE_RAW_PROGRESS_INTERVAL =

In save_raw mode, emit a progress line every this many captured events.

1000

Instance Method Summary collapse

Constructor Details

#initialize(socket_path: Vivarium.socket_path, observer_pid:, main_tid:, filter: nil, dest: $stdout, save_raw: nil, otel_out: nil, otel_endpoint: nil) ⇒ Correlator

Returns a new instance of Correlator.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/vivarium/correlator.rb', line 16

def initialize(socket_path: Vivarium.socket_path, observer_pid:, main_tid:,
               filter: nil, dest: $stdout, save_raw: nil, otel_out: nil, otel_endpoint: nil)
  @socket_path = socket_path
  @observer_pid = observer_pid
  @main_tid = main_tid
  @filter = filter
  @dest = dest
  @save_raw = save_raw
  @otel_out = otel_out
  @otel_endpoint = otel_endpoint

  @client = DaemonClient.new(socket_path: socket_path)
  @events = []
  @events_mutex = Mutex.new
  @stop_flag = false
  @started = false
  @stopped = false
end

Instance Method Details

#start ⇒ Object 



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/vivarium/correlator.rb', line 35

def start
  return if @started

  @session_start_iso = Time.now.utc.iso8601(3)
  @session_start_ktime = Vivarium.monotonic_ktime_ns
  start_stream_exporter if @otel_endpoint
  @sock = @client.open_event_stream
  @thread = Thread.new { run }
  @started = true
end

#stop ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/vivarium/correlator.rb', line 46

def stop
  return unless @started
  return if @stopped

  sleep DRAIN_SLEEP
  @stop_flag = true
  @sock&.close
  @thread&.join(2)
  @session_stop_iso = Time.now.utc.iso8601(3)
  @session_stop_ktime = Vivarium.monotonic_ktime_ns

  if @stream
    @stream.finalize(stop_ktime: @session_stop_ktime)
    @stream_exporter.shutdown
    warn "[vivarium] otel: streamed spans -> #{@otel_endpoint}"
    @stopped = true
    return
  end

  events_snapshot = @events_mutex.synchronize { @events.dup }
  @stopped = true

  meta = {
    observer_pid: @observer_pid,
    main_tid: @main_tid,
    session_start_iso: @session_start_iso,
    session_start_ktime: @session_start_ktime,
    session_stop_iso: @session_stop_iso,
    session_stop_ktime: @session_stop_ktime
  }

  if @save_raw
    File.open(@save_raw, "wb") do |io|
      Vivarium::RawStore.dump(io, events: events_snapshot, meta: meta)
    end
    warn "[vivarium] save_raw: saved #{events_snapshot.size} events -> #{@save_raw}"
    return
  end

  if @otel_out
    File.open(@otel_out, "w") do |io|
      Vivarium::OtelExporter.dump(io, events: events_snapshot, meta: meta)
    end
    warn "[vivarium] otel_out: wrote OTLP spans -> #{@otel_out}"
    return
  end

  TreeRenderer.new(events: events_snapshot, **meta, filter: @filter, dest: @dest).render
end