logstash-output-elasticsearch-test 11.16.0-x86_64-linux

data/spec/integration/outputs/no_es_on_startup_spec.rb

@@ -0,0 +1,78 @@
+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,
+                                           'ecs_compatibility' => 'disabled'
+                                       })
+  }
+
+  before :each do
+    # Delete all templates first.
+    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("TEST: before docs are sent"), 'http://test.es/'
+    )
+    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(index: 'logstash-*')
+    expect(r).to have_hits(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("TEST: after docs are sent"), 'http://test.es/'
+    )
+    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(index: 'logstash-*')
+    expect(r).to have_hits(2)
+  end
+
+  it 'should get cluster_uuid when Elasticsearch recovers from license check failure' do
+    allow_any_instance_of(LogStash::Outputs::ElasticSearch::HttpClient::Pool).to receive(:get_license).and_raise(
+        ::LogStash::Outputs::ElasticSearch::HttpClient::Pool::HostUnreachableError.new StandardError.new("TEST: docs are sent"), 'http://test.es/_license'
+    )
+    subject.register
+    Thread.new do
+      sleep 4
+      allow_any_instance_of(LogStash::Outputs::ElasticSearch::HttpClient::Pool).to receive(:get_license).and_call_original
+    end
+    subject.multi_receive([event1, event2])
+    @es.indices.refresh
+    r = @es.search(index: 'logstash-*')
+    expect(r).to have_hits(2)
+    expect(subject.plugin_metadata.get(:cluster_uuid)).not_to be_empty
+    expect(subject.plugin_metadata.get(:cluster_uuid)).not_to eq("_na_")
+  end if ESHelper.es_version_satisfies?(">=7")
+end

data/spec/integration/outputs/painless_update_spec.rb

@@ -0,0 +1,99 @@
+require_relative "../../../spec/es_spec_helper"
+
+describe "Update actions using painless scripts", :integration => true, :update_tests => 'painless' do
+  require "logstash/outputs/elasticsearch"
+
+  def get_es_output( options={} )
+    settings = {
+      "manage_template" => true,
+      "index" => "logstash-update",
+      "template_overwrite" => true,
+      "hosts" => get_host_port(),
+      "action" => "update"
+    }
+    LogStash::Outputs::ElasticSearch.new(settings.merge!(options))
+  end
+
+  before :each do
+    @es = get_client
+    # Delete all templates first.
+    # Clean ES of data before we start.
+    @es.indices.delete_template(:name => "*")
+    # This can fail if there are no indexes, ignore failure.
+    @es.indices.delete(:index => "*") rescue nil
+    @es.index(
+      :index => 'logstash-update',
+      :type => doc_type,
+      :id => "123",
+      :body => { :message => 'Test', :counter => 1 }
+    )
+    @es.indices.refresh
+  end
+
+  context "scripted updates" do
+    context 'with an indexed script' do
+      it "should increment a counter with event/doc 'count' variable with indexed script" do
+        @es.perform_request(:put, "_scripts/indexed_update", {}, {"script" => {"source" => "ctx._source.counter += params.event.count", "lang" => "painless"}})
+
+        plugin_parameters = {
+          'document_id' => "123",
+          'script' => 'indexed_update',
+          'script_type' => 'indexed'
+        }
+
+        plugin_parameters.merge!('script_lang' => '')
+
+        subject = get_es_output(plugin_parameters)
+        subject.register
+        subject.multi_receive([LogStash::Event.new("count" => 4 )])
+        r = @es.get(:index => 'logstash-update', :type => doc_type, :id => "123", :refresh => true)
+        expect(r["_source"]["counter"]).to eq(5)
+      end
+    end
+   end
+
+  context "when update with upsert" do
+    it "should create new documents with provided upsert" do
+      subject = get_es_output({ 'document_id' => "456", 'upsert' => '{"message": "upsert message"}' })
+      subject.register
+      subject.multi_receive([LogStash::Event.new("message" => "sample message here")])
+      r = @es.get(:index => 'logstash-update', :type => doc_type, :id => "456", :refresh => true)
+      expect(r["_source"]["message"]).to eq('upsert message')
+    end
+
+    it "should create new documents with event/doc as upsert" do
+      subject = get_es_output({ 'document_id' => "456", 'doc_as_upsert' => true })
+      subject.register
+      subject.multi_receive([LogStash::Event.new("message" => "sample message here")])
+      r = @es.get(:index => 'logstash-update', :type => doc_type, :id => "456", :refresh => true)
+      expect(r["_source"]["message"]).to eq('sample message here')
+    end
+
+    it "should fail on documents with event/doc as upsert at external version" do
+      subject = get_es_output({ 'document_id' => "456", 'doc_as_upsert' => true, 'version' => 999, "version_type" => "external" })
+      expect { subject.register }.to raise_error(LogStash::ConfigurationError)
+    end
+  end
+
+  context "updates with scripted upsert" do
+    context 'with an inline script' do
+      it "should create new documents with upsert content" do
+        subject = get_es_output({ 'document_id' => "456", 'script' => 'ctx._source.counter = params.event.counter', 'upsert' => '{"message": "upsert message"}', 'script_type' => 'inline' })
+        subject.register
+
+        subject.multi_receive([LogStash::Event.new("message" => "sample message here")])
+        r = @es.get(:index => 'logstash-update', :type => doc_type, :id => "456", :refresh => true)
+        expect(r["_source"]["message"]).to eq('upsert message')
+      end
+
+      it "should create new documents with event/doc as script params" do
+        subject = get_es_output({ 'document_id' => "456", 'script' => 'ctx._source.counter = params.event.counter', 'scripted_upsert' => true, 'script_type' => 'inline' })
+        subject.register
+        subject.multi_receive([LogStash::Event.new("counter" => 1)])
+        @es.indices.refresh
+        r = @es.get(:index => 'logstash-update', :type => doc_type, :id => "456", :refresh => true)
+        expect(r["_source"]["counter"]).to eq(1)
+      end
+    end
+  end
+end

data/spec/integration/outputs/parent_spec.rb

@@ -0,0 +1,94 @@
+require_relative "../../../spec/es_spec_helper"
+require "logstash/outputs/elasticsearch"
+
+describe "join type field", :integration => true do
+
+  shared_examples "a join field based parent indexer" do
+    let(:index) { 10.times.collect { rand(10).to_s }.join("") }
+
+    let(:type) { ESHelper.es_version_satisfies?("< 7") ? "doc" : "_doc" }
+
+    let(:event_count) { 10000 + rand(500) }
+    let(:parent) { "not_implemented" }
+    let(:config) { "not_implemented" }
+    let(:parent_id) { "test" }
+    let(:join_field) { "join_field" }
+    let(:parent_relation) { "parent_type" }
+    let(:child_relation) { "child_type" }
+    let(:default_headers) {
+      {"Content-Type" => "application/json"}
+    }
+    subject { LogStash::Outputs::ElasticSearch.new(config) }
+
+    before do
+      # Add mapping and a parent document
+      index_url = "http://#{get_host_port()}/#{index}"
+
+      properties = {
+        "properties" => {
+          join_field => {
+            "type" => "join",
+            "relations" => { parent_relation => child_relation }
+          }
+        }
+      }
+
+      mapping = ESHelper.es_version_satisfies?('<7') ? { "mappings" => { type => properties } }
+                                                     : { "mappings" => properties}
+
+      Manticore.put("#{index_url}", {:body => mapping.to_json, :headers => default_headers}).call
+      pdoc = { "message" => "ohayo", join_field => parent_relation }
+      Manticore.put("#{index_url}/#{type}/#{parent_id}", {:body => pdoc.to_json, :headers => default_headers}).call
+
+      subject.register
+      subject.multi_receive(event_count.times.map { LogStash::Event.new("link_to" => parent_id, "message" => "Hello World!", join_field => child_relation) })
+    end
+
+
+    it "ships events" do
+      index_url = "http://#{get_host_port()}/#{index}"
+
+      Manticore.post("#{index_url}/_refresh").call
+
+      # Wait until all events are available.
+      Stud::try(10.times) do
+        query = { "query" => { "has_parent" => { "parent_type" => parent_relation, "query" => { "match_all" => { } } } } }
+        response = Manticore.post("#{index_url}/_count", {:body => query.to_json, :headers => default_headers})
+        data = response.body
+        result = LogStash::Json.load(data)
+        cur_count = result["count"]
+        expect(cur_count).to eq(event_count)
+      end
+    end
+  end
+
+  describe "(http protocol) index events with static parent" do
+    it_behaves_like 'a join field based parent indexer' do
+      let(:config) {
+        {
+          "hosts" => get_host_port,
+          "index" => index,
+          "parent" => parent_id,
+          "document_type" => type,
+          "join_field" => join_field,
+          "manage_template" => false
+        }
+      }
+    end
+  end
+
+  describe "(http_protocol) index events with fieldref in parent value" do
+    it_behaves_like 'a join field based parent indexer' do
+      let(:config) {
+        {
+          "hosts" => get_host_port,
+          "index" => index,
+          "parent" => "%{link_to}",
+          "document_type" => type,
+          "join_field" => join_field,
+          "manage_template" => false
+        }
+      }
+    end
+  end
+end

data/spec/integration/outputs/retry_spec.rb

@@ -0,0 +1,182 @@
+require "logstash/outputs/elasticsearch"
+require_relative "../../../spec/es_spec_helper"
+
+describe "failures in bulk class expected behavior", :integration => true do
+  let(:template) { '{"template" : "not important, will be updated by :index"}' }
+  let(:event1) { LogStash::Event.new("somevalue" => 100, "@timestamp" => "2014-11-17T20:37:17.223Z", "@metadata" => {"retry_count" => 0}) }
+  let(:action1) do
+    if ESHelper.es_version_satisfies?("< 7")
+      ESHelper.action_for_version(["index", {:_id=>nil, routing_field_name =>nil, :_index=>"logstash-2014.11.17", :_type=> doc_type }, event1.to_hash])
+    else
+      ESHelper.action_for_version(["index", {:_id=>nil, routing_field_name =>nil, :_index=>"logstash-2014.11.17" }, event1.to_hash])
+    end
+  end
+  let(:event2) { LogStash::Event.new("geoip" => { "location" => [ 0.0, 0.0] }, "@timestamp" => "2014-11-17T20:37:17.223Z", "@metadata" => {"retry_count" => 0}) }
+  let(:action2) do
+    if ESHelper.es_version_satisfies?("< 7")
+      ESHelper.action_for_version(["index", {:_id=>nil, routing_field_name =>nil, :_index=>"logstash-2014.11.17", :_type=> doc_type }, event2.to_hash])
+    else
+      ESHelper.action_for_version(["index", {:_id=>nil, routing_field_name =>nil, :_index=>"logstash-2014.11.17" }, event2.to_hash])
+    end
+  end
+  let(:invalid_event) { LogStash::Event.new("geoip" => { "location" => "notlatlon" }, "@timestamp" => "2014-11-17T20:37:17.223Z") }
+
+  def mock_actions_with_response(*resp)
+    raise ArgumentError, "Cannot mock actions until subject is registered and has a client!" unless subject.client
+
+    expanded_responses = resp.map do |resp|
+      items = resp["statuses"] && resp["statuses"].map do |status|
+        {"create" => {"status" => status, "error" => "Error for #{status}"}}
+      end
+
+      {
+        "errors" => resp["errors"],
+        "items" => items
+      }
+    end
+
+    allow(subject.client).to receive(:bulk).and_return(*expanded_responses)
+  end
+
+  subject! do
+    settings = {
+      "manage_template" => true,
+      "index" => "logstash-2014.11.17",
+      "template_overwrite" => true,
+      "hosts" => get_host_port(),
+      "retry_max_interval" => 64,
+      "retry_initial_interval" => 2,
+      "ecs_compatibility" => "disabled", # specs are tightly tied to non-ECS defaults
+    }
+    next LogStash::Outputs::ElasticSearch.new(settings)
+  end
+
+  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 retry exactly once if all bulk actions are successful" do
+    expect(subject).to receive(:submit).with([action1, action2]).once.and_call_original
+    subject.register
+    mock_actions_with_response({"errors" => false})
+    subject.multi_receive([event1, event2])
+  end
+
+  it "retry exceptions within the submit body" do
+    call_count = 0
+    subject.register
+
+    expect(subject.client).to receive(:bulk).with(anything).exactly(3).times do
+      if (call_count += 1) <= 2
+        raise "error first two times"
+      else
+        {"errors" => false}
+      end
+    end
+
+    subject.multi_receive([event1])
+  end
+
+  it "should retry actions with response status of 503" do    expect(subject).to receive(:submit).with([action1, action1, action1, action2]).ordered.once.and_call_original
+    expect(subject).to receive(:submit).with([action1, action2]).ordered.once.and_call_original
+    expect(subject).to receive(:submit).with([action2]).ordered.once.and_call_original
+
+    subject.register
+    mock_actions_with_response({"errors" => true, "statuses" => [200, 200, 503, 503]},
+                               {"errors" => true, "statuses" => [200, 503]},
+                               {"errors" => false})
+
+    subject.multi_receive([event1, event1, event1, event2])
+  end
+
+  retryable_codes = [429, 502, 503]
+
+  retryable_codes.each do |code|
+    it "should retry actions with response status of #{code}" do
+      subject.register
+
+      mock_actions_with_response({"errors" => true, "statuses" => [code]},
+                                 {"errors" => false})
+      expect(subject).to receive(:submit).with([action1]).twice.and_call_original
+
+      subject.multi_receive([event1])
+    end
+  end
+
+  it "should retry an event infinitely until a non retryable status occurs" do
+    expect(subject).to receive(:submit).with([action1]).exactly(6).times.and_call_original
+    subject.register
+
+    mock_actions_with_response({"errors" => true, "statuses" => [429]},
+                               {"errors" => true, "statuses" => [429]},
+                               {"errors" => true, "statuses" => [429]},
+                               {"errors" => true, "statuses" => [429]},
+                               {"errors" => true, "statuses" => [429]},
+                               {"errors" => true, "statuses" => [400]})
+
+    subject.multi_receive([event1])
+  end
+
+  it "should sleep for an exponentially increasing amount of time on each retry, capped by the max" do
+    [2, 4, 8, 16, 32, 64, 64].each_with_index do |interval,i|
+      expect(Stud).to receive(:stoppable_sleep).with(interval).ordered
+    end
+
+    subject.register
+
+    mock_actions_with_response({"errors" => true, "statuses" => [429]},
+                               {"errors" => true, "statuses" => [429]},
+                               {"errors" => true, "statuses" => [429]},
+                               {"errors" => true, "statuses" => [429]},
+                               {"errors" => true, "statuses" => [429]},
+                               {"errors" => true, "statuses" => [429]},
+                               {"errors" => true, "statuses" => [429]},
+                               {"errors" => true, "statuses" => [400]})
+
+    subject.multi_receive([event1])
+  end
+
+  it "non-retryable errors like mapping errors (400) should be dropped and not be retried (unfortunately)" do
+    subject.register
+    expect(subject).to receive(:submit).once.and_call_original
+    subject.multi_receive([invalid_event])
+    subject.close
+
+    @es.indices.refresh
+    r = @es.search(index: 'logstash-*')
+    expect(r).to have_hits(0)
+  end
+
+  it "successful requests should not be appended to retry queue" do
+    expect(subject).to receive(:submit).once.and_call_original
+
+    subject.register
+    subject.multi_receive([event1])
+    subject.close
+    @es.indices.refresh
+    r = @es.search(index: 'logstash-*')
+    expect(r).to have_hits(1)
+  end
+
+  it "should only index proper events" do
+    subject.register
+    subject.multi_receive([invalid_event, event1])
+    subject.close
+
+    @es.indices.refresh
+    r = @es.search(index: 'logstash-*')
+    expect(r).to have_hits(1)
+  end
+end

data/spec/integration/outputs/routing_spec.rb

@@ -0,0 +1,61 @@
+require_relative "../../../spec/es_spec_helper"
+
+shared_examples "a routing indexer" do
+    let(:index) { 10.times.collect { rand(10).to_s }.join("") }
+    let(:type) { 10.times.collect { rand(10).to_s }.join("") }
+    let(:event_count) { 10000 + rand(500) }
+    let(:routing) { "not_implemented" }
+    let(:config) { "not_implemented" }
+    subject { LogStash::Outputs::ElasticSearch.new(config) }
+
+    before do
+      subject.register
+      event_count.times do
+        subject.multi_receive([LogStash::Event.new("message" => "test", "type" => type)])
+      end
+    end
+
+
+    it "ships events" do
+      index_url = "http://#{get_host_port()}/#{index}"
+
+      client = Manticore::Client.new
+      client.post("#{index_url}/_refresh").call
+
+      # Wait until all events are available.
+      Stud::try(10.times) do
+        data = ""
+
+        response = client.get("#{index_url}/_count?q=*&routing=#{routing}").call
+        result = LogStash::Json.load(response.body)
+        cur_count = result["count"]
+        expect(cur_count).to eq(event_count)
+      end
+    end
+end
+
+describe "(http protocol) index events with static routing", :integration => true do
+  it_behaves_like 'a routing indexer' do
+    let(:routing) { "test" }
+    let(:config) {
+      {
+        "hosts" => get_host_port,
+        "index" => index,
+        "routing" => routing
+      }
+    }
+  end
+end
+
+describe "(http_protocol) index events with fieldref in routing value", :integration => true do
+  it_behaves_like 'a routing indexer' do
+    let(:routing) { "test" }
+    let(:config) {
+      {
+        "hosts" => get_host_port,
+        "index" => index,
+        "routing" => "%{message}"
+      }
+    }
+  end
+end

data/spec/integration/outputs/sniffer_spec.rb

@@ -0,0 +1,94 @@
+require_relative "../../../spec/es_spec_helper"
+require "logstash/outputs/elasticsearch/http_client"
+require "json"
+require "socket"
+
+describe "pool sniffer", :integration => true do
+  let(:logger) { Cabin::Channel.get }
+  let(:adapter) { LogStash::Outputs::ElasticSearch::HttpClient::ManticoreAdapter.new(logger, {}) }
+  let(:es_host) { get_host_port.split(":").first }
+  let(:es_port) { get_host_port.split(":").last }
+  let(:es_ip) { IPSocket.getaddress(es_host) }
+  let(:initial_urls) { [::LogStash::Util::SafeURI.new("http://#{get_host_port}")] }
+  let(:options) do
+    {
+      :resurrect_delay => 2, # Shorten the delay a bit to speed up tests
+      :url_normalizer => proc {|u| u},
+      :metric => ::LogStash::Instrument::NullMetric.new(:dummy).namespace(:alsodummy)
+    }
+  end
+
+  subject { LogStash::Outputs::ElasticSearch::HttpClient::Pool.new(logger, adapter, initial_urls, options) }
+
+  describe("Simple sniff parsing")  do
+    before(:each) { subject.start }
+
+    context "with single node" do
+      it "should execute a sniff without error" do
+        expect { subject.check_sniff }.not_to raise_error
+      end
+
+      it "should return single sniff URL" do
+        uris = subject.check_sniff
+
+        expect(uris.size).to eq(1)
+      end
+
+      it "should return the correct sniff URL" do
+        if ESHelper.es_version_satisfies?("<7")
+          # We do a more thorough check on these versions because we can more reliably guess the ip
+          uris = subject.check_sniff
+
+          expect(uris).to include(::LogStash::Util::SafeURI.new("//#{es_ip}:#{es_port}"))
+        else
+          # ES 1.x (and ES 7.x) returned the public hostname by default. This is hard to approximate
+          # so for ES1.x and 7.x we don't check the *exact* hostname
+          skip
+        end
+      end
+    end
+  end
+
+  if ESHelper.es_version_satisfies?(">= 7")
+    describe("Complex sniff parsing ES 7x") do
+      before(:each) do
+        response_double = double("_nodes/http", body: File.read("spec/fixtures/_nodes/7x.json"))
+        allow(subject).to receive(:perform_request).and_return([nil, { version: "7.0" }, response_double])
+        subject.start
+      end
+
+      context "with mixed master-only, data-only, and data + master nodes" do
+        it "should execute a sniff without error" do
+          expect { subject.check_sniff }.not_to raise_error
+        end
+
+        it "should return the correct sniff URLs" do
+          # ie. with the master-only node, and with the node name correctly set.
+          uris = subject.check_sniff
+
+          expect(uris).to include(::LogStash::Util::SafeURI.new("//dev-masterdata:9201"), ::LogStash::Util::SafeURI.new("//dev-data:9202"))
+        end
+      end
+    end
+  end
+  describe("Complex sniff parsing ES") do
+    before(:each) do
+      response_double = double("_nodes/http", body: File.read("spec/fixtures/_nodes/6x.json"))
+      allow(subject).to receive(:perform_request).and_return([nil, { version: "6.8" }, response_double])
+      subject.start
+    end
+
+    context "with mixed master-only, data-only, and data + master nodes" do
+      it "should execute a sniff without error" do
+        expect { subject.check_sniff }.not_to raise_error
+      end
+
+      it "should return the correct sniff URLs" do
+        # ie. without the master-only node
+        uris = subject.check_sniff
+
+        expect(uris).to include(::LogStash::Util::SafeURI.new("//127.0.0.1:9201"), ::LogStash::Util::SafeURI.new("//127.0.0.1:9202"), ::LogStash::Util::SafeURI.new("//127.0.0.1:9203"))
+      end
+    end
+  end
+end