logstash-output-elasticsearch 10.8.3-java → 11.0.2-java

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

@@ -4,21 +4,12 @@ module LogStash; module Outputs; class ElasticSearch
     ILM_POLICY_PATH = "default-ilm-policy.json"
 
     def setup_ilm
-      return unless ilm_in_use?
       logger.warn("Overwriting supplied index #{@index} with rollover alias #{@ilm_rollover_alias}") unless default_index?(@index)
       @index = @ilm_rollover_alias
       maybe_create_rollover_alias
       maybe_create_ilm_policy
     end
 
-    def default_rollover_alias?(rollover_alias)
-      rollover_alias == default_ilm_rollover_alias
-    end
-
-    def ilm_alias_set?
-      default_index?(@index) || !default_rollover_alias?(@ilm_rollover_alias)
-    end
-
     def ilm_in_use?
       return @ilm_actually_enabled if defined?(@ilm_actually_enabled)
       @ilm_actually_enabled =
@@ -46,6 +37,12 @@ module LogStash; module Outputs; class ElasticSearch
         end
     end
 
+    private
+
+    def ilm_alias_set?
+      default_index?(@index) || !default_rollover_alias?(@ilm_rollover_alias)
+    end
+
     def ilm_on_by_default?
       maximum_seen_major_version >= 7
     end
@@ -73,19 +70,21 @@ module LogStash; module Outputs; class ElasticSearch
       end
     end
 
-    private
-
     def default_index?(index)
       index == @default_index
     end
 
+    def default_rollover_alias?(rollover_alias)
+      rollover_alias == default_ilm_rollover_alias
+    end
+
     def ilm_policy_default?
       ilm_policy == LogStash::Outputs::ElasticSearch::DEFAULT_POLICY
     end
 
     def maybe_create_ilm_policy
       if ilm_policy_default?
-          client.ilm_policy_put(ilm_policy, policy_payload) unless client.ilm_policy_exists?(ilm_policy)
+        client.ilm_policy_put(ilm_policy, policy_payload) unless client.ilm_policy_exists?(ilm_policy)
       else
         raise LogStash::ConfigurationError, "The specified ILM policy #{ilm_policy} does not exist on your Elasticsearch instance" unless client.ilm_policy_exists?(ilm_policy)
       end

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

@@ -7,41 +7,44 @@ module LogStash; module Outputs; class ElasticSearch
 
     # Figure out if the provided license is appropriate or not
     # The appropriate_license? methods is the method called from LogStash::Outputs::ElasticSearch::HttpClient::Pool#healthcheck!
+    # @param pool
     # @param url [LogStash::Util::SafeURI] ES node URL
-    # @param license [Hash] ES node deserialized licence document
     # @return [Boolean] true if provided license is deemed appropriate
     def appropriate_license?(pool, url)
-      return true if oss?
-
-      license = pool.get_license(url)
-      if valid_es_license?(license)
+      license = extract_license(pool.get_license(url))
+      case license_status(license)
+      when 'active'
         true
-      else
-        # As this version is to be shipped with Logstash 7.x we won't mark the connection as unlicensed
-        #
-        #  @logger.error("Cannot connect to the Elasticsearch cluster configured in the Elasticsearch output. Logstash requires the default distribution of Elasticsearch. Please update to the default distribution of Elasticsearch for full access to all free features, or switch to the OSS distribution of Logstash.", :url => url.sanitized.to_s)
-        #  meta[:state] = :unlicensed
-        #
-        # Instead we'll log a deprecation warning and mark it as alive:
-        #
-        log_license_deprecation_warn(url)
+      when nil
+        warn_no_license(url)
+        false
+      else # 'invalid', 'expired'
+        warn_invalid_license(url, license)
         true
       end
     end
 
-    # Note that oss? could be private but is used by the Pool specs
-    def oss?
-      LogStash::OSS
+    NO_LICENSE = {}.freeze
+    private_constant :NO_LICENSE
+
+    def extract_license(license)
+      license.fetch("license", NO_LICENSE)
+    end
+
+    def license_status(license)
+      license.fetch("status", nil)
     end
 
-    # Note that valid_es_license? could be private but is used by the Pool specs
-    def valid_es_license?(license)
-      license.fetch("license", {}).fetch("status", nil) == "active"
+    private
+
+    def warn_no_license(url)
+      @logger.error("Could not connect to a compatible version of Elasticsearch", url: url.sanitized.to_s)
     end
 
-    # Note that log_license_deprecation_warn could be private but is used by the Pool specs
-    def log_license_deprecation_warn(url)
-      @logger.warn("DEPRECATION WARNING: Connecting to an OSS distribution of Elasticsearch using the default distribution of Logstash will stop working in Logstash 8.0.0. Please upgrade to the default distribution of Elasticsearch, or use the OSS distribution of Logstash", :url => url.sanitized.to_s)
+    def warn_invalid_license(url, license)
+      @logger.warn("Elasticsearch license is not active, please check Elasticsearch’s licensing information",
+                   url: url.sanitized.to_s, license: license)
     end
+
   end
 end; end; end

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

@@ -13,10 +13,8 @@ module LogStash; module Outputs; class ElasticSearch
       end
 
       add_ilm_settings_to_template(plugin, template) if plugin.ilm_in_use?
-      plugin.logger.info("Attempting to install template", :manage_template => template)
+      plugin.logger.debug("Attempting to install template", template: template)
       install(plugin.client, template_name(plugin), template, plugin.template_overwrite)
-    rescue => e
-      plugin.logger.error("Failed to install template.", :message => e.message, :class => e.class.name, :backtrace => e.backtrace)
     end
 
     private
@@ -38,7 +36,7 @@ module LogStash; module Outputs; class ElasticSearch
       template['index_patterns'] = "#{plugin.ilm_rollover_alias}-*"
       settings = template_settings(plugin, template)
       if settings && (settings['index.lifecycle.name'] || settings['index.lifecycle.rollover_alias'])
-        plugin.logger.info("Overwriting index lifecycle name and rollover alias as ILM is enabled.")
+        plugin.logger.info("Overwriting index lifecycle name and rollover alias as ILM is enabled")
       end
       settings.update({ 'index.lifecycle.name' => plugin.ilm_policy, 'index.lifecycle.rollover_alias' => plugin.ilm_rollover_alias})
     end
@@ -61,7 +59,7 @@ module LogStash; module Outputs; class ElasticSearch
     end
 
     def self.read_template_file(template_path)
-      raise ArgumentError, "Template file '#{template_path}' could not be found!" unless ::File.exists?(template_path)
+      raise ArgumentError, "Template file '#{template_path}' could not be found" unless ::File.exists?(template_path)
       template_data = ::IO.read(template_path)
       LogStash::Json.load(template_data)
     end

data/lib/logstash/plugin_mixins/elasticsearch/api_configs.rb

@@ -5,159 +5,163 @@ module LogStash; module PluginMixins; module ElasticSearch
 
     DEFAULT_HOST = ::LogStash::Util::SafeURI.new("//127.0.0.1")
 
