Class: LogStash::Util::WrappedAckedQueue::ReadClient

Inherits:
Object
  • Object
show all
Defined in:
lib/logstash/util/wrapped_acked_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



113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 113

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 



246
247
248
249
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 246

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 



251
252
253
254
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 251

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

#add_starting_metrics(batch) ⇒ Object 



240
241
242
243
244
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 240

def add_starting_metrics(batch)
  return if @event_metric.nil? || @pipeline_metric.nil?
  @event_metric.increment(:in, batch.starting_size)
  @pipeline_metric.increment(:in, batch.starting_size)
end

#close ⇒ Object 



125
126
127
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 125

def close
  @queue.close
end

#close_batch(batch) ⇒ Object 



209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 209

def close_batch(batch)
  @mutex.lock
  begin
    batch.close
    # 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 



168
169
170
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 168

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

#define_initial_metrics_values(namespaced_metric) ⇒ Object 



153
154
155
156
157
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 153

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) 


129
130
131
132
133
134
135
136
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 129

def empty?
  @mutex.lock
  begin
    @queue.is_fully_acked?
  ensure
    @mutex.unlock
  end
end

#inflight_batches ⇒ Object 



159
160
161
162
163
164
165
166
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 159

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

#new_batch ⇒ ReadBatch

create a new empty batch

Returns:



174
175
176
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 174

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

#read_batch ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 178

def read_batch
  if @queue.closed?
    raise QueueClosedError.new("Attempt to take a batch from a closed AckedQueue")
  end

  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 



138
139
140
141
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 138

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

#set_current_thread_inflight_batch(batch) ⇒ Object 



205
206
207
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 205

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

#set_events_metric(metric) ⇒ Object 



143
144
145
146
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 143

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

#set_pipeline_metric(metric) ⇒ Object 



148
149
150
151
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 148

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

#start_clock ⇒ Object 



221
222
223
224
225
226
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 221

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

#start_metrics(batch) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 194

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

#stop_clock(batch) ⇒ Object 



228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/logstash/util/wrapped_acked_queue.rb', line 228

def stop_clock(batch)
  unless @inflight_clocks[Thread.current].nil?
    if batch.size > 0
      # onl/y 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