elastic
Send events to Elasticsearch server
| Field Name | Description | Type | Default |
|---|---|---|---|
| batch | Maximum number of events in an output batch. If 'document' send on end of document | integer or the 'document' | - |
| timeout | Interval after which the batch is sent, to keep throughput going | interval | 100ms |
| header | Put a header line before the batch | templated text | - |
| footer | Put a header line after the last line of the batch | templated text | - |
| use-document-marker | Enrich the pipe metadata with a document marker (for document handling in batch mode) | bool | false |
| retry | For operations that could potentially fail | Retry | - |
| url | Elasticsearch server address to send events to | string | http://localhost:9200 |
| index | Index to send events to | string | - |
| document-id-value | The document ID for the document to be inserted into Elasticsearch (BULK API) | string | - |
| document-id-field | Specify a field that contains the document ID. | field | - |
| insecure | Ignore TLS certificate validation errors (This is unsafe to use) | bool | false |
batch
Maximum number of events in an output batch. If 'document' send on end of document
Type: integer or the 'document'
timeout
Interval after which the batch is sent, to keep throughput going
Type: interval
header
Put a header line before the batch
Type: templated text
footer
Put a header line after the last line of the batch
Type: templated text
use-document-marker
Enrich the pipe metadata with a document marker (for document handling in batch mode)
Type: bool
retry
For operations that could potentially fail
Type: Retry
| Field Name | Description | Type | Default |
|---|---|---|---|
| count | How many attempts to make before declaring failure | integer | - |
| pause | How long to pause before re-trying | duration | - |
| forever | Keep trying until success is declared | bool | false |
count
How many attempts to make before declaring failure
Type: integer
Example
action:
exec:
command: echo 'one two'
retry:
count: 1
output:
{"_raw":"one two"}
pause
How long to pause before re-trying
Accepts human-friendly formats, like 1m (for 1 minute) and 4h (for 4 hours)
Type: duration
Example
action:
exec:
command: echo 'one two'
retry:
count: 6
pause: 10s
output:
{"_raw":"one two"}
forever
Keep trying until success is declared
Accepts human-friendly formats, like 1m (for 1 minute) and 4h (for 4 hours)
Type: bool
Example
action:
exec:
command: echo 'one two'
retry:
forever: true
output:
{"_raw":"one two"}
url
Elasticsearch server address to send events to
Type: string
Example
action:
elastic:
url: http://localhost:9200
batch: 1
index: name
index
Index to send events to
This supports time template format
Type: string
Example
action:
elastic:
index: 'some-index-%Y-%m-%d'
batch: 1
document-id-value
The document ID for the document to be inserted into Elasticsearch (BULK API)
Type: string
Example
action:
elastic:
document-id-value: 'some-${id}'
index: 'some-index-%Y-%m-%d'
batch: 1
document-id-field
Specify a field that contains the document ID.
Type: field
Example
action:
elastic:
document-id-field: field_name
index: 'some-index-%Y-%m-%d'
batch: 1
insecure
Ignore TLS certificate validation errors (This is unsafe to use)
Type: bool