logstash-input-elasticsearch 4.22.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b69fd432de3b9ad93091c9e1ada1469965f039f302ec8e4fa68c51f30954445
-  data.tar.gz: 20f9f41949e985e1eca21d8370e704260c780c88659536b496d9c405adcf4838
+  metadata.gz: b34b6c6d814152e88f320525ea0bb80bbf1e63ff962e022aaac0a2385dd087b6
+  data.tar.gz: d142df9148ad69bf838d62badeec71382118741938db61e6aad0676bdb918a37
 SHA512:
-  metadata.gz: 0b22f9d333bd434006a11e3d8ca15a082bc57365bda305897776b625c9d19b1059533f3b1af97b958e11966bb2f3951f35c928345b0fd03a41e299588088061e
-  data.tar.gz: 4b3cac772e4ea9d4586923dee83e1e626efffacbfbda02348dc2e09cf704c04011a1cfec5146ce490997c05bdaa62f9206ab2c2de3d3224e8dbe7d0f649c35b2
+  metadata.gz: 19b2b1325ded83b5b93966365f855f104ba1881f2c991ffdbe92216e08d12d18a7b3ddd4a14d755f6d55c85c98e00d12ca566188c63706d6db1f0aa5b085048b
+  data.tar.gz: ff5de17e75281d8ddd0be70167f2c4dee0a90eef328c7e486b704e79fe10db7b7108b733f77438386a7abb18d504efbef5aaf7b0f34a6c8edd62791640514b7b

data/CHANGELOG.md

@@ -1,15 +1,10 @@
-## 4.22.0
-  - Add "cursor"-like index tracking [#205](https://github.com/logstash-plugins/logstash-input-elasticsearch/pull/205)
-
-## 4.21.2
-  - Add elastic-transport client support used in elasticsearch-ruby 8.x [#225](https://github.com/logstash-plugins/logstash-input-elasticsearch/pull/225)
-
-## 4.21.1
-  - Fix: prevent plugin crash when hits contain illegal structure [#183](https://github.com/logstash-plugins/logstash-input-elasticsearch/pull/183)
-    - When a hit cannot be converted to an event, the input now emits an event tagged with `_elasticsearch_input_failure` with an `[event][original]` containing a JSON-encoded string representation of the entire hit.
-
-## 4.21.0
-  - Add support for custom headers [#217](https://github.com/logstash-plugins/logstash-input-elasticsearch/pull/217)
+## 5.0.0
+  - SSL settings that were marked deprecated in version `4.17.0` are now marked obsolete, and will prevent the plugin from starting.
+  - These settings are:
+    - `ssl`, which should bre replaced by `ssl_enabled`
+    - `ca_file`, which should bre replaced by `ssl_certificate_authorities`
+    - `ssl_certificate_verification`, which should bre replaced by `ssl_verification_mode`
+    - [#213](https://github.com/logstash-plugins/logstash-input-elasticsearch/pull/213)
 
 ## 4.20.5
   - Add `x-elastic-product-origin` header to Elasticsearch requests [#211](https://github.com/logstash-plugins/logstash-input-elasticsearch/pull/211)

data/docs/index.asciidoc

@@ -48,7 +48,7 @@ This would create an Elasticsearch query with the following format:
       "sort": [ "_doc" ]
     }'
 
-[id="plugins-{type}s-{plugin}-scheduling"]
+
 ==== Scheduling
 
 Input from this plugin can be scheduled to run periodically according to a specific
@@ -93,147 +93,16 @@ The plugin logs a warning when ECS is enabled and `target` isn't set.
 
 TIP: Set the `target` option to avoid potential schema conflicts.
 
-[id="plugins-{type}s-{plugin}-failure-handling"]
-==== Failure handling
-
-When this input plugin cannot create a structured `Event` from a hit result, it will instead create an `Event` that is tagged with `_elasticsearch_input_failure` whose `[event][original]` is a JSON-encoded string representation of the entire hit.
-
-Common causes are:
-
- - When the hit result contains top-level fields that are {logstash-ref}/processing.html#reserved-fields[reserved in Logstash] but do not have the expected shape. Use the <<plugins-{type}s-{plugin}-target>> directive to avoid conflicts with the top-level namespace.
- - When <<plugins-{type}s-{plugin}-docinfo>> is enabled and the docinfo fields cannot be merged into the hit result. Combine <<plugins-{type}s-{plugin}-target>> and <<plugins-{type}s-{plugin}-docinfo_target>> to avoid conflict.
-
-[id="plugins-{type}s-{plugin}-cursor"]
-==== Tracking a field's value across runs
-
-.Technical Preview: Tracking a field's value
-****
-The feature that allows tracking a field's value across runs is in _Technical Preview_.
-Configuration options and implementation details are subject to change in minor releases without being preceded by deprecation warnings.
-****
-
-Some uses cases require tracking the value of a particular field between two jobs.
-Examples include:
-
-* avoiding the need to re-process the entire result set of a long query after an unplanned restart
-* grabbing only new data from an index instead of processing the entire set on each job.
-
-The Elasticsearch input plugin provides the <<plugins-{type}s-{plugin}-tracking_field>> and <<plugins-{type}s-{plugin}-tracking_field_seed>> options.
-When <<plugins-{type}s-{plugin}-tracking_field>> is set, the plugin records the value of that field for the last document retrieved in a run into
-a file. 
-(The file location defaults to <<plugins-{type}s-{plugin}-last_run_metadata_path>>.)
-
-You can then inject this value in the query using the placeholder `:last_value`. 
-The value will be injected into the query before execution, and then updated after the query completes if new data was found.
-
-This feature works best when:
-
-* the query sorts by the tracking field,
-* the timestamp field is added by {es}, and
-* the field type has enough resolution so that two events are unlikely to have the same value.
-
-Consider using a tracking field whose type is https://www.elastic.co/guide/en/elasticsearch/reference/current/date_nanos.html[date nanoseconds].
-If the tracking field is of this data type, you can use an extra placeholder called `:present` to inject the nano-second based value of "now-30s".
-This placeholder is useful as the right-hand side of a range filter, allowing the collection of
-new data but leaving partially-searchable bulk request data to the next scheduled job.
-
-[id="plugins-{type}s-{plugin}-tracking-sample"]
-===== Sample configuration: Track field value across runs
-
-This section contains a series of steps to help you set up the "tailing" of data being written to a set of indices, using a date nanosecond field added by an Elasticsearch ingest pipeline and the `tracking_field` capability of this plugin.
-
-. Create ingest pipeline that adds Elasticsearch's `_ingest.timestamp` field to the documents as `event.ingested`:
-+
-[source, json]
-    PUT _ingest/pipeline/my-pipeline
-    {
-      "processors": [
-              {
-            "script": {
-              "lang": "painless",
-              "source": "ctx.putIfAbsent(\"event\", [:]); ctx.event.ingested = metadata().now.format(DateTimeFormatter.ISO_INSTANT);"
-            }
-          }
-      ]
-    }
-
-[start=2]
-. Create an index mapping where the tracking field is of date nanosecond type and invokes the defined pipeline:
-+
-[source, json]
-    PUT /_template/my_template
-    {
-      "index_patterns": ["test-*"],
-      "settings": {
-        "index.default_pipeline": "my-pipeline",
-      },
-      "mappings": {
-        "properties": {
-          "event": {
-            "properties": {
-              "ingested": {
-                "type": "date_nanos",
-                "format": "strict_date_optional_time_nanos"
-              }
-            }
-          }
-        }
-      }
-    }
-
-[start=3]
-. Define a query that looks at all data of the indices, sorted by the tracking field, and with a range filter since the last value seen until present:
-+
-[source,json]
-{
-  "query": {
-    "range": {
-      "event.ingested": {
-        "gt": ":last_value",
-        "lt": ":present"
-      }
-    }
-  },
-  "sort": [
-    {
-      "event.ingested": {
-        "order": "asc",
-        "format": "strict_date_optional_time_nanos",
-        "numeric_type": "date_nanos"
-      }
-    }
-  ]
-}
-
-[start=4]
-. Configure the Elasticsearch input to query the indices with the query defined above, every minute, and track the `event.ingested` field:
-+
-[source, ruby]
-    input {
-      elasticsearch {
-        id => tail_test_index
-        hosts => [ 'https://..']
-        api_key => '....'
-        index => 'test-*'
-        query => '{ "query": { "range": { "event.ingested": { "gt": ":last_value", "lt": ":present"}}}, "sort": [ { "event.ingested": {"order": "asc", "format": "strict_date_optional_time_nanos", "numeric_type" : "date_nanos" } } ] }'
-        tracking_field => "[event][ingested]"
-        slices => 5 # optional use of slices to speed data processing, should be equal to or less than number of primary shards
-        schedule => '* * * * *' # every minute
-        schedule_overlap => false # don't accumulate jobs if one takes longer than 1 minute
-      }
-    }
-
-With this sample setup, new documents are indexed into a `test-*` index.
-The next scheduled run:
-
-* selects all new documents since the last observed value of the tracking field,
-* uses {ref}/point-in-time-api.html#point-in-time-api[Point in time (PIT)] + {ref}/paginate-search-results.html#search-after[Search after] to paginate through all the data, and
-* updates the value of the field at the end of the pagination.
-
 [id="plugins-{type}s-{plugin}-options"]
 ==== Elasticsearch Input configuration options
 
-This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> and the <<plugins-{type}s-{plugin}-deprecated-options>> described later.
+This plugin supports these configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+NOTE: As of version `5.0.0` of this plugin, a number of previously deprecated settings related to SSL have been removed.
+Please check out <<plugins-{type}s-{plugin}-obsolete-options>> for details.
+
+NOTE: As of version `5.0.0` of this plugin, a number of previously deprecated settings related to SSL have been removed.
+Please check out <<plugins-{type}s-{plugin}-obsolete-options>> for details.
 
 [cols="<,<,<",options="header",]
 |=======================================================================
@@ -250,14 +119,12 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-ecs_compatibility>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-hosts>> |<<array,array>>|No
 | <<plugins-{type}s-{plugin}-index>> |<<string,string>>|No
-| <<plugins-{type}s-{plugin}-last_run_metadata_path>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
 | <<plugins-{type}s-{plugin}-proxy>> |<<uri,uri>>|No
 | <<plugins-{type}s-{plugin}-query>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-response_type>> |<<string,string>>, one of `["hits","aggregations"]`|No
 | <<plugins-{type}s-{plugin}-request_timeout_seconds>> | <<number,number>>|No
 | <<plugins-{type}s-{plugin}-schedule>> |<<string,string>>|No
-| <<plugins-{type}s-{plugin}-schedule_overlap>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-scroll>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-search_api>> |<<string,string>>, one of `["auto", "search_after", "scroll"]`|No
 | <<plugins-{type}s-{plugin}-size>> |<<number,number>>|No
@@ -277,8 +144,6 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-ssl_verification_mode>> |<<string,string>>, one of `["full", "none"]`|No
 | <<plugins-{type}s-{plugin}-socket_timeout_seconds>> | <<number,number>>|No
 | <<plugins-{type}s-{plugin}-target>> | {logstash-ref}/field-references-deepdive.html[field reference] | No
-| <<plugins-{type}s-{plugin}-tracking_field>> |<<string,string>>|No
-| <<plugins-{type}s-{plugin}-tracking_field_seed>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-retries>> | <<number,number>>|No
 | <<plugins-{type}s-{plugin}-user>> |<<string,string>>|No
 |=======================================================================
@@ -458,17 +323,6 @@ Check out {ref}/api-conventions.html#api-multi-index[Multi Indices
 documentation] in the Elasticsearch documentation for info on
 referencing multiple indices.
 
-[id="plugins-{type}s-{plugin}-last_run_metadata_path"]
-===== `last_run_metadata_path`
-
-  * Value type is <<string,string>>
-  * There is no default value for this setting.
-
-The path to store the last observed value of the tracking field, when used.
-By default this file is stored as `<path.data>/plugins/inputs/elasticsearch/<pipeline_id>/last_run_value`.
-
-This setting should point to file, not a directory, and Logstash must have read+write access to this file.
-
 [id="plugins-{type}s-{plugin}-password"]
 ===== `password`
 
@@ -549,19 +403,6 @@ for example: "* * * * *" (execute query every minute, on the minute)
 There is no schedule by default. If no schedule is given, then the statement is run
 exactly once.
 
-[id="plugins-{type}s-{plugin}-schedule_overlap"]
-===== `schedule_overlap`
-
-  * Value type is <<boolean,boolean>>
-  * Default value is `true`
-
-Whether to allow queuing of a scheduled run if a run is occurring.
-While this is ideal for ensuring a new run happens immediately after the previous on finishes if there
-is a lot of work to do, but given the queue is unbounded it may lead to an out of memory over long periods of time
-if the queue grows continuously.
-
-When in doubt, set `schedule_overlap` to false (it may become the default value in the future).
-
 [id="plugins-{type}s-{plugin}-scroll"]
 ===== `scroll`
 
@@ -654,6 +495,8 @@ Enable SSL/TLS secured communication to Elasticsearch cluster.
 Leaving this unspecified will use whatever scheme is specified in the URLs listed in <<plugins-{type}s-{plugin}-hosts>> or extracted from the <<plugins-{type}s-{plugin}-cloud_id>>.
 If no explicit protocol is specified plain HTTP will be used.
 
+When not explicitly set, SSL will be automatically enabled if any of the specified hosts use HTTPS.
+
 [id="plugins-{type}s-{plugin}-ssl_key"]
 ===== `ssl_key`
   * Value type is <<path,path>>
@@ -772,28 +615,6 @@ When the `target` is set to a field reference, the `_source` of the hit is place
 This option can be useful to avoid populating unknown fields when a downstream schema such as ECS is enforced.
 It is also possible to target an entry in the event's metadata, which will be available during event processing but not exported to your outputs (e.g., `target \=> "[@metadata][_source]"`).
 
-[id="plugins-{type}s-{plugin}-tracking_field"]
-===== `tracking_field`
-
-* Value type is <<string,string>>
-* There is no default value for this setting.
-
-Which field from the last event of a previous run will be used a cursor value for the following run.
-The value of this field is injected into each query if the query uses the placeholder `:last_value`.
-For the first query after a pipeline is started, the value used is either read from <<plugins-{type}s-{plugin}-last_run_metadata_path>> file,
-or taken from <<plugins-{type}s-{plugin}-tracking_field_seed>> setting.
-
-Note: The tracking value is updated after each page is read and at the end of each Point in Time. In case of a crash the last saved value will be used so some duplication of data can occur. For this reason the use of unique document IDs for each event is recommended in the downstream destination.
-
-[id="plugins-{type}s-{plugin}-tracking_field_seed"]
-===== `tracking_field_seed`
-
-* Value type is <<string,string>>
-* Default value is `"1970-01-01T00:00:00.000000000Z"`
-
-The starting value for the <<plugins-{type}s-{plugin}-tracking_field>> if there is no <<plugins-{type}s-{plugin}-last_run_metadata_path>> already.
-This field defaults to the nanosecond precision ISO8601 representation of `epoch`, or "1970-01-01T00:00:00.000000000Z", given nano-second precision timestamps are the
-most reliable data format to use for this feature.
 
 [id="plugins-{type}s-{plugin}-user"]
 ===== `user`
@@ -806,56 +627,21 @@ option when authenticating to the Elasticsearch server. If set to an
 empty string authentication will be disabled.
 
 
-[id="plugins-{type}s-{plugin}-deprecated-options"]
-==== Elasticsearch Input deprecated configuration options
+[id="plugins-{type}s-{plugin}-obsolete-options"]
+==== Elasticsearch Input Obsolete Configuration Options
 
-This plugin supports the following deprecated configurations.
+WARNING: As of version `5.0.0` of this plugin, some configuration options have been replaced.
+The plugin will fail to start if it contains any of these obsolete options.
 
-WARNING: Deprecated options are subject to removal in future releases.
 
-[cols="<,<,<",options="header",]
+[cols="<,<",options="header",]
 |=======================================================================
-|Setting|Input type|Replaced by
-| <<plugins-{type}s-{plugin}-ca_file>> |a valid filesystem path|<<plugins-{type}s-{plugin}-ssl_certificate_authorities>>
-| <<plugins-{type}s-{plugin}-ssl>> |<<boolean,boolean>>|<<plugins-{type}s-{plugin}-ssl_enabled>>
-| <<plugins-{type}s-{plugin}-ssl_certificate_verification>> |<<boolean,boolean>>|<<plugins-{type}s-{plugin}-ssl_verification_mode>>
+|Setting|Replaced by
+| ca_file | <<plugins-{type}s-{plugin}-ssl_certificate_authorities>>
+| ssl | <<plugins-{type}s-{plugin}-ssl_enabled>>
+| ssl_certificate_verification | <<plugins-{type}s-{plugin}-ssl_verification_mode>>
 |=======================================================================
 
-[id="plugins-{type}s-{plugin}-ca_file"]
-===== `ca_file`
-deprecated[4.17.0, Replaced by <<plugins-{type}s-{plugin}-ssl_certificate_authorities>>]
-
-* Value type is <<path,path>>
-* There is no default value for this setting.
-
-SSL Certificate Authority file in PEM encoded format, must also include any chain certificates as necessary.
-
-[id="plugins-{type}s-{plugin}-ssl"]
-===== `ssl`
-deprecated[4.17.0, Replaced by <<plugins-{type}s-{plugin}-ssl_enabled>>]
-
-* Value type is <<boolean,boolean>>
-* Default value is `false`
-
-If enabled, SSL will be used when communicating with the Elasticsearch
-server (i.e. HTTPS will be used instead of plain HTTP).
-
-
-[id="plugins-{type}s-{plugin}-ssl_certificate_verification"]
-===== `ssl_certificate_verification`
-deprecated[4.17.0, Replaced by <<plugins-{type}s-{plugin}-ssl_verification_mode>>]
-
-* Value type is <<boolean,boolean>>
-* Default value is `true`
-
-Option to validate the server's certificate. Disabling this severely compromises security.
-When certificate validation is disabled, this plugin implicitly trusts the machine
-resolved at the given address without validating its proof-of-identity.
-In this scenario, the plugin can transmit credentials to or process data from an untrustworthy
-man-in-the-middle or other compromised infrastructure.
-More information on the importance of certificate verification:
-**https://www.cs.utexas.edu/~shmat/shmat_ccs12.pdf**.
-
 [id="plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]
 

data/lib/logstash/inputs/elasticsearch/aggregation.rb

@@ -12,9 +12,14 @@ module LogStash
           @client = client
           @plugin_params = plugin.params
 
-          @index = @plugin_params["index"]
           @size = @plugin_params["size"]
+          @query = @plugin_params["query"]
           @retries = @plugin_params["retries"]
+          @agg_options = {
+            :index => @plugin_params["index"],
+            :size  => 0
+          }.merge(:body => @query)
+
           @plugin = plugin
         end
 
@@ -28,18 +33,10 @@ module LogStash
           false
         end
 
-        def aggregation_options(query_object)
-          {
-            :index => @index,
-            :size => 0,
-            :body => query_object
-          }
-        end
-
-        def do_run(output_queue, query_object)
+        def do_run(output_queue)
           logger.info("Aggregation starting")
           r = retryable(AGGREGATION_JOB) do
-            @client.search(aggregation_options(query_object))
+            @client.search(@agg_options)
           end
           @plugin.push_hit(r, output_queue, 'aggregations') if r
         end

data/lib/logstash/inputs/elasticsearch/paginated_search.rb

@@ -21,10 +21,9 @@ module LogStash
           @pipeline_id = plugin.pipeline_id
         end
 
-        def do_run(output_queue, query)
-          @query = query
-
+        def do_run(output_queue)
           return retryable_search(output_queue) if @slices.nil? || @slices <= 1
+
           retryable_slice_search(output_queue)
         end
 
@@ -123,13 +122,6 @@ module LogStash
         PIT_JOB = "create point in time (PIT)"
         SEARCH_AFTER_JOB = "search_after paginated search"
 
-        attr_accessor :cursor_tracker
-
-        def do_run(output_queue, query)
-          super(output_queue, query)
-          @cursor_tracker.checkpoint_cursor(intermediate: false) if @cursor_tracker
-        end
-
         def pit?(id)
           !!id&.is_a?(String)
         end
@@ -200,8 +192,6 @@ module LogStash
             end
           end
 
-          @cursor_tracker.checkpoint_cursor(intermediate: true) if @cursor_tracker
-
           logger.info("Query completed", log_details)
         end