fluent-plugin-elasticsearch 2.11.6 → 2.11.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a97d5261421d51521687b644f6f6b02555ad0f1fd592b24a40f876a8702ba4e
-  data.tar.gz: b31b34473d410112dd2d1d6e05ac51d277953bb2d33e411eaa6621731cbc5052
+  metadata.gz: 4a8adf956e53ac370bbabdb66572a3a61cfe3d27220532ff773ee7cffe53c600
+  data.tar.gz: 57d22aa95d06ca181f0f55a7c2f0be4b19f5050bb01e4cb9bf2df17c7a2c710e
 SHA512:
-  metadata.gz: d9708a487c86d1cdb367789fccf3ae0ff9a7900710e803e4ca2bcc22f5216334775ae806a86e9b08c09f473bda7c15fa3ba3a5df71ccd95a2de6f3a19fc6d3c5
-  data.tar.gz: 541256741abbb757a29ba855a19f1d880240f1b6a05d3583017b3f23b600b1bd987f8f8734f627e34868b4ba8d7083c0534d8c10878c5f0ea6216a47722416d1
+  metadata.gz: 596ba2952540acad16e8c49b60992382c0947c0d834375016560cd29b3d2ae7f29d18fd98006e2bda3dc3c9038d45dcf565084af6161c9abbbdb1d19f7e9ec48
+  data.tar.gz: 903f77f656774e464e0f230f7d18669374965d1a8391307f91a3470df92213a0c545211c9da4ea18a5c40e08d3af04d756c9582e4d36ee5ac61e4e5053ba70ce

data/History.md

@@ -2,6 +2,9 @@
 
 ### [Unreleased]
 
+### 2.11.7
+- Add mechanism to detect ES and its client version mismatch (#463)
+
 ### 2.11.6
 - 355 customize template (#431)
 

data/README.md

@@ -66,6 +66,7 @@ Current maintainers: @cosmo0920
   + [Generate Hash ID](#generate-hash-id)
   + [sniffer_class_name](#sniffer_class_name)
   + [reload_after](#reload_after)
+  + [validate_client_version](#validate-client-version)
   + [Not seeing a config you need?](#not-seeing-a-config-you-need)
   + [Dynamic configuration](#dynamic-configuration)
   + [Placeholders](#placeholders)
@@ -763,6 +764,14 @@ reload_after 100
 When `reload_connections true`, this is the integer number of operations after which the plugin will
 reload the connections.  The default value is 10000.
 
+### Validate Client Version
+
+When you use mismatched Elasticsearch server and client libraries, fluent-plugin-elasticsearch cannot send data into Elasticsearch. The default value is `false`.
+
+```
+validate_client_version true
+```
+
 ### Not seeing a config you need?
 
 We try to keep the scope of this plugin small and not add too many configuration options. If you think an option would be useful to others, feel free to open an issue or contribute a Pull Request.

data/fluent-plugin-elasticsearch.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |s|
   s.name          = 'fluent-plugin-elasticsearch'
-  s.version       = '2.11.6'
+  s.version       = '2.11.7'
   s.authors       = ['diogo', 'pitr']
   s.email         = ['pitr.vern@gmail.com', 'me@diogoterror.com']
   s.description   = %q{Elasticsearch output plugin for Fluent event collector}

data/lib/fluent/plugin/out_elasticsearch.rb

@@ -113,6 +113,7 @@ see: https://github.com/elastic/elasticsearch-ruby/pull/514
 EOC
     config_param :include_index_in_url, :bool, :default => false
     config_param :http_backend, :enum, list: [:excon, :typhoeus], :default => :excon
+    config_param :validate_client_version, :bool, :default => false
 
     config_section :buffer do
       config_set_default :@type, DEFAULT_BUFFER_TYPE
@@ -207,6 +208,15 @@ EOC
         @type_name = '_doc'.freeze
       end
 
+      if @validate_client_version
+        if @last_seen_major_version != client_library_version.to_i
+          raise Fluent::ConfigError, <<-EOC
+            Detected ES #{@last_seen_major_version} but you use ES client #{client_library_version}.
+            Please consider to use #{@last_seen_major_version}.x series ES client.
+          EOC
+        end
+      end
+
       if @last_seen_major_version >= 6
         case @ssl_version
         when :SSLv23, :TLSv1, :TLSv1_1
@@ -241,6 +251,10 @@ EOC
       @_es_info["version"]["number"].to_i
     end
 
+    def client_library_version
+      Elasticsearch::VERSION
+    end
+
     def convert_compat_id_key(key)
       if key.include?('.') && !key.start_with?('$[')
         key = "$.#{key}" unless key.start_with?('$.')

data/test/plugin/test_out_elasticsearch.rb

@@ -19,13 +19,17 @@ class ElasticsearchOutput < Test::Unit::TestCase
     log.out.logs.slice!(0, log.out.logs.length)
   end
 
-  def driver(conf='', es_version=5)
+  def driver(conf='', es_version=5, client_version="\"5.0\"")
     # For request stub to detect compatibility.
     @es_version ||= es_version
+    @client_version ||= client_version
     Fluent::Plugin::ElasticsearchOutput.module_eval(<<-CODE)
       def detect_es_major_version
         #{@es_version}
       end
+      def client_library_version
+        #{@client_version}
+      end
     CODE
     @driver ||= Fluent::Test::Driver::Output.new(Fluent::Plugin::ElasticsearchOutput) {
       # v0.12's test driver assume format definition. This simulates ObjectBufferedOutput format
@@ -266,6 +270,26 @@ class ElasticsearchOutput < Test::Unit::TestCase
     assert_logs_include(logs, /Detected ES 6.x or above and enabled insecure security/, 0)
   end
 
+  test 'Pass Elasticsearch and client library are same' do
+    config = %{
+      @log_level warn
+      validate_client_version true
+    }
+    assert_nothing_raised do
+      driver(config, 6, "\"6.1.0\"").instance
+    end
+  end
+
+  test 'Detected Elasticsearch and client library mismatch' do
+    config = %{
+      @log_level warn
+      validate_client_version true
+    }
+    assert_raise_message(/Detected ES 7 but you use ES client 5.0/) do
+      driver(config, 7, "\"5.0.5\"").instance
+    end
+  end
+
   test 'lack of tag in chunk_keys' do
     assert_raise_message(/'tag' in chunk_keys is required./) do
       driver(Fluent::Config::Element.new(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 2.11.6
+  version: 2.11.7
 platform: ruby
 authors:
 - diogo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-26 00:00:00.000000000 Z
+date: 2018-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd