You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The maximum amount of time, in seconds, to wait while establishing a connection to Elasticsearch.
206
207
Connect timeouts tend to occur when Elasticsearch or an intermediate proxy is overloaded with requests and has exhausted its connection pool.
207
208
209
+
[id="plugins-{type}s-{plugin}-custom_headers"]
210
+
===== `custom_headers`
211
+
212
+
* Value type is <<hash,hash>>
213
+
* Default value is empty
214
+
215
+
Pass a set of key value pairs as the headers sent in each request to an elasticsearch node.
216
+
The headers will be used for any kind of request.
217
+
These custom headers will override any headers previously set by the plugin such as the User Agent or Authorization headers.
218
+
208
219
[id="plugins-{type}s-{plugin}-docinfo"]
209
-
===== `docinfo`
220
+
===== `docinfo`
210
221
211
222
* Value type is <<boolean,boolean>>
212
223
* Default value is `false`
@@ -257,7 +268,7 @@ Example
257
268
258
269
259
270
[id="plugins-{type}s-{plugin}-docinfo_fields"]
260
-
===== `docinfo_fields`
271
+
===== `docinfo_fields`
261
272
262
273
* Value type is <<array,array>>
263
274
* Default value is `["_index", "_type", "_id"]`
@@ -268,7 +279,7 @@ option lists the metadata fields to save in the current event. See
268
279
more information.
269
280
270
281
[id="plugins-{type}s-{plugin}-docinfo_target"]
271
-
===== `docinfo_target`
282
+
===== `docinfo_target`
272
283
273
284
* Value type is <<string,string>>
274
285
* Default value depends on whether <<plugins-{type}s-{plugin}-ecs_compatibility>> is enabled:
@@ -292,7 +303,7 @@ this option names the field under which to store the metadata fields as subfield
292
303
Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (ECS)].
293
304
294
305
[id="plugins-{type}s-{plugin}-hosts"]
295
-
===== `hosts`
306
+
===== `hosts`
296
307
297
308
* Value type is <<array,array>>
298
309
* There is no default value for this setting.
@@ -302,18 +313,18 @@ can be either IP, HOST, IP:port, or HOST:port. The port defaults to
302
313
9200.
303
314
304
315
[id="plugins-{type}s-{plugin}-index"]
305
-
===== `index`
316
+
===== `index`
306
317
307
318
* Value type is <<string,string>>
308
319
* Default value is `"logstash-*"`
309
320
310
-
The index or alias to search.
321
+
The index or alias to search.
311
322
Check out {ref}/api-conventions.html#api-multi-index[Multi Indices
312
323
documentation] in the Elasticsearch documentation for info on
313
324
referencing multiple indices.
314
325
315
326
[id="plugins-{type}s-{plugin}-password"]
316
-
===== `password`
327
+
===== `password`
317
328
318
329
* Value type is <<password,password>>
319
330
* There is no default value for this setting.
@@ -333,7 +344,7 @@ An empty string is treated as if proxy was not set, this is useful when using
333
344
environment variables e.g. `proxy => '${LS_PROXY:}'`.
334
345
335
346
[id="plugins-{type}s-{plugin}-query"]
336
-
===== `query`
347
+
===== `query`
337
348
338
349
* Value type is <<string,string>>
339
350
* Default value is `'{ "sort": [ "_doc" ] }'`
@@ -381,7 +392,7 @@ The default is 0 (no retry). This value should be equal to or greater than zero.
381
392
NOTE: Partial failures - such as errors in a subset of all slices - can result in the entire query being retried, which can lead to duplication of data. Avoiding this would require Logstash to store the entire result set of a query in memory which is often not possible.
382
393
383
394
[id="plugins-{type}s-{plugin}-schedule"]
384
-
===== `schedule`
395
+
===== `schedule`
385
396
386
397
* Value type is <<string,string>>
387
398
* There is no default value for this setting.
@@ -393,7 +404,7 @@ There is no schedule by default. If no schedule is given, then the statement is
393
404
exactly once.
394
405
395
406
[id="plugins-{type}s-{plugin}-scroll"]
396
-
===== `scroll`
407
+
===== `scroll`
397
408
398
409
* Value type is <<string,string>>
399
410
* Default value is `"1m"`
@@ -416,7 +427,7 @@ The query requires at least one `sort` field, as described in the <<plugins-{typ
416
427
`scroll` uses {ref}/paginate-search-results.html#scroll-search-results[scroll] API to search, which is no longer recommended.
417
428
418
429
[id="plugins-{type}s-{plugin}-size"]
419
-
===== `size`
430
+
===== `size`
420
431
421
432
* Value type is <<number,number>>
422
433
* Default value is `1000`
@@ -606,7 +617,7 @@ It is also possible to target an entry in the event's metadata, which will be av
606
617
607
618
608
619
[id="plugins-{type}s-{plugin}-user"]
609
-
===== `user`
620
+
===== `user`
610
621
611
622
* Value type is <<string,string>>
612
623
* There is no default value for this setting.
@@ -620,7 +631,7 @@ empty string authentication will be disabled.
0 commit comments