Skip to content

Commit 7c976e1

Browse files
committed
add docs
1 parent d2e3898 commit 7c976e1

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

docs/index.asciidoc

+45
Original file line numberDiff line numberDiff line change
@@ -126,12 +126,14 @@ Please check out <<plugins-{type}s-{plugin}-obsolete-options>> for details.
126126
| <<plugins-{type}s-{plugin}-ecs_compatibility>> |<<string,string>>|No
127127
| <<plugins-{type}s-{plugin}-hosts>> |<<array,array>>|No
128128
| <<plugins-{type}s-{plugin}-index>> |<<string,string>>|No
129+
| <<plugins-{type}s-{plugin}-last_run_metadata_path>> |<<string,string>>|No
129130
| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
130131
| <<plugins-{type}s-{plugin}-proxy>> |<<uri,uri>>|No
131132
| <<plugins-{type}s-{plugin}-query>> |<<string,string>>|No
132133
| <<plugins-{type}s-{plugin}-response_type>> |<<string,string>>, one of `["hits","aggregations"]`|No
133134
| <<plugins-{type}s-{plugin}-request_timeout_seconds>> | <<number,number>>|No
134135
| <<plugins-{type}s-{plugin}-schedule>> |<<string,string>>|No
136+
| <<plugins-{type}s-{plugin}-schedule_overlap>> |<<boolean,boolean>>|No
135137
| <<plugins-{type}s-{plugin}-scroll>> |<<string,string>>|No
136138
| <<plugins-{type}s-{plugin}-search_api>> |<<string,string>>, one of `["auto", "search_after", "scroll"]`|No
137139
| <<plugins-{type}s-{plugin}-size>> |<<number,number>>|No
@@ -151,6 +153,8 @@ Please check out <<plugins-{type}s-{plugin}-obsolete-options>> for details.
151153
| <<plugins-{type}s-{plugin}-ssl_verification_mode>> |<<string,string>>, one of `["full", "none"]`|No
152154
| <<plugins-{type}s-{plugin}-socket_timeout_seconds>> | <<number,number>>|No
153155
| <<plugins-{type}s-{plugin}-target>> | {logstash-ref}/field-references-deepdive.html[field reference] | No
156+
| <<plugins-{type}s-{plugin}-tracking_field>> |<<string,string>>|No
157+
| <<plugins-{type}s-{plugin}-tracking_field_seed>> |<<string,string>>|No
154158
| <<plugins-{type}s-{plugin}-retries>> | <<number,number>>|No
155159
| <<plugins-{type}s-{plugin}-user>> |<<string,string>>|No
156160
|=======================================================================
@@ -330,6 +334,15 @@ Check out {ref}/api-conventions.html#api-multi-index[Multi Indices
330334
documentation] in the Elasticsearch documentation for info on
331335
referencing multiple indices.
332336

337+
[id="plugins-{type}s-{plugin}-last_run_metadata_path"]
338+
===== `last_run_metadata_path`
339+
340+
* Value type is <<string,string>>
341+
* There is no default value for this setting.
342+
343+
The path to store the last observed value of the tracking field, when used.
344+
By default this file is stored as `<path.data>/plugins/inputs/elasticsearch/<pipeline.id>.last_run`.
345+
333346
[id="plugins-{type}s-{plugin}-password"]
334347
===== `password`
335348

@@ -410,6 +423,19 @@ for example: "* * * * *" (execute query every minute, on the minute)
410423
There is no schedule by default. If no schedule is given, then the statement is run
411424
exactly once.
412425

426+
[id="plugins-{type}s-{plugin}-schedule_overlap"]
427+
===== `schedule_overlap`
428+
429+
* Value type is <<boolean,boolean>>
430+
* Default value is `true`
431+
432+
Whether to allow queuing of a scheduled run if a run is occurring.
433+
While this is ideal for ensuring a new run happens immediatelly after the previous on finishes if there
434+
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
435+
if the queue grows continuously.
436+
437+
When in doubt, set `schedule_overlap` to false (it may become the default value in the future).
438+
413439
[id="plugins-{type}s-{plugin}-scroll"]
414440
===== `scroll`
415441

@@ -622,6 +648,25 @@ When the `target` is set to a field reference, the `_source` of the hit is place
622648
This option can be useful to avoid populating unknown fields when a downstream schema such as ECS is enforced.
623649
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]"`).
624650

651+
[id="plugins-{type}s-{plugin}-tracking_field"]
652+
===== `tracking_field`
653+
654+
* Value type is <<string,string>>
655+
* There is no default value for this setting.
656+
657+
Which field from the last event of a previous run will be used a cursor value for the following run.
658+
The value of this field is injected into each query if the query uses the placeholder `:last_value`.
659+
For the first query after a pipeline is started, the value used is either read from <<last_run_metadata_path>> file,
660+
or taken from <<tracking_field_seed>> setting.
661+
662+
[id="plugins-{type}s-{plugin}-tracking_field_seed"]
663+
===== `tracking_field_seed`
664+
665+
* Value type is <<string,string>>
666+
* There is no default value for this setting.
667+
668+
The starting value for the <<tracking_field>> if there is no <<last_run_metadata_path>> already.
669+
For a nanosecond timestamp based field, a suggested seed value something like `1980-01-01T23:59:59.999999999Z`.
625670

626671
[id="plugins-{type}s-{plugin}-user"]
627672
===== `user`

0 commit comments

Comments
 (0)