logstash-output-elasticsearch 9.1.2-java → 9.1.3-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 123fca22f700bc5760a15f5beaa40ecae654e6e9b39fa19a3d8662d04963ab3c
-  data.tar.gz: 495fa3272f872a14cd6b4361017f4cbba5d846cdad47e99321cf06ac2ce66b70
+  metadata.gz: c039da495adec68b5bb57018b408430dede45c5389744d0d8b043d6210a60d08
+  data.tar.gz: e2a28d5dee5519a151fd501d61f41b1bf182dcd2f262a0b2588b6be7272c2067
 SHA512:
-  metadata.gz: ae33f09690b8e90cb679a18b655f9349d6d6204bb9932d6c0ecde987c5871fbd16d60c65e66e52a5d38427a22099611bc5df4ac8ee529c98f6618e5e47a8ea5b
-  data.tar.gz: f2cbe7d567b6f46a3d396b2316db05499209e769415760ddda080f60366ed1e69bcd7ed64d3084742394186b9ff79650d7db7c95fab9aa3715bc074b7a2ed18e
+  metadata.gz: 4fa67d4e34cbf2d0c7de02cece71c2ea1e938a820a839878d9d07535590da657b71069312d843ef37e6e444f24149d165f61189abff7f0d4d59e1e0273d06cde
+  data.tar.gz: 908fed926ba7ccdecbd77f6e1493a811214824756e396f287ca9e82b5dd280c60b79c51299c4963bf0e1168561404a3d567a63f5f930915658a062e914289cc1

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 9.1.3
+  - Improve plugin behavior when Elasticsearch is down on startup #758
+
 ## 9.1.2
   - No user facing changes, removed unnecessary test dep.
 

data/lib/logstash/outputs/elasticsearch.rb

@@ -233,6 +233,7 @@ class LogStash::Outputs::ElasticSearch < LogStash::Outputs::Base
 
   def close
     @stopping.make_true
+    stop_template_installer
     @client.close if @client
   end
 

data/lib/logstash/outputs/elasticsearch/common.rb

@@ -16,26 +16,48 @@ module LogStash; module Outputs; class ElasticSearch;
     VERSION_TYPES_PERMITTING_CONFLICT = ["external", "external_gt", "external_gte"]
 
     def register
+      @template_installed = Concurrent::AtomicBoolean.new(false)
       @stopping = Concurrent::AtomicBoolean.new(false)
       # To support BWC, we check if DLQ exists in core (< 5.4). If it doesn't, we use nil to resort to previous behavior.
       @dlq_writer = dlq_enabled? ? execution_context.dlq_writer : nil
 
       setup_hosts # properly sets @hosts
       build_client
-
-      install_template
       check_action_validity
       @bulk_request_metrics = metric.namespace(:bulk_requests)
       @document_level_metrics = metric.namespace(:documents)
-
+      install_template_after_successful_connection
       @logger.info("New Elasticsearch output", :class => self.class.name, :hosts => @hosts.map(&:sanitized).map(&:to_s))
     end
 
     # Receive an array of events and immediately attempt to index them (no buffering)
     def multi_receive(events)
+      until @template_installed.true?
+        sleep 1
+      end
       retrying_submit(events.map {|e| event_action_tuple(e)})
     end
 
+    def install_template_after_successful_connection
+      @template_installer ||= Thread.new do
+        sleep_interval = @retry_initial_interval
+        until successful_connection? || @stopping.true?
+          @logger.debug("Waiting for connectivity to Elasticsearch cluster. Retrying in #{sleep_interval}s")
+          Stud.stoppable_sleep(sleep_interval) { @stopping.true? }
+          sleep_interval = next_sleep_interval(sleep_interval)
+        end
+        install_template if successful_connection?
+      end
+    end
+
+    def stop_template_installer
+      @template_installer.join unless @template_installer.nil?
+    end
+
+    def successful_connection?
+      !!maximum_seen_major_version
+    end
+
     # Convert the event into a 3-tuple of action, params, and event
     def event_action_tuple(event)
 
@@ -94,6 +116,7 @@ module LogStash; module Outputs; class ElasticSearch;
 
     def install_template
       TemplateManager.install_template(self)
