opensearch
Publishes messages into an Elasticsearch index. If the index does not exist then it is created with a dynamic mapping.
-
Common
-
Advanced
# Common config fields, showing default values
output:
label: ""
opensearch:
urls: [] # No default (required)
index: "" # No default (required)
action: "" # No default (required)
id: ${!counter()}-${!timestamp_unix()} # No default (required)
max_in_flight: 64
batching:
count: 0
byte_size: 0
period: ""
check: ""
# All config fields, showing default values
output:
label: ""
opensearch:
urls: [] # No default (required)
index: "" # No default (required)
action: "" # No default (required)
id: ${!counter()}-${!timestamp_unix()} # No default (required)
pipeline: ""
routing: ""
tls:
enabled: false
skip_cert_verify: false
enable_renegotiation: false
root_cas: ""
root_cas_file: ""
client_certs: []
max_in_flight: 64
basic_auth:
enabled: false
username: ""
password: ""
batching:
count: 0
byte_size: 0
period: ""
check: ""
processors: [] # No default (optional)
aws:
enabled: false
region: ""
endpoint: ""
credentials:
profile: ""
id: ""
secret: ""
token: ""
from_ec2_role: false
role: ""
role_external_id: ""
Both the id
and index
fields can be dynamically set using function interpolations described here. When sending batched messages these interpolations are performed per message part.
Performance
This output benefits from sending multiple messages in flight in parallel for improved performance. You can tune the max number of in flight messages (or message batches) with the field max_in_flight
.
This output benefits from sending messages as a batch for improved performance. Batches can be formed at both the input and output level. You can find out more in this doc.
Examples
-
Updating Documents
When updating documents the request body should contain a combination of a doc
, upsert
, and/or script
fields at the top level, this should be done via mapping processors.
output:
processors:
- mapping: |
meta id = this.id
root.doc = this
opensearch:
urls: [ TODO ]
index: foo
id: ${! @id }
action: update
Fields
urls
A list of URLs to connect to. If an item of the list contains commas it will be expanded into multiple URLs.
Type: array
# Examples
urls:
- http://localhost:9200
action
The action to take on the document. This field must resolve to one of the following action types: index
, update
or delete
.
This field supports interpolation functions.
Type: string
id
The ID for indexed messages. Interpolation should be used in order to create a unique ID for each message. This field supports interpolation functions.
Type: string
# Examples
id: ${!counter()}-${!timestamp_unix()}
pipeline
An optional pipeline id to preprocess incoming documents. This field supports interpolation functions.
Type: string
Default: ""
routing
The routing key to use for the document. This field supports interpolation functions.
Type: string
Default: ""
tls.skip_cert_verify
Whether to skip server side certificate verification.
Type: bool
Default: false
tls.enable_renegotiation
Whether to allow the remote server to repeatedly request renegotiation. Enable this option if you’re seeing the error message local error: tls: no renegotiation
.
Type: bool
Default: false
Requires version 3.45.0 or newer
tls.root_cas
An optional root certificate authority to use. This is a string, representing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.
This field contains sensitive information that usually shouldn’t be added to a config directly, read our secrets page for more info. |
Type: string
Default: ""
# Examples
root_cas: |-
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
tls.root_cas_file
An optional path of a root certificate authority file to use. This is a file, often with a .pem extension, containing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.
Type: string
Default: ""
# Examples
root_cas_file: ./root_cas.pem
tls.client_certs
A list of client certificates to use. For each certificate either the fields cert
and key
, or cert_file
and key_file
should be specified, but not both.
Type: array
Default: []
# Examples
client_certs:
- cert: foo
key: bar
client_certs:
- cert_file: ./example.pem
key_file: ./example.key
tls.client_certs[].key
A plain text certificate key to use.
This field contains sensitive information that usually shouldn’t be added to a config directly, read our secrets page for more info. |
Type: string
Default: ""
tls.client_certs[].password
A plain text password for when the private key is password encrypted in PKCS#1 or PKCS#8 format. The obsolete pbeWithMD5AndDES-CBC
algorithm is not supported for the PKCS#8 format.
Because the obsolete pbeWithMD5AndDES-CBC algorithm does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext.
This field contains sensitive information that usually shouldn’t be added to a config directly, read our secrets page for more info. |
Type: string
Default: ""
# Examples
password: foo
password: ${KEY_PASSWORD}
max_in_flight
The maximum number of messages to have in flight at a given time. Increase this to improve throughput.
Type: int
Default: 64
basic_auth.password
A password to authenticate with.
This field contains sensitive information that usually shouldn’t be added to a config directly, read our secrets page for more info. |
Type: string
Default: ""
batching
Allows you to configure a batching policy.
Type: object
# Examples
batching:
byte_size: 5000
count: 0
period: 1s
batching:
count: 10
period: 1s
batching:
check: this.contains("END BATCH")
count: 0
period: 1m
batching.count
A number of messages at which the batch should be flushed. If 0
disables count based batching.
Type: int
Default: 0
batching.byte_size
An amount of bytes at which the batch should be flushed. If 0
disables size based batching.
Type: int
Default: 0
batching.period
A period in which an incomplete batch should be flushed regardless of its size.
Type: string
Default: ""
# Examples
period: 1s
period: 1m
period: 500ms
batching.check
A Bloblang query that should return a boolean value indicating whether a message should end a batch.
Type: string
Default: ""
# Examples
check: this.type == "end_of_transaction"
batching.processors
A list of processors to apply to a batch as it is flushed. This allows you to aggregate and archive the batch however you see fit. Please note that all resulting messages are flushed as a single batch, therefore splitting the batch into smaller batches using these processors is a no-op.
Type: array
# Examples
processors:
- archive:
format: concatenate
processors:
- archive:
format: lines
processors:
- archive:
format: json_array
aws.credentials
Optional manual configuration of AWS credentials to use. More information can be found in Amazon Web Services.
Type: object
aws.credentials.secret
The secret for the credentials being used.
This field contains sensitive information that usually shouldn’t be added to a config directly, read our secrets page for more info. |
Type: string
Default: ""
aws.credentials.token
The token for the credentials being used, required when using short term credentials.
Type: string
Default: ""
aws.credentials.from_ec2_role
Use the credentials of a host EC2 machine configured to assume an IAM role associated with the instance.
Type: bool
Default: false
Requires version 4.2.0 or newer