Class: LogStash::Util::WrappedSynchronousQueue::ReadClient

Inherits:
Object
  • Object
show all
Defined in:
lib/logstash/util/wrapped_synchronous_queue.rb

Instance Method Summary collapse

Constructor Details

#initialize(queue, batch_size = 125, wait_for = 250) ⇒ ReadClient

We generally only want one thread at a time able to access pop/take/poll operations from this queue. We also depend on this to be able to block consumers while we snapshot in-flight buffers



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 58

def initialize(queue, batch_size = 125, wait_for = 250)
  @queue = queue
  @mutex = Mutex.new
  # Note that @inflight_batches as a central mechanism for tracking inflight
  # batches will fail if we have multiple read clients in the pipeline.
  @inflight_batches = {}

  # allow the worker thread to report the execution time of the filter + output
  @inflight_clocks = {}
  @batch_size = batch_size
  @wait_for = wait_for
end

Instance Method Details

#add_filtered_metrics(batch) ⇒ Object 



176
177
178
179
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 176

def add_filtered_metrics(batch)
  @event_metric.increment(:filtered, batch.filtered_size)
  @pipeline_metric.increment(:filtered, batch.filtered_size)
end

#add_output_metrics(batch) ⇒ Object 



181
182
183
184
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 181

def add_output_metrics(batch)
  @event_metric.increment(:out, batch.filtered_size)
  @pipeline_metric.increment(:out, batch.filtered_size)
end

#close ⇒ Object 



71
72
73
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 71

def close
  # noop, compat with acked queue read client
end

#close_batch(batch) ⇒ Object 



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 146

def close_batch(batch)
  @mutex.lock
  begin
    # there seems to be concurrency issues with metrics, keep it in the mutex
    @inflight_batches.delete(Thread.current)
    stop_clock(batch)
  ensure
    @mutex.unlock
  end
end

#current_inflight_batch ⇒ Object 



109
110
111
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 109

def current_inflight_batch
  @inflight_batches.fetch(Thread.current, [])
end

#define_initial_metrics_values(namespaced_metric) ⇒ Object 



94
95
96
97
98
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 94

def define_initial_metrics_values(namespaced_metric)
  namespaced_metric.report_time(:duration_in_millis, 0)
  namespaced_metric.increment(:filtered, 0)
  namespaced_metric.increment(:out, 0)
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 75

def empty?
  true # synchronous queue is alway empty
end

#inflight_batches ⇒ Object 



100
101
102
103
104
105
106
107
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 100

def inflight_batches
  @mutex.lock
  begin
    yield(@inflight_batches)
  ensure
    @mutex.unlock
  end
end

#new_batch ⇒ ReadBatch

create a new empty batch

Returns:



115
116
117
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 115

def new_batch
  ReadBatch.new(@queue, @batch_size, @wait_for)
end

#read_batch ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 119

def read_batch
  batch = new_batch
  @mutex.lock
  begin
    batch.read_next
  ensure
    @mutex.unlock
  end
  start_metrics(batch)
  batch
end

#set_batch_dimensions(batch_size, wait_for) ⇒ Object 



79
80
81
82
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 79

def set_batch_dimensions(batch_size, wait_for)
  @batch_size = batch_size
  @wait_for = wait_for
end

#set_current_thread_inflight_batch(batch) ⇒ Object 



142
143
144
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 142

def set_current_thread_inflight_batch(batch)
  @inflight_batches[Thread.current] = batch
end

#set_events_metric(metric) ⇒ Object 



84
85
86
87
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 84

def set_events_metric(metric)
  @event_metric = metric
  define_initial_metrics_values(@event_metric)
end

#set_pipeline_metric(metric) ⇒ Object 



89
90
91
92
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 89

def set_pipeline_metric(metric)
  @pipeline_metric = metric
  define_initial_metrics_values(@pipeline_metric)
end

#start_clock ⇒ Object 



157
158
159
160
161
162
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 157

def start_clock
  @inflight_clocks[Thread.current] = [
    @event_metric.time(:duration_in_millis),
    @pipeline_metric.time(:duration_in_millis)
  ]
end

#start_metrics(batch) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 131

def start_metrics(batch)
  @mutex.lock
  # there seems to be concurrency issues with metrics, keep it in the mutex
  begin
    set_current_thread_inflight_batch(batch)
    start_clock
  ensure
    @mutex.unlock
  end
end

#stop_clock(batch) ⇒ Object 



164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/logstash/util/wrapped_synchronous_queue.rb', line 164

def stop_clock(batch)
  unless @inflight_clocks[Thread.current].nil?
    if batch.size > 0
      # only stop (which also records) the metrics if the batch is non-empty.
      # start_clock is now called at empty batch creation and an empty batch could
      # stay empty all the way down to the close_batch call.
      @inflight_clocks[Thread.current].each(&:stop)
    end
    @inflight_clocks.delete(Thread.current)
  end
end