+      @template_installed.make_true
     end
 
     def check_action_validity

data/logstash-output-elasticsearch.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-elasticsearch'
-  s.version         = '9.1.2'
+  s.version         = '9.1.3'
   s.licenses        = ['apache-2.0']
   s.summary         = "Stores logs in Elasticsearch"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

data/spec/es_spec_helper.rb

@@ -11,6 +11,10 @@ module ESHelper
     Elasticsearch::Client.new(:hosts => [get_host_port])
   end
 
+  def self.es_version
+    RSpec.configuration.filter[:es_version] || ENV['ES_VERSION']
+  end
+
   def self.es_version_satisfies?(*requirement)
     es_version = RSpec.configuration.filter[:es_version] || ENV['ES_VERSION']
     es_release_version = Gem::Version.new(es_version).release

data/spec/integration/outputs/compressed_indexing_spec.rb

@@ -60,6 +60,7 @@ if ESHelper.es_version_satisfies?(">= 5")
     end
 
     it "sets the correct content-encoding header and body is compressed" do
+      allow(subject.client.pool.adapter.client).to receive(:send).with(anything, /_template/, anything).and_call_original
       expect(subject.client.pool.adapter.client).to receive(:send).
         with(anything, anything, {:headers=>{"Content-Encoding"=>"gzip", "Content-Type"=>"application/json"}, :body => a_valid_gzip_encoded_string}).
         and_call_original

data/spec/integration/outputs/index_spec.rb

@@ -99,9 +99,10 @@ describe "indexing" do
             :eager => true
           }}
       end
-
+      # Allow template to be checked for existence/installed
+      allow(subject.client.pool.adapter.client).to receive(:send).with(anything, /_template/, anything).and_call_original
       expect(subject.client.pool.adapter.client).to receive(:send).
-        with(anything, anything, expected_manticore_opts).
+        with(anything, anything, expected_manticore_opts).at_least(:once).
         and_call_original
       subject.multi_receive(events)
     end
@@ -128,7 +129,7 @@ describe "indexing" do
     it_behaves_like("an indexer")
   end
 
-  describe "a secured indexer", :secure_integration => true do
+  describe "a secured indexer", :elasticsearch_secure => true do
     let(:user) { "simpleuser" }
     let(:password) { "abc123" }
     let(:cacert) { "spec/fixtures/test_certs/test.crt" }

data/spec/integration/outputs/no_es_on_startup_spec.rb

@@ -0,0 +1,58 @@
+require "logstash/outputs/elasticsearch"
+require_relative "../../../spec/es_spec_helper"
+
+describe "elasticsearch is down on startup", :integration => true do
+  let(:event1) { LogStash::Event.new("somevalue" => 100, "@timestamp" => "2014-11-17T20:37:17.223Z", "@metadata" => {"retry_count" => 0}) }
+  let(:event2) { LogStash::Event.new("message" => "a") }
+
+  subject {
+    LogStash::Outputs::ElasticSearch.new({
+                                           "manage_template" => true,
+                                           "index" => "logstash-2014.11.17",
+                                           "template_overwrite" => true,
+                                           "hosts" => get_host_port(),
+                                           "retry_max_interval" => 64,
+                                           "retry_initial_interval" => 2
+                                       })
+  }
+
+  before :each do
+    # Delete all templates first.
+    require "elasticsearch"
+    allow(Stud).to receive(:stoppable_sleep)
+
+    # Clean ES of data before we start.
+    @es = get_client
+    @es.indices.delete_template(:name => "*")
+    @es.indices.delete(:index => "*")
+    @es.indices.refresh
+  end
+
+  after :each do
+    subject.close
+  end
+
+  it 'should ingest events when Elasticsearch recovers before documents are sent' do
+    allow_any_instance_of(LogStash::Outputs::ElasticSearch::HttpClient::Pool).to receive(:get_es_version).and_raise(::LogStash::Outputs::ElasticSearch::HttpClient::Pool::HostUnreachableError.new(StandardError.new, "big fail"))
+    subject.register
+    allow_any_instance_of(LogStash::Outputs::ElasticSearch::HttpClient::Pool).to receive(:get_es_version).and_return(ESHelper.es_version)
+    subject.multi_receive([event1, event2])
+    @es.indices.refresh
+    r = @es.search
+    expect(r["hits"]["total"]).to eql(2)
+  end
+
+  it 'should ingest events when Elasticsearch recovers after documents are sent' do
+    allow_any_instance_of(LogStash::Outputs::ElasticSearch::HttpClient::Pool).to receive(:get_es_version).and_raise(::LogStash::Outputs::ElasticSearch::HttpClient::Pool::HostUnreachableError.new(StandardError.new, "big fail"))
+    subject.register
+    Thread.new do
+      sleep 4
+      allow_any_instance_of(LogStash::Outputs::ElasticSearch::HttpClient::Pool).to receive(:get_es_version).and_return(ESHelper.es_version)
+    end
+    subject.multi_receive([event1, event2])
+    @es.indices.refresh
+    r = @es.search
+    expect(r["hits"]["total"]).to eql(2)
+  end
+
+end

data/spec/unit/outputs/elasticsearch/http_client_spec.rb

@@ -86,7 +86,7 @@ describe LogStash::Outputs::ElasticSearch::HttpClient do
 
         context "with the path option set" do
           let(:base_options) { super.merge(:client_settings => {:path => "/otherpath"}) }
-          
+
           it "should not allow paths in two places" do
             expect {
               subject.host_to_url(url)

data/spec/unit/outputs/elasticsearch_proxy_spec.rb

@@ -18,6 +18,10 @@ describe "Proxy option" do
       subject.register
     end
 
+    after do
+      subject.close
+    end
+
     context "when specified as a URI" do
       shared_examples("hash conversion") do |hash|
         let(:settings) { super.merge("proxy" => proxy)}

data/spec/unit/outputs/elasticsearch_spec.rb

@@ -314,6 +314,7 @@ describe LogStash::Outputs::ElasticSearch do
   end
 
   describe "SSL end to end" do
+    let(:do_register) { false } # skip the register in the global before block, as is called here.
     let(:manticore_double) do
       double("manticoreX#{self.inspect}")
     end
@@ -409,6 +410,10 @@ describe LogStash::Outputs::ElasticSearch do
       allow(::Manticore::Client).to receive(:new).with(any_args).and_call_original
     end
 
+    after :each do
+      subject.close
+    end
+
     it "should set the correct http client option for 'validate_after_inactivity'" do
       subject.register
       expect(::Manticore::Client).to have_received(:new) do |options|
@@ -457,7 +462,7 @@ describe LogStash::Outputs::ElasticSearch do
         end
       end
 
-      context "with explicity query parameters" do
+      context "with explicit query parameters" do
         let(:options) {
           {
             "hosts" => ["http://localhost:9202/path"],
@@ -470,7 +475,7 @@ describe LogStash::Outputs::ElasticSearch do
         end
       end
 
-      context "with explicity query parameters and existing url parameters" do
+      context "with explicit query parameters and existing url parameters" do
         let(:existing_query_string) { "existing=param" }
         let(:options) {
           {

data/spec/unit/outputs/elasticsearch_ssl_spec.rb

@@ -58,6 +58,7 @@ describe "SSL option" do
 
     after :each do
       File.delete(keystore_path)
+      subject.close
     end
 
     subject do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 9.1.2
+  version: 9.1.3
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-01 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +191,7 @@ files:
 - spec/integration/outputs/index_version_spec.rb
 - spec/integration/outputs/ingest_pipeline_spec.rb
 - spec/integration/outputs/metrics_spec.rb
+- spec/integration/outputs/no_es_on_startup_spec.rb
 - spec/integration/outputs/painless_update_spec.rb
 - spec/integration/outputs/parent_spec.rb
 - spec/integration/outputs/retry_spec.rb
@@ -258,6 +259,7 @@ test_files:
 - spec/integration/outputs/index_version_spec.rb
 - spec/integration/outputs/ingest_pipeline_spec.rb
 - spec/integration/outputs/metrics_spec.rb
+- spec/integration/outputs/no_es_on_startup_spec.rb
 - spec/integration/outputs/painless_update_spec.rb
 - spec/integration/outputs/parent_spec.rb
 - spec/integration/outputs/retry_spec.rb