Skip to main content

elasticsearch

EXPERIMENTAL

This component is experimental and therefore subject to change or removal outside of major version releases.

Queries Elasticsearch and replaces messages with the result.

# Common config fields, showing default values
label: ""
elasticsearch:
  urls: [] # No default (required)
  action: search
  index: "" # No default (required)
  id: "" # No default (optional)
  args_mapping: 'root = { "query": { "term": { "user_id": this.user_id } }' # No default (optional)
  api_key: "" # No default (optional)

Runs a search or document lookup against Elasticsearch for each message in a batch and replaces the message content with the result.

If the query fails the message is left unchanged and the error is set on the message — it can be caught downstream with catch or handled via try.

Actions​

Executes a search query against the given index. The query body is built by args_mapping, which must evaluate to an object containing a valid Elasticsearch Query DSL document. The result written to the message is an array of _source objects, one per hit — equivalent to how sql_raw returns an array of rows.

get​

Retrieves a single document by ID. The id field is required and supports interpolation. The result is the _source object of the matched document.

delete​

Deletes the document identified by id from the given index. The message content is left unchanged (equivalent to exec_only: true in sql_raw).

Search Metadata​

  • es_index
  • es_took_ms
  • es_result_count
  • es_total_hits

Get Metadata​

  • es_index
  • es_id
  • es_found

Delete Metadata​

  • es_index
  • es_id
  • es_delete_result

You can access these metadata fields using function interpolation.

Result mapping​

By default the processor overwrites the entire message with the Elasticsearch result. To merge the result into an existing message or extract a subset of fields, wrap this processor in a branch and use its result_map.

Examples​

For each incoming message, fetch the matching Elasticsearch document by ID and merge its fields into the message using a branch processor.

pipeline:
  processors:
    - branch:
        processors:
          - elasticsearch:
              urls:
                - http://localhost:9200
              action: get
              index: users
              id: ${! this.user_id }
        result_map: root = this.assign(result)

Fields​

urls​

A list of Elasticsearch URLs to connect to. When using an environment variable, provide URLs as a YAML array rather than a single comma-separated string. For example, ES_URLS=http://es1:9200,http://es2:9200 will be interpreted as a single URL and may result in a malformed address error.

Type: array

# Examples

urls:
  - http://localhost:9200

action​

The operation to perform against Elasticsearch.

Type: string
Default: "search"
Options: search, get, delete.

index​

The index to query. This field supports interpolation functions.

Type: string

id​

The document ID. Required for get and delete actions. Supports interpolation. This field supports interpolation functions.

Type: string

args_mapping​

An optional Bloblang mapping that produces the request body for search actions. The mapping must evaluate to an object containing a valid Elasticsearch Query DSL document.

Type: string

# Examples

args_mapping: 'root = { "query": { "term": { "user_id": this.user_id } }'

args_mapping: |-
  root = {
    "query": {
      "bool": {
        "must": [
          { "match": { "status": this.status } },
          { "range": { "created_at": { "gte": this.since } } }
        ]
      }
    },
    "size": 10
  }

tls​

Custom TLS settings can be used to override system defaults.

Type: object

tls.enabled​

Whether custom TLS settings are enabled.

Type: bool
Default: false

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 1.0.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.

Secret

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[].cert​

A plain text certificate to use.

Type: string
Default: ""

tls.client_certs[].key​

A plain text certificate key to use.

Secret

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[].cert_file​

The path of a certificate to use.

Type: string
Default: ""

tls.client_certs[].key_file​

The path of a certificate key to use.

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. Warning: Since it does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext.

Secret

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}

basic_auth​

Allows you to specify basic authentication.

Type: object

basic_auth.enabled​

Whether to use basic authentication in requests.

Type: bool
Default: false

basic_auth.username​

A username to authenticate as.

Type: string
Default: ""

basic_auth.password​

A password to authenticate with.

Secret

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: ""

api_key​

A Base64-encoded token for authorization; if set, overrides basic auth.

Type: string