Class: LogStash::Pipeline
- Inherits:
-
BasePipeline
- Object
- BasePipeline
- LogStash::Pipeline
- Defined in:
- lib/logstash/pipeline.rb
Constant Summary collapse
- MAX_INFLIGHT_WARN_THRESHOLD =
10_000
Instance Attribute Summary collapse
-
#events_consumed ⇒ Object
readonly
Returns the value of attribute events_consumed.
-
#events_filtered ⇒ Object
readonly
Returns the value of attribute events_filtered.
-
#filter_queue_client ⇒ Object
readonly
Returns the value of attribute filter_queue_client.
-
#input_queue_client ⇒ Object
readonly
Returns the value of attribute input_queue_client.
-
#metric ⇒ Object
readonly
Returns the value of attribute metric.
-
#queue ⇒ Object
readonly
Returns the value of attribute queue.
-
#reporter ⇒ Object
readonly
Returns the value of attribute reporter.
-
#settings ⇒ Object
readonly
Returns the value of attribute settings.
-
#started_at ⇒ Object
readonly
Returns the value of attribute started_at.
-
#thread ⇒ Object
readonly
Returns the value of attribute thread.
-
#worker_threads ⇒ Object
readonly
Returns the value of attribute worker_threads.
Attributes inherited from BasePipeline
#config_hash, #config_str, #ephemeral_id, #execution_context, #filters, #inputs, #lir, #outputs, #pipeline_config, #pipeline_id
Instance Method Summary collapse
- #clear_pipeline_metrics ⇒ Object
-
#close ⇒ Object
def run.
- #collect_dlq_stats ⇒ Object
- #collect_stats ⇒ Object
- #dlq_enabled? ⇒ Boolean
-
#filter(event, &block) ⇒ Object
for backward compatibility in devutils for the rspec helpers, this method is not used in the pipeline anymore.
- #filter_batch(batch) ⇒ Object
- #filters? ⇒ Boolean
- #flush ⇒ Object
-
#flush_filters(options = {}, &block) ⇒ Object
perform filters flush and yield flushed event to the passed block.
-
#flush_filters_to_batch(batch, options = {}) ⇒ Object
perform filters flush into the output queue.
-
#initialize(pipeline_config, namespaced_metric = nil, agent = nil) ⇒ Pipeline
constructor
A new instance of Pipeline.
- #inputworker(plugin) ⇒ Object
-
#inspect ⇒ Object
Sometimes we log stuff that will dump the pipeline which may contain sensitive information (like the raw syntax tree which can contain passwords) We want to hide most of what’s in here.
-
#output_batch(batch, output_events_map) ⇒ Object
Take an array of events and send them to the correct output.
-
#plugin_threads_info ⇒ Object
flush_filters_to_batch.
-
#ready? ⇒ Boolean
def initialize.
-
#register_plugin(plugin) ⇒ Plugin
register_plugin simply calls the plugin #register method and catches & logs any error.
-
#register_plugins(plugins) ⇒ Object
register_plugins calls #register_plugin on the plugins list and upon exception will call Plugin#do_close on all registered plugins.
- #run ⇒ Object
- #running? ⇒ Boolean
- #safe_pipeline_worker_count ⇒ Object
-
#shutdown(&before_stop) ⇒ Object
initiate the pipeline shutdown sequence this method is intended to be called from outside the pipeline thread.
- #shutdown_flusher ⇒ Object
-
#shutdown_workers ⇒ Object
After ‘shutdown` is called from an external thread this is called from the main thread to tell the worker threads to stop and then block until they’ve fully stopped This also stops all filter and output plugins.
- #stalling_threads_info ⇒ Object
- #start ⇒ Object
- #start_flusher ⇒ Object
- #start_input(plugin) ⇒ Object
- #start_inputs ⇒ Object
- #start_workers ⇒ Object
- #stop_inputs ⇒ Object
- #stopped? ⇒ Boolean
- #system? ⇒ Boolean
- #transition_to_running ⇒ Object
- #transition_to_stopped ⇒ Object
-
#uptime ⇒ Fixnum
Calculate the uptime in milliseconds.
-
#wait_for_workers ⇒ Object
def shutdown.
- #wait_inputs ⇒ Object
- #wait_until_started ⇒ Object
-
#worker_loop(batch_size, batch_delay) ⇒ Object
Main body of what a worker thread does Repeatedly takes batches off the queue, filters, then outputs them.
Methods inherited from BasePipeline
#close_dlq_writer, #compile_lir, #configured_as_reloadable?, #dlq_writer, #non_reloadable_plugins, #plugin, #reloadable?, #reloadable_plugins?
Methods included from Util::Loggable
included, #logger, #slow_logger
Constructor Details
#initialize(pipeline_config, namespaced_metric = nil, agent = nil) ⇒ Pipeline
Returns a new instance of Pipeline.
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/logstash/pipeline.rb', line 156 def initialize(pipeline_config, namespaced_metric = nil, agent = nil) @settings = pipeline_config.settings # This needs to be configured before we call super which will evaluate the code to make # sure the metric instance is correctly send to the plugins to make the namespace scoping work @metric = if namespaced_metric settings.get("metric.collect") ? namespaced_metric : Instrument::NullMetric.new(namespaced_metric.collector) else Instrument::NullMetric.new end @ephemeral_id = SecureRandom.uuid @settings = settings @reporter = PipelineReporter.new(@logger, self) @worker_threads = [] super begin @queue = LogStash::QueueFactory.create(settings) rescue => e @logger.error("Logstash failed to create queue", default_logging_keys("exception" => e., "backtrace" => e.backtrace)) raise e end @input_queue_client = @queue.write_client @filter_queue_client = @queue.read_client @signal_queue = java.util.concurrent.LinkedBlockingQueue.new # Note that @inflight_batches as a central mechanism for tracking inflight # batches will fail if we have multiple read clients here. @filter_queue_client.set_events_metric(metric.namespace([:stats, :events])) @filter_queue_client.set_pipeline_metric( metric.namespace([:stats, :pipelines, pipeline_id.to_s.to_sym, :events]) ) @drain_queue = @settings.get_value("queue.drain") @events_filtered = Concurrent::AtomicFixnum.new(0) @events_consumed = Concurrent::AtomicFixnum.new(0) @input_threads = [] # @ready requires thread safety since it is typically polled from outside the pipeline thread @ready = Concurrent::AtomicBoolean.new(false) @running = Concurrent::AtomicBoolean.new(false) @flushing = Concurrent::AtomicReference.new(false) @outputs_registered = Concurrent::AtomicBoolean.new(false) end |
Instance Attribute Details
#events_consumed ⇒ Object (readonly)
Returns the value of attribute events_consumed.
141 142 143 |
# File 'lib/logstash/pipeline.rb', line 141 def events_consumed @events_consumed end |
#events_filtered ⇒ Object (readonly)
Returns the value of attribute events_filtered.
141 142 143 |
# File 'lib/logstash/pipeline.rb', line 141 def events_filtered @events_filtered end |
#filter_queue_client ⇒ Object (readonly)
Returns the value of attribute filter_queue_client.
141 142 143 |
# File 'lib/logstash/pipeline.rb', line 141 def filter_queue_client @filter_queue_client end |
#input_queue_client ⇒ Object (readonly)
Returns the value of attribute input_queue_client.
141 142 143 |
# File 'lib/logstash/pipeline.rb', line 141 def input_queue_client @input_queue_client end |
#metric ⇒ Object (readonly)
Returns the value of attribute metric.
141 142 143 |
# File 'lib/logstash/pipeline.rb', line 141 def metric @metric end |
#queue ⇒ Object (readonly)
Returns the value of attribute queue.
141 142 143 |
# File 'lib/logstash/pipeline.rb', line 141 def queue @queue end |
#reporter ⇒ Object (readonly)
Returns the value of attribute reporter.
141 142 143 |
# File 'lib/logstash/pipeline.rb', line 141 def reporter @reporter end |
#settings ⇒ Object (readonly)
Returns the value of attribute settings.
141 142 143 |
# File 'lib/logstash/pipeline.rb', line 141 def settings @settings end |
#started_at ⇒ Object (readonly)
Returns the value of attribute started_at.
141 142 143 |
# File 'lib/logstash/pipeline.rb', line 141 def started_at @started_at end |
#thread ⇒ Object (readonly)
Returns the value of attribute thread.
141 142 143 |
# File 'lib/logstash/pipeline.rb', line 141 def thread @thread end |
#worker_threads ⇒ Object (readonly)
Returns the value of attribute worker_threads.
141 142 143 |
# File 'lib/logstash/pipeline.rb', line 141 def worker_threads @worker_threads end |
Instance Method Details
#clear_pipeline_metrics ⇒ Object
712 713 714 715 716 717 718 719 720 721 722 723 724 |
# File 'lib/logstash/pipeline.rb', line 712 def clear_pipeline_metrics # TODO(ph): I think the metric should also proxy that call correctly to the collector # this will simplify everything since the null metric would simply just do a noop collector = @metric.collector unless collector.nil? # selectively reset metrics we don't wish to keep after reloading # these include metrics about the plugins and number of processed events # we want to keep other metrics like reload counts and error messages collector.clear("stats/pipelines/#{pipeline_id}/plugins") collector.clear("stats/pipelines/#{pipeline_id}/events") end end |
#close ⇒ Object
def run
313 314 315 316 317 |
# File 'lib/logstash/pipeline.rb', line 313 def close @filter_queue_client.close @queue.close close_dlq_writer end |
#collect_dlq_stats ⇒ Object
681 682 683 684 685 686 |
# File 'lib/logstash/pipeline.rb', line 681 def collect_dlq_stats if dlq_enabled? dlq_metric = @metric.namespace([:stats, :pipelines, pipeline_id.to_s.to_sym, :dlq]) dlq_metric.gauge(:queue_size_in_bytes, @dlq_writer.get_current_queue_size) end end |
#collect_stats ⇒ Object
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 |
# File 'lib/logstash/pipeline.rb', line 688 def collect_stats pipeline_metric = @metric.namespace([:stats, :pipelines, pipeline_id.to_s.to_sym, :queue]) pipeline_metric.gauge(:type, settings.get("queue.type")) if @queue.is_a?(LogStash::Util::WrappedAckedQueue) && @queue.queue.is_a?(LogStash::AckedQueue) queue = @queue.queue dir_path = queue.dir_path file_store = Files.get_file_store(Paths.get(dir_path)) pipeline_metric.namespace([:capacity]).tap do |n| n.gauge(:page_capacity_in_bytes, queue.page_capacity) n.gauge(:max_queue_size_in_bytes, queue.max_size_in_bytes) n.gauge(:max_unread_events, queue.max_unread_events) n.gauge(:queue_size_in_bytes, queue.persisted_size_in_bytes) end pipeline_metric.namespace([:data]).tap do |n| n.gauge(:free_space_in_bytes, file_store.get_unallocated_space) n.gauge(:storage_type, file_store.type) n.gauge(:path, dir_path) end pipeline_metric.gauge(:events, queue.unread_count) end end |
#dlq_enabled? ⇒ Boolean
415 416 417 |
# File 'lib/logstash/pipeline.rb', line 415 def dlq_enabled? @settings.get("dead_letter_queue.enable") end |
#filter(event, &block) ⇒ Object
for backward compatibility in devutils for the rspec helpers, this method is not used in the pipeline anymore.
604 605 606 607 608 |
# File 'lib/logstash/pipeline.rb', line 604 def filter(event, &block) maybe_setup_out_plugins # filter_func returns all filtered events, including cancelled ones filter_func([event]).each {|e| block.call(e)} end |
#filter_batch(batch) ⇒ Object
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 |
# File 'lib/logstash/pipeline.rb', line 454 def filter_batch(batch) filter_func(batch.to_a).each do |e| #these are both original and generated events batch.merge(e) unless e.cancelled? end @filter_queue_client.add_filtered_metrics(batch.filtered_size) @events_filtered.increment(batch.size) rescue Exception => e # Plugins authors should manage their own exceptions in the plugin code # but if an exception is raised up to the worker thread they are considered # fatal and logstash will not recover from this situation. # # Users need to check their configuration or see if there is a bug in the # plugin. @logger.error("Exception in pipelineworker, the pipeline stopped processing new events, please check your filter configuration and restart Logstash.", default_logging_keys("exception" => e., "backtrace" => e.backtrace)) raise e end |
#filters? ⇒ Boolean
231 232 233 |
# File 'lib/logstash/pipeline.rb', line 231 def filters? return @filters.any? end |
#flush ⇒ Object
637 638 639 640 641 642 |
# File 'lib/logstash/pipeline.rb', line 637 def flush if @flushing.compare_and_set(false, true) @logger.debug? && @logger.debug("Pushing flush onto pipeline", default_logging_keys) @signal_queue.put(FLUSH) end end |
#flush_filters(options = {}, &block) ⇒ Object
perform filters flush and yield flushed event to the passed block
613 614 615 616 617 618 619 |
# File 'lib/logstash/pipeline.rb', line 613 def flush_filters( = {}, &block) flushers = [:final] ? @shutdown_flushers : @periodic_flushers flushers.each do |flusher| flusher.call(, &block) end end |
#flush_filters_to_batch(batch, options = {}) ⇒ Object
perform filters flush into the output queue
656 657 658 659 660 661 662 663 664 665 |
# File 'lib/logstash/pipeline.rb', line 656 def flush_filters_to_batch(batch, = {}) flush_filters() do |event| unless event.cancelled? @logger.debug? and @logger.debug("Pushing flushed events", default_logging_keys(:event => event)) batch.merge(event) end end @flushing.set(false) end |
#inputworker(plugin) ⇒ Object
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 |
# File 'lib/logstash/pipeline.rb', line 520 def inputworker(plugin) Util::set_thread_name("[#{pipeline_id}]<#{plugin.class.config_name}") begin input_queue_client = wrapped_write_client(plugin) plugin.run(input_queue_client) rescue => e if plugin.stop? @logger.debug("Input plugin raised exception during shutdown, ignoring it.", default_logging_keys(:plugin => plugin.class.config_name, :exception => e., :backtrace => e.backtrace)) return end # otherwise, report error and restart @logger.error(I18n.t("logstash.pipeline.worker-error-debug", default_logging_keys( :plugin => plugin.inspect, :error => e., :exception => e.class, :stacktrace => e.backtrace.join("\n")))) # Assuming the failure that caused this exception is transient, # let's sleep for a bit and execute #run again sleep(1) retry ensure plugin.do_close end end |
#inspect ⇒ Object
Sometimes we log stuff that will dump the pipeline which may contain sensitive information (like the raw syntax tree which can contain passwords) We want to hide most of what’s in here
729 730 731 732 733 734 735 736 737 |
# File 'lib/logstash/pipeline.rb', line 729 def inspect { :pipeline_id => @pipeline_id, :settings => @settings.inspect, :ready => @ready, :running => @running, :flushing => @flushing } end |
#output_batch(batch, output_events_map) ⇒ Object
Take an array of events and send them to the correct output
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 |
# File 'lib/logstash/pipeline.rb', line 475 def output_batch(batch, output_events_map) # Build a mapping of { output_plugin => [events...]} batch.each do |event| # We ask the AST to tell us which outputs to send each event to # Then, we stick it in the correct bin output_func(event).each do |output| output_events_map[output].push(event) end end # Now that we have our output to event mapping we can just invoke each output # once with its list of events output_events_map.each do |output, events| output.multi_receive(events) events.clear end @filter_queue_client.add_output_metrics(batch.filtered_size) end |
#plugin_threads_info ⇒ Object
flush_filters_to_batch
667 668 669 670 671 |
# File 'lib/logstash/pipeline.rb', line 667 def plugin_threads_info input_threads = @input_threads.select {|t| t.alive? } worker_threads = @worker_threads.select {|t| t.alive? } (input_threads + worker_threads).map {|t| Util.thread_info(t) } end |
#ready? ⇒ Boolean
def initialize
203 204 205 |
# File 'lib/logstash/pipeline.rb', line 203 def ready? @ready.value end |
#register_plugin(plugin) ⇒ Plugin
register_plugin simply calls the plugin #register method and catches & logs any error
342 343 344 345 346 347 348 |
# File 'lib/logstash/pipeline.rb', line 342 def register_plugin(plugin) plugin.register plugin rescue => e @logger.error("Error registering plugin", default_logging_keys(:plugin => plugin.inspect, :error => e.)) raise e end |
#register_plugins(plugins) ⇒ Object
register_plugins calls #register_plugin on the plugins list and upon exception will call Plugin#do_close on all registered plugins
352 353 354 355 356 357 358 |
# File 'lib/logstash/pipeline.rb', line 352 def register_plugins(plugins) registered = [] plugins.each { |plugin| registered << register_plugin(plugin) } rescue => e registered.each(&:do_close) raise e end |
#run ⇒ Object
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 |
# File 'lib/logstash/pipeline.rb', line 283 def run @started_at = Time.now @thread = Thread.current Util.set_thread_name("[#{pipeline_id}]-pipeline-manager") start_workers @logger.info("Pipeline started", "pipeline.id" => @pipeline_id) # Block until all inputs have stopped # Generally this happens if SIGINT is sent and `shutdown` is called from an external thread transition_to_running start_flusher # Launches a non-blocking thread for flush events wait_inputs transition_to_stopped @logger.debug("Input plugins stopped! Will shutdown filter/output workers.", default_logging_keys) shutdown_flusher shutdown_workers close @logger.debug("Pipeline has been shutdown", default_logging_keys) # exit code return 0 end |
#running? ⇒ Boolean
327 328 329 |
# File 'lib/logstash/pipeline.rb', line 327 def running? @running.true? end |
#safe_pipeline_worker_count ⇒ Object
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 |
# File 'lib/logstash/pipeline.rb', line 207 def safe_pipeline_worker_count default = @settings.get_default("pipeline.workers") pipeline_workers = @settings.get("pipeline.workers") #override from args "-w 8" or config safe_filters, unsafe_filters = @filters.partition(&:threadsafe?) plugins = unsafe_filters.collect { |f| f.config_name } return pipeline_workers if unsafe_filters.empty? if @settings.set?("pipeline.workers") if pipeline_workers > 1 @logger.warn("Warning: Manual override - there are filters that might not work with multiple worker threads", default_logging_keys(:worker_threads => pipeline_workers, :filters => plugins)) end else # user did not specify a worker thread count # warn if the default is multiple if default > 1 @logger.warn("Defaulting pipeline worker threads to 1 because there are some filters that might not work with multiple worker threads", default_logging_keys(:count_was => default, :filters => plugins)) return 1 # can't allow the default value to propagate if there are unsafe filters end end pipeline_workers end |
#shutdown(&before_stop) ⇒ Object
initiate the pipeline shutdown sequence this method is intended to be called from outside the pipeline thread
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 |
# File 'lib/logstash/pipeline.rb', line 552 def shutdown(&before_stop) # shutdown can only start once the pipeline has completed its startup. # avoid potential race condition between the startup sequence and this # shutdown method which can be called from another thread at any time sleep(0.1) while !ready? # TODO: should we also check against calling shutdown multiple times concurrently? before_stop.call if block_given? stop_inputs # We make this call blocking, so we know for sure when the method return the shtudown is # stopped wait_for_workers clear_pipeline_metrics @logger.info("Pipeline terminated", "pipeline.id" => @pipeline_id) end |
#shutdown_flusher ⇒ Object
633 634 635 |
# File 'lib/logstash/pipeline.rb', line 633 def shutdown_flusher @flusher_thread.join end |
#shutdown_workers ⇒ Object
After ‘shutdown` is called from an external thread this is called from the main thread to tell the worker threads to stop and then block until they’ve fully stopped This also stops all filter and output plugins
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 |
# File 'lib/logstash/pipeline.rb', line 586 def shutdown_workers # Each worker thread will receive this exactly once! @worker_threads.each do |t| @logger.debug("Pushing shutdown", default_logging_keys(:thread => t.inspect)) @signal_queue.put(SHUTDOWN) end @worker_threads.each do |t| @logger.debug("Shutdown waiting for worker thread" , default_logging_keys(:thread => t.inspect)) t.join end @filters.each(&:do_close) @outputs.each(&:do_close) end |
#stalling_threads_info ⇒ Object
673 674 675 676 677 678 679 |
# File 'lib/logstash/pipeline.rb', line 673 def stalling_threads_info plugin_threads_info .reject {|t| t["blocked_on"] } # known benign blocking statuses .each {|t| t.delete("backtrace") } .each {|t| t.delete("blocked_on") } .each {|t| t.delete("status") } end |
#start ⇒ Object
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/logstash/pipeline.rb', line 235 def start # Since we start lets assume that the metric namespace is cleared # this is useful in the context of pipeline reloading collect_stats collect_dlq_stats @logger.debug("Starting pipeline", default_logging_keys) @finished_execution = Concurrent::AtomicBoolean.new(false) @thread = Thread.new do begin LogStash::Util.set_thread_name("pipeline.#{pipeline_id}") run @finished_execution.make_true rescue => e close logger.error("Pipeline aborted due to error", default_logging_keys(:exception => e, :backtrace => e.backtrace)) end end status = wait_until_started if status logger.debug("Pipeline started successfully", default_logging_keys(:pipeline_id => pipeline_id)) end status end |
#start_flusher ⇒ Object
621 622 623 624 625 626 627 628 629 630 631 |
# File 'lib/logstash/pipeline.rb', line 621 def start_flusher # Invariant to help detect improper initialization raise "Attempted to start flusher on a stopped pipeline!" if stopped? @flusher_thread = Thread.new do while Stud.stoppable_sleep(5, 0.1) { stopped? } flush break if stopped? end end end |
#start_input(plugin) ⇒ Object
516 517 518 |
# File 'lib/logstash/pipeline.rb', line 516 def start_input(plugin) @input_threads << Thread.new { inputworker(plugin) } end |
#start_inputs ⇒ Object
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 |
# File 'lib/logstash/pipeline.rb', line 498 def start_inputs moreinputs = [] @inputs.each do |input| if input.threadable && input.threads > 1 (input.threads - 1).times do |i| moreinputs << input.clone end end end @inputs += moreinputs # first make sure we can register all input plugins register_plugins(@inputs) # then after all input plugins are successfully registered, start them @inputs.each { |input| start_input(input) } end |
#start_workers ⇒ Object
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'lib/logstash/pipeline.rb', line 360 def start_workers @worker_threads.clear # In case we're restarting the pipeline @outputs_registered.make_false begin maybe_setup_out_plugins pipeline_workers = safe_pipeline_worker_count batch_size = @settings.get("pipeline.batch.size") batch_delay = @settings.get("pipeline.batch.delay") max_inflight = batch_size * pipeline_workers config_metric = metric.namespace([:stats, :pipelines, pipeline_id.to_s.to_sym, :config]) config_metric.gauge(:workers, pipeline_workers) config_metric.gauge(:batch_size, batch_size) config_metric.gauge(:batch_delay, batch_delay) config_metric.gauge(:config_reload_automatic, @settings.get("config.reload.automatic")) config_metric.gauge(:config_reload_interval, @settings.get("config.reload.interval")) config_metric.gauge(:dead_letter_queue_enabled, dlq_enabled?) config_metric.gauge(:dead_letter_queue_path, @dlq_writer.get_path.to_absolute_path.to_s) if dlq_enabled? @logger.info("Starting pipeline", default_logging_keys( "pipeline.workers" => pipeline_workers, "pipeline.batch.size" => batch_size, "pipeline.batch.delay" => batch_delay, "pipeline.max_inflight" => max_inflight)) if max_inflight > MAX_INFLIGHT_WARN_THRESHOLD @logger.warn("CAUTION: Recommended inflight events max exceeded! Logstash will run with up to #{max_inflight} events in memory in your current configuration. If your message sizes are large this may cause instability with the default heap size. Please consider setting a non-standard heap size, changing the batch size (currently #{batch_size}), or changing the number of pipeline workers (currently #{pipeline_workers})", default_logging_keys) end pipeline_workers.times do |t| thread = Thread.new(batch_size, batch_delay, self) do |_b_size, _b_delay, _pipeline| _pipeline.worker_loop(_b_size, _b_delay) end thread.name="[#{pipeline_id}]>worker#{t}" @worker_threads << thread end # inputs should be started last, after all workers begin start_inputs rescue => e # if there is any exception in starting inputs, make sure we shutdown workers. # exception will already by logged in start_inputs shutdown_workers raise e end ensure # it is important to guarantee @ready to be true after the startup sequence has been completed # to potentially unblock the shutdown method which may be waiting on @ready to proceed @ready.make_true end end |
#stop_inputs ⇒ Object
577 578 579 580 581 |
# File 'lib/logstash/pipeline.rb', line 577 def stop_inputs @logger.debug("Closing inputs", default_logging_keys) @inputs.each(&:do_stop) @logger.debug("Closed inputs", default_logging_keys) end |
#stopped? ⇒ Boolean
331 332 333 |
# File 'lib/logstash/pipeline.rb', line 331 def stopped? @running.false? end |
#system? ⇒ Boolean
335 336 337 |
# File 'lib/logstash/pipeline.rb', line 335 def system? settings.get_value("pipeline.system") end |
#transition_to_running ⇒ Object
319 320 321 |
# File 'lib/logstash/pipeline.rb', line 319 def transition_to_running @running.make_true end |
#transition_to_stopped ⇒ Object
323 324 325 |
# File 'lib/logstash/pipeline.rb', line 323 def transition_to_stopped @running.make_false end |
#uptime ⇒ Fixnum
Calculate the uptime in milliseconds
647 648 649 650 |
# File 'lib/logstash/pipeline.rb', line 647 def uptime return 0 if started_at.nil? ((Time.now.to_f - started_at.to_f) * 1000.0).to_i end |
#wait_for_workers ⇒ Object
def shutdown
571 572 573 574 575 |
# File 'lib/logstash/pipeline.rb', line 571 def wait_for_workers @logger.debug("Closing inputs", default_logging_keys) @worker_threads.map(&:join) @logger.debug("Worker closed", default_logging_keys) end |
#wait_inputs ⇒ Object
494 495 496 |
# File 'lib/logstash/pipeline.rb', line 494 def wait_inputs @input_threads.each(&:join) end |
#wait_until_started ⇒ Object
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/logstash/pipeline.rb', line 265 def wait_until_started while true do # This should be changed with an appropriate FSM # It's an edge case, if we have a pipeline with # a generator { count => 1 } its possible that `Thread#alive?` doesn't return true # because the execution of the thread was successful and complete if @finished_execution.true? return true elsif !thread.alive? return false elsif running? return true else sleep 0.01 end end end |
#worker_loop(batch_size, batch_delay) ⇒ Object
Main body of what a worker thread does Repeatedly takes batches off the queue, filters, then outputs them
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 |
# File 'lib/logstash/pipeline.rb', line 421 def worker_loop(batch_size, batch_delay) shutdown_requested = false @filter_queue_client.set_batch_dimensions(batch_size, batch_delay) output_events_map = Hash.new { |h, k| h[k] = [] } while true signal = @signal_queue.poll || NO_SIGNAL shutdown_requested |= signal.shutdown? # latch on shutdown signal batch = @filter_queue_client.read_batch # metrics are started in read_batch batch_size = batch.size if batch_size > 0 @events_consumed.increment(batch_size) filter_batch(batch) end flush_filters_to_batch(batch, :final => false) if signal.flush? if batch.size > 0 output_batch(batch, output_events_map) @filter_queue_client.close_batch(batch) end # keep break at end of loop, after the read_batch operation, some pipeline specs rely on this "final read_batch" before shutdown. break if (shutdown_requested && !draining_queue?) end # we are shutting down, queue is drained if it was required, now perform a final flush. # for this we need to create a new empty batch to contain the final flushed events batch = @filter_queue_client.new_batch @filter_queue_client.start_metrics(batch) # explicitly call start_metrics since we dont do a read_batch here flush_filters_to_batch(batch, :final => true) output_batch(batch, output_events_map) @filter_queue_client.close_batch(batch) end |