github-mirrors/logstash
1
0
Fork 0
mirror of https://github.com/elastic/logstash.git synced 2025-04-24 22:57:16 -04:00
Code Issues Projects Releases Packages Wiki Activity

ensure input plugin close is called upon termination or pipeline reload

Browse source
This commit is contained in:
Colin Surprenant 2020-08-20 14:53:51 -04:00
parent 4ef0204098
commit 75411cfe0b
4 changed files with 68 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

46
logstash-core/lib/logstash/java_pipeline.rb
View file

@ -378,32 +378,33 @@ module LogStash; class JavaPipeline < JavaBasePipeline
plugin.run(wrapped_write_client(plugin.id.to_sym)) plugin.run(wrapped_write_client(plugin.id.to_sym))
rescue => e rescue => e
if plugin.stop? if plugin.stop?
@logger.debug("Input plugin raised exception during shutdown, ignoring it.", @logger.debug(
default_logging_keys(:plugin => plugin.class.config_name, :exception => e.message, :backtrace => e.backtrace)) "Input plugin raised exception during shutdown, ignoring it.",
default_logging_keys(
:plugin => plugin.class.config_name,
:exception => e.message,
:backtrace => e.backtrace))
return return
end end
# otherwise, report error and restart # otherwise, report error and restart
@logger.error(I18n.t("logstash.pipeline.worker-error-debug", @logger.error(I18n.t(
default_logging_keys( "logstash.pipeline.worker-error-debug",
:plugin => plugin.inspect, default_logging_keys(
:error => e.message, :plugin => plugin.inspect,
:exception => e.class, :error => e.message,
:stacktrace => e.backtrace.join("\n")))) :exception => e.class,
:stacktrace => e.backtrace.join("\n"))))
# Assuming the failure that caused this exception is transient, # Assuming the failure that caused this exception is transient,
# let's sleep for a bit and execute #run again # let's sleep for a bit and execute #run again
sleep(1) sleep(1)
begin close_plugin_and_ignore(plugin)
plugin.do_close
rescue => close_exception
@logger.debug("Input plugin raised exception while closing, ignoring",
default_logging_keys(:plugin => plugin.class.config_name, :exception => close_exception.message,
:backtrace => close_exception.backtrace))
end
retry retry
ensure
close_plugin_and_ignore(plugin)
end end
end # def inputworker end
# initiate the pipeline shutdown sequence # initiate the pipeline shutdown sequence
# this method is intended to be called from outside the pipeline thread # this method is intended to be called from outside the pipeline thread
@ -519,6 +520,19 @@ module LogStash; class JavaPipeline < JavaBasePipeline
private private
def close_plugin_and_ignore(plugin)
begin
plugin.do_close
rescue => e
@logger.warn(
"plugin raised exception while closing, ignoring",
default_logging_keys(
:plugin => plugin.class.config_name,
:exception => e.message,
:backtrace => e.backtrace))
end
end
# @return [WorkerLoop] a new WorkerLoop instance or nil upon construction exception # @return [WorkerLoop] a new WorkerLoop instance or nil upon construction exception
def init_worker_loop def init_worker_loop
begin begin

46
logstash-core/lib/logstash/pipeline.rb
View file

@ -474,32 +474,33 @@ module LogStash; class Pipeline < BasePipeline
plugin.run(wrapped_write_client(plugin.id.to_sym)) plugin.run(wrapped_write_client(plugin.id.to_sym))
rescue => e rescue => e
if plugin.stop? if plugin.stop?
@logger.debug("Input plugin raised exception during shutdown, ignoring it.", @logger.debug(
default_logging_keys(:plugin => plugin.class.config_name, :exception => e.message, :backtrace => e.backtrace)) "Input plugin raised exception during shutdown, ignoring it.",
default_logging_keys(
:plugin => plugin.class.config_name,
:exception => e.message,
:backtrace => e.backtrace))
return return
end end
# otherwise, report error and restart # otherwise, report error and restart
@logger.error(I18n.t("logstash.pipeline.worker-error-debug", @logger.error(I18n.t(
default_logging_keys( "logstash.pipeline.worker-error-debug",
:plugin => plugin.inspect, default_logging_keys(
:error => e.message, :plugin => plugin.inspect,
:exception => e.class, :error => e.message,
:stacktrace => e.backtrace.join("\n")))) :exception => e.class,
:stacktrace => e.backtrace.join("\n"))))
# Assuming the failure that caused this exception is transient, # Assuming the failure that caused this exception is transient,
# let's sleep for a bit and execute #run again # let's sleep for a bit and execute #run again
sleep(1) sleep(1)
begin close_plugin_and_ignore(plugin)
plugin.do_close
rescue => close_exception
@logger.debug("Input plugin raised exception while closing, ignoring",
default_logging_keys(:plugin => plugin.class.config_name, :exception => close_exception.message,
:backtrace => close_exception.backtrace))
end
retry retry
ensure
close_plugin_and_ignore(plugin)
end end
end # def inputworker end
# initiate the pipeline shutdown sequence # initiate the pipeline shutdown sequence
# this method is intended to be called from outside the pipeline thread # this method is intended to be called from outside the pipeline thread
@ -654,6 +655,19 @@ module LogStash; class Pipeline < BasePipeline
private private
def close_plugin_and_ignore(plugin)
begin
plugin.do_close
rescue => e
@logger.warn(
"plugin raised exception while closing, ignoring",
default_logging_keys(
:plugin => plugin.class.config_name,
:exception => e.message,
:backtrace => e.backtrace))
end
end
def maybe_setup_out_plugins def maybe_setup_out_plugins
if @outputs_registered.make_true if @outputs_registered.make_true
register_plugins(@outputs) register_plugins(@outputs)

6
logstash-core/spec/logstash/java_pipeline_spec.rb
View file

@ -405,12 +405,14 @@ describe LogStash::JavaPipeline do
eos eos
} }
context "output close" do context "input and output close" do
let(:pipeline) { mock_java_pipeline_from_string(test_config_without_output_workers) } let(:pipeline) { mock_java_pipeline_from_string(test_config_without_output_workers) }
let(:output) { pipeline.outputs.first } let(:output) { pipeline.outputs.first }
let(:input) { pipeline.inputs.first }
it "should call close of output without output-workers" do it "should call close of input and output without output-workers" do
expect(output).to receive(:do_close).once expect(output).to receive(:do_close).once
expect(input).to receive(:do_close).once
pipeline.start pipeline.start
pipeline.shutdown pipeline.shutdown
end end

5
logstash-core/spec/logstash/pipeline_spec.rb
View file

@ -371,18 +371,21 @@ describe LogStash::Pipeline do
eos eos
} }
context "output close" do context "inputs and output close" do
let(:pipeline) { mock_pipeline_from_string(test_config_without_output_workers) } let(:pipeline) { mock_pipeline_from_string(test_config_without_output_workers) }
let(:output) { pipeline.outputs.first } let(:output) { pipeline.outputs.first }
let(:input) { pipeline.inputs.first }
before do before do
allow(output).to receive(:do_close) allow(output).to receive(:do_close)
allow(input).to receive(:do_close)
end end
it "should call close of output without output-workers" do it "should call close of output without output-workers" do
pipeline.start pipeline.start
pipeline.shutdown pipeline.shutdown
expect(output).to have_received(:do_close).once expect(output).to have_received(:do_close).once
expect(input).to have_received(:do_close).once
end end
end end
end end