Skip to content

Commit 5ab5546

Browse files
committed
de-emphasize the cursor docs section
1 parent 7141ad9 commit 5ab5546

File tree

1 file changed

+56
-55
lines changed

1 file changed

+56
-55
lines changed

docs/index.asciidoc

Lines changed: 56 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,66 @@ This would create an Elasticsearch query with the following format:
4848
"sort": [ "_doc" ]
4949
}'
5050

51+
[id="plugins-{type}s-{plugin}-scheduling"]
52+
==== Scheduling
53+
54+
Input from this plugin can be scheduled to run periodically according to a specific
55+
schedule. This scheduling syntax is powered by https://github.com/jmettraux/rufus-scheduler[rufus-scheduler].
56+
The syntax is cron-like with some extensions specific to Rufus (e.g. timezone support ).
57+
58+
Examples:
59+
60+
|==========================================================
61+
| `* 5 * 1-3 *` | will execute every minute of 5am every day of January through March.
62+
| `0 * * * *` | will execute on the 0th minute of every hour every day.
63+
| `0 6 * * * America/Chicago` | will execute at 6:00am (UTC/GMT -5) every day.
64+
|==========================================================
65+
66+
67+
Further documentation describing this syntax can be found
68+
https://github.com/jmettraux/rufus-scheduler#parsing-cronlines-and-time-strings[here].
69+
70+
71+
[id="plugins-{type}s-{plugin}-auth"]
72+
==== Authentication
73+
74+
Authentication to a secure Elasticsearch cluster is possible using _one_ of the following options:
75+
76+
* <<plugins-{type}s-{plugin}-user>> AND <<plugins-{type}s-{plugin}-password>>
77+
* <<plugins-{type}s-{plugin}-cloud_auth>>
78+
* <<plugins-{type}s-{plugin}-api_key>>
79+
80+
[id="plugins-{type}s-{plugin}-autz"]
81+
==== Authorization
82+
83+
Authorization to a secure Elasticsearch cluster requires `read` permission at index level and `monitoring` permissions at cluster level.
84+
The `monitoring` permission at cluster level is necessary to perform periodic connectivity checks.
85+
86+
[id="plugins-{type}s-{plugin}-ecs"]
87+
==== Compatibility with the Elastic Common Schema (ECS)
88+
89+
When ECS compatibility is disabled, `docinfo_target` uses the `"@metadata"` field as a default, with ECS enabled the plugin
90+
uses a naming convention `"[@metadata][input][elasticsearch]"` as a default target for placing document information.
91+
92+
The plugin logs a warning when ECS is enabled and `target` isn't set.
93+
94+
TIP: Set the `target` option to avoid potential schema conflicts.
95+
96+
[id="plugins-{type}s-{plugin}-failure-handling"]
97+
==== Failure handling
98+
99+
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.
100+
101+
Common causes are:
102+
103+
- 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.
104+
- 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.
51105

52106
[id="plugins-{type}s-{plugin}-cursor"]
53107
==== Tracking a field's value across runs
54108

109+
NOTE: experimental:[] `tracking_field` and related settings are experimental and subject to change in the future
110+
55111
It is sometimes desirable to track the value of a particular field between two jobs:
56112
* avoid re-processing the entire result set of a long query after an unplanned restart
57113
* only grab new data from an index instead of processing the entire set on each job
@@ -163,61 +219,6 @@ With this setup, as new documents are indexed an `test-*` index, the next schedu
163219
. use PIT+search_after to paginate through all the data;
164220
. update the value of the field at the end of the pagination.
165221

166-
[id="plugins-{type}s-{plugin}-scheduling"]
167-
==== Scheduling
168-
169-
Input from this plugin can be scheduled to run periodically according to a specific
170-
schedule. This scheduling syntax is powered by https://github.com/jmettraux/rufus-scheduler[rufus-scheduler].
171-
The syntax is cron-like with some extensions specific to Rufus (e.g. timezone support ).
172-
173-
Examples:
174-
175-
|==========================================================
176-
| `* 5 * 1-3 *` | will execute every minute of 5am every day of January through March.
177-
| `0 * * * *` | will execute on the 0th minute of every hour every day.
178-
| `0 6 * * * America/Chicago` | will execute at 6:00am (UTC/GMT -5) every day.
179-
|==========================================================
180-
181-
182-
Further documentation describing this syntax can be found
183-
https://github.com/jmettraux/rufus-scheduler#parsing-cronlines-and-time-strings[here].
184-
185-
186-
[id="plugins-{type}s-{plugin}-auth"]
187-
==== Authentication
188-
189-
Authentication to a secure Elasticsearch cluster is possible using _one_ of the following options:
190-
191-
* <<plugins-{type}s-{plugin}-user>> AND <<plugins-{type}s-{plugin}-password>>
192-
* <<plugins-{type}s-{plugin}-cloud_auth>>
193-
* <<plugins-{type}s-{plugin}-api_key>>
194-
195-
[id="plugins-{type}s-{plugin}-autz"]
196-
==== Authorization
197-
198-
Authorization to a secure Elasticsearch cluster requires `read` permission at index level and `monitoring` permissions at cluster level.
199-
The `monitoring` permission at cluster level is necessary to perform periodic connectivity checks.
200-
201-
[id="plugins-{type}s-{plugin}-ecs"]
202-
==== Compatibility with the Elastic Common Schema (ECS)
203-
204-
When ECS compatibility is disabled, `docinfo_target` uses the `"@metadata"` field as a default, with ECS enabled the plugin
205-
uses a naming convention `"[@metadata][input][elasticsearch]"` as a default target for placing document information.
206-
207-
The plugin logs a warning when ECS is enabled and `target` isn't set.
208-
209-
TIP: Set the `target` option to avoid potential schema conflicts.
210-
211-
[id="plugins-{type}s-{plugin}-failure-handling"]
212-
==== Failure handling
213-
214-
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.
215-
216-
Common causes are:
217-
218-
- 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.
219-
- 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.
220-
221222
[id="plugins-{type}s-{plugin}-options"]
222223
==== Elasticsearch Input configuration options
223224

0 commit comments

Comments
 (0)