-    def self.included(mod)
-      # Username to authenticate to a secure Elasticsearch cluster
-      mod.config :user, :validate => :string
-      # Password to authenticate to a secure Elasticsearch cluster
-      mod.config :password, :validate => :password
-
-      # Authenticate using Elasticsearch API key.
-      # format is id:api_key (as returned by https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html[Create API key])
-      mod.config :api_key, :validate => :password
-
-      # Cloud authentication string ("<username>:<password>" format) is an alternative for the `user`/`password` configuration.
-      #
-      # For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html#_cloud_auth[cloud documentation]
-      mod.config :cloud_auth, :validate => :password
-
-      # The document ID for the index. Useful for overwriting existing entries in
-      # Elasticsearch with the same ID.
-      mod.config :document_id, :validate => :string
-
-      # HTTP Path at which the Elasticsearch server lives. Use this if you must run Elasticsearch behind a proxy that remaps
-      # the root path for the Elasticsearch HTTP API lives.
-      # Note that if you use paths as components of URLs in the 'hosts' field you may
-      # not also set this field. That will raise an error at startup
-      mod.config :path, :validate => :string
-
-      # HTTP Path to perform the _bulk requests to
-      # this defaults to a concatenation of the path parameter and "_bulk"
-      mod.config :bulk_path, :validate => :string
-
-      # Pass a set of key value pairs as the URL query string. This query string is added
-      # to every host listed in the 'hosts' configuration. If the 'hosts' list contains
-      # urls that already have query strings, the one specified here will be appended.
-      mod.config :parameters, :validate => :hash
-
-      # Enable SSL/TLS secured communication to Elasticsearch cluster. Leaving this unspecified will use whatever scheme
-      # is specified in the URLs listed in 'hosts'. If no explicit protocol is specified plain HTTP will be used.
-      # If SSL is explicitly disabled here the plugin will refuse to start if an HTTPS URL is given in 'hosts'
-      mod.config :ssl, :validate => :boolean
-
-      # Option to validate the server's certificate. Disabling this severely compromises security.
-      # For more information on disabling certificate verification please read
-      # https://www.cs.utexas.edu/~shmat/shmat_ccs12.pdf
-      mod.config :ssl_certificate_verification, :validate => :boolean, :default => true
-
-      # The .cer or .pem file to validate the server's certificate
-      mod.config :cacert, :validate => :path
-
-      # The JKS truststore to validate the server's certificate.
-      # Use either `:truststore` or `:cacert`
-      mod.config :truststore, :validate => :path
-
-      # Set the truststore password
-      mod.config :truststore_password, :validate => :password
-
-      # The keystore used to present a certificate to the server.
-      # It can be either .jks or .p12
-      mod.config :keystore, :validate => :path
-
-      # Set the keystore password
-      mod.config :keystore_password, :validate => :password
-
-      # This setting asks Elasticsearch for the list of all cluster nodes and adds them to the hosts list.
-      # Note: This will return ALL nodes with HTTP enabled (including master nodes!). If you use
-      # this with master nodes, you probably want to disable HTTP on them by setting
-      # `http.enabled` to false in their elasticsearch.yml. You can either use the `sniffing` option or
-      # manually enter multiple Elasticsearch hosts using the `hosts` parameter.
-      mod.config :sniffing, :validate => :boolean, :default => false
-
-      # How long to wait, in seconds, between sniffing attempts
-      mod.config :sniffing_delay, :validate => :number, :default => 5
-
-      # HTTP Path to be used for the sniffing requests
-      # the default value is computed by concatenating the path value and "_nodes/http"
-      # if sniffing_path is set it will be used as an absolute path
-      # do not use full URL here, only paths, e.g. "/sniff/_nodes/http"
-      mod.config :sniffing_path, :validate => :string
-
-      # Set the address of a forward HTTP proxy.
-      # This used to accept hashes as arguments but now only accepts
-      # arguments of the URI type to prevent leaking credentials.
-      mod.config :proxy, :validate => :uri # but empty string is allowed
-
-      # Set the timeout, in seconds, for network operations and requests sent Elasticsearch. If
-      # a timeout occurs, the request will be retried.
-      mod.config :timeout, :validate => :number, :default => 60
-
-      # Set the Elasticsearch errors in the whitelist that you don't want to log.
-      # A useful example is when you want to skip all 409 errors
-      # which are `document_already_exists_exception`.
-      mod.config :failure_type_logging_whitelist, :validate => :array, :default => []
-
-      # While the output tries to reuse connections efficiently we have a maximum.
-      # This sets the maximum number of open connections the output will create.
-      # Setting this too low may mean frequently closing / opening connections
-      # which is bad.
-      mod.config :pool_max, :validate => :number, :default => 1000
-
-      # While the output tries to reuse connections efficiently we have a maximum per endpoint.
-      # This sets the maximum number of open connections per endpoint the output will create.
-      # Setting this too low may mean frequently closing / opening connections
-      # which is bad.
-      mod.config :pool_max_per_route, :validate => :number, :default => 100
-
-      # HTTP Path where a HEAD request is sent when a backend is marked down
-      # the request is sent in the background to see if it has come back again
-      # before it is once again eligible to service requests.
-      # If you have custom firewall rules you may need to change this
-      mod.config :healthcheck_path, :validate => :string
-
-      # How frequently, in seconds, to wait between resurrection attempts.
-      # Resurrection is the process by which backend endpoints marked 'down' are checked
-      # to see if they have come back to life
-      mod.config :resurrect_delay, :validate => :number, :default => 5
-
-      # How long to wait before checking if the connection is stale before executing a request on a connection using keepalive.
-      # You may want to set this lower, if you get connection errors regularly
-      # Quoting the Apache commons docs (this client is based Apache Commmons):
-      # 'Defines period of inactivity in milliseconds after which persistent connections must
-      # be re-validated prior to being leased to the consumer. Non-positive value passed to
-      # this method disables connection validation. This check helps detect connections that
-      # have become stale (half-closed) while kept inactive in the pool.'
-      # See https://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/impl/conn/PoolingHttpClientConnectionManager.html#setValidateAfterInactivity(int)[these docs for more info]
-      mod.config :validate_after_inactivity, :validate => :number, :default => 10000
-
-      # Enable gzip compression on requests. Note that response compression is on by default for Elasticsearch v5.0 and beyond
-      mod.config :http_compression, :validate => :boolean, :default => false
-
-      # Custom Headers to send on each request to elasticsearch nodes
-      mod.config :custom_headers, :validate => :hash, :default => {}
-
-      # Sets the host(s) of the remote instance. If given an array it will load balance requests across the hosts specified in the `hosts` parameter.
-      # Remember the `http` protocol uses the http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html#modules-http[http] address (eg. 9200, not 9300).
-      #     `"127.0.0.1"`
-      #     `["127.0.0.1:9200","127.0.0.2:9200"]`
-      #     `["http://127.0.0.1"]`
-      #     `["https://127.0.0.1:9200"]`
-      #     `["https://127.0.0.1:9200/mypath"]` (If using a proxy on a subpath)
-      # It is important to exclude http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html[dedicated master nodes] from the `hosts` list
-      # to prevent LS from sending bulk requests to the master nodes.  So this parameter should only reference either data or client nodes in Elasticsearch.
-      #
-      # Any special characters present in the URLs here MUST be URL escaped! This means `#` should be put in as `%23` for instance.
-      mod.config :hosts, :validate => :uri, :default => [ DEFAULT_HOST ], :list => true
-
-      # Cloud ID, from the Elastic Cloud web console. If set `hosts` should not be used.
-      #
-      # For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html#_cloud_id[cloud documentation]
-      mod.config :cloud_id, :validate => :string
-
-      # Set initial interval in seconds between bulk retries. Doubled on each retry up to `retry_max_interval`
-      mod.config :retry_initial_interval, :validate => :number, :default => 2
-
-      # Set max interval in seconds between bulk retries.
-      mod.config :retry_max_interval, :validate => :number, :default => 64
+    CONFIG_PARAMS = {
+        # Username to authenticate to a secure Elasticsearch cluster
+        :user => { :validate => :string },
+        # Password to authenticate to a secure Elasticsearch cluster
+        :password => { :validate => :password },
+
+        # Authenticate using Elasticsearch API key.
+        # format is id:api_key (as returned by https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html[Create API key])
+        :api_key => { :validate => :password },
+
+        # Cloud authentication string ("<username>:<password>" format) is an alternative for the `user`/`password` configuration.
+        #
+        # For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html#_cloud_auth[cloud documentation]
+        :cloud_auth => { :validate => :password },
+
+        # The document ID for the index. Useful for overwriting existing entries in
+        # Elasticsearch with the same ID.
+        :document_id => { :validate => :string },
+
+        # HTTP Path at which the Elasticsearch server lives. Use this if you must run Elasticsearch behind a proxy that remaps
+        # the root path for the Elasticsearch HTTP API lives.
+        # Note that if you use paths as components of URLs in the 'hosts' field you may
+        # not also set this field. That will raise an error at startup
+        :path => { :validate => :string },
+
+        # HTTP Path to perform the _bulk requests to
+        # this defaults to a concatenation of the path parameter and "_bulk"
+        :bulk_path => { :validate => :string },
+
+        # Pass a set of key value pairs as the URL query string. This query string is added
+        # to every host listed in the 'hosts' configuration. If the 'hosts' list contains
+        # urls that already have query strings, the one specified here will be appended.
+        :parameters => { :validate => :hash },
+
+        # Enable SSL/TLS secured communication to Elasticsearch cluster. Leaving this unspecified will use whatever scheme
+        # is specified in the URLs listed in 'hosts'. If no explicit protocol is specified plain HTTP will be used.
+        # If SSL is explicitly disabled here the plugin will refuse to start if an HTTPS URL is given in 'hosts'
+        :ssl => { :validate => :boolean },
+
+        # Option to validate the server's certificate. Disabling this severely compromises security.
+        # For more information on disabling certificate verification please read
+        # https://www.cs.utexas.edu/~shmat/shmat_ccs12.pdf
+        :ssl_certificate_verification => { :validate => :boolean, :default => true },
+
+        # The .cer or .pem file to validate the server's certificate
+        :cacert => { :validate => :path },
+
+        # The JKS truststore to validate the server's certificate.
+        # Use either `:truststore` or `:cacert`
+        :truststore => { :validate => :path },
+
+        # Set the truststore password
+        :truststore_password => { :validate => :password },
+
+        # The keystore used to present a certificate to the server.
+        # It can be either .jks or .p12
+        :keystore => { :validate => :path },
+
+        # Set the keystore password
+        :keystore_password => { :validate => :password },
+
+        # This setting asks Elasticsearch for the list of all cluster nodes and adds them to the hosts list.
+        # Note: This will return ALL nodes with HTTP enabled (including master nodes!). If you use
+        # this with master nodes, you probably want to disable HTTP on them by setting
+        # `http.enabled` to false in their elasticsearch.yml. You can either use the `sniffing` option or
+        # manually enter multiple Elasticsearch hosts using the `hosts` parameter.
+        :sniffing => { :validate => :boolean, :default => false },
+
+        # How long to wait, in seconds, between sniffing attempts
+        :sniffing_delay => { :validate => :number, :default => 5 },
+
+        # HTTP Path to be used for the sniffing requests
+        # the default value is computed by concatenating the path value and "_nodes/http"
+        # if sniffing_path is set it will be used as an absolute path
+        # do not use full URL here, only paths, e.g. "/sniff/_nodes/http"
+        :sniffing_path => { :validate => :string },
+
+        # Set the address of a forward HTTP proxy.
+        # This used to accept hashes as arguments but now only accepts
+        # arguments of the URI type to prevent leaking credentials.
+        :proxy => { :validate => :uri }, # but empty string is allowed
+
+        # Set the timeout, in seconds, for network operations and requests sent Elasticsearch. If
+        # a timeout occurs, the request will be retried.
+        :timeout => { :validate => :number, :default => 60 },
+
+        # Set the Elasticsearch errors in the whitelist that you don't want to log.
+        # A useful example is when you want to skip all 409 errors
+        # which are `document_already_exists_exception`.
+        :failure_type_logging_whitelist => { :validate => :array, :default => [] },
+
+        # While the output tries to reuse connections efficiently we have a maximum.
+        # This sets the maximum number of open connections the output will create.
+        # Setting this too low may mean frequently closing / opening connections
+        # which is bad.
+        :pool_max => { :validate => :number, :default => 1000 },
+
+        # While the output tries to reuse connections efficiently we have a maximum per endpoint.
+        # This sets the maximum number of open connections per endpoint the output will create.
+        # Setting this too low may mean frequently closing / opening connections
+        # which is bad.
+        :pool_max_per_route => { :validate => :number, :default => 100 },
+
+        # HTTP Path where a HEAD request is sent when a backend is marked down
+        # the request is sent in the background to see if it has come back again
+        # before it is once again eligible to service requests.
+        # If you have custom firewall rules you may need to change this
+        :healthcheck_path => { :validate => :string },
+
+        # How frequently, in seconds, to wait between resurrection attempts.
+        # Resurrection is the process by which backend endpoints marked 'down' are checked
+        # to see if they have come back to life
+        :resurrect_delay => { :validate => :number, :default => 5 },
+
+        # How long to wait before checking if the connection is stale before executing a request on a connection using keepalive.
+        # You may want to set this lower, if you get connection errors regularly
+        # Quoting the Apache commons docs (this client is based Apache Commmons):
+        # 'Defines period of inactivity in milliseconds after which persistent connections must
+        # be re-validated prior to being leased to the consumer. Non-positive value passed to
+        # this method disables connection validation. This check helps detect connections that
+        # have become stale (half-closed) while kept inactive in the pool.'
+        # See https://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/impl/conn/PoolingHttpClientConnectionManager.html#setValidateAfterInactivity(int)[these docs for more info]
+        :validate_after_inactivity => { :validate => :number, :default => 10000 },
+
+        # Enable gzip compression on requests. Note that response compression is on by default for Elasticsearch v5.0 and beyond
+        :http_compression => { :validate => :boolean, :default => false },
+
+        # Custom Headers to send on each request to elasticsearch nodes
+        :custom_headers => { :validate => :hash, :default => {} },
+
+        # Sets the host(s) of the remote instance. If given an array it will load balance requests across the hosts specified in the `hosts` parameter.
+        # Remember the `http` protocol uses the http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html#modules-http[http] address (eg. 9200, not 9300).
+        #     `"127.0.0.1"`
+        #     `["127.0.0.1:9200","127.0.0.2:9200"]`
+        #     `["http://127.0.0.1"]`
+        #     `["https://127.0.0.1:9200"]`
+        #     `["https://127.0.0.1:9200/mypath"]` (If using a proxy on a subpath)
+        # It is important to exclude http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html[dedicated master nodes] from the `hosts` list
+        # to prevent LS from sending bulk requests to the master nodes.  So this parameter should only reference either data or client nodes in Elasticsearch.
+        #
+        # Any special characters present in the URLs here MUST be URL escaped! This means `#` should be put in as `%23` for instance.
+        :hosts => { :validate => :uri, :default => [ DEFAULT_HOST ], :list => true },
+
+        # Cloud ID, from the Elastic Cloud web console. If set `hosts` should not be used.
+        #
+        # For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html#_cloud_id[cloud documentation]
+        :cloud_id => { :validate => :string },
+
+        # Set initial interval in seconds between bulk retries. Doubled on each retry up to `retry_max_interval`
+        :retry_initial_interval => { :validate => :number, :default => 2 },
+
+        # Set max interval in seconds between bulk retries.
+        :retry_max_interval => { :validate => :number, :default => 64 }
+    }.freeze
+
+    def self.included(base)
+      CONFIG_PARAMS.each { |name, opts| base.config(name, opts) }
     end
   end
 end; end; end