Elasticsearch output plugin

edit

Elasticsearch output plugin

edit
  • Plugin version: v11.22.6
  • Released on: 2024-04-30
  • Changelog

For other versions, see the Versioned plugin docs.

Getting Help

edit

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Description

edit

Elasticsearch provides near real-time search and analytics for all types of data. The Elasticsearch output plugin can store both time series datasets (such as logs, events, and metrics) and non-time series data in Elasticsearch.

You can learn more about Elasticsearch on the website landing page or in the Elasticsearch documentation.

Compatibility Note

When connected to Elasticsearch 7.x, modern versions of this plugin don’t use the document-type when inserting documents, unless the user explicitly sets document_type.

If you are using an earlier version of Logstash and wish to connect to Elasticsearch 7.x, first upgrade Logstash to version 6.8 to ensure it picks up changes to the Elasticsearch index template.

If you are using a custom template, ensure your template uses the _doc document-type before connecting to Elasticsearch 7.x.

Logstash to Elasticsearch on serverless

edit

You can use this plugin to send your Logstash data to Elasticsearch on serverless. Some differences to note between Elasticsearch on serverless and self-managed Elasticsearch:

For more info on sending data from Logstash to Elasticsearch on serverless, check out the Elasticsearch on serverless docs.

Hosted Elasticsearch Service on Elastic Cloud

edit

You can run Elasticsearch on your own hardware or use our hosted Elasticsearch Service that is available on AWS, GCP, and Azure. Try the Elasticsearch Service for free.

Compatibility with the Elastic Common Schema (ECS)

edit

This plugin will persist events to Elasticsearch in the shape produced by your pipeline, and cannot be used to re-shape the event structure into a shape that complies with ECS. To produce events that fully comply with ECS, you will need to populate ECS-defined fields throughout your pipeline definition.

However, the Elasticsearch Index Templates it manages can be configured to be ECS-compatible by setting ecs_compatibility. By having an ECS-compatible template in place, we can ensure that Elasticsearch is prepared to create and index fields in a way that is compatible with ECS, and will correctly reject events with fields that conflict and cannot be coerced.

Data streams

edit

The Elasticsearch output plugin can store both time series datasets (such as logs, events, and metrics) and non-time series data in Elasticsearch.

Use the data stream options for indexing time series datasets (such as logs, metrics, and events) into Elasticsearch and Elasticsearch on serverless:

ECS compatibility must be enabled (set to v1 or v8) for data streams to work properly.

Data stream configuration examples

edit

Example: Basic default configuration

output {
    elasticsearch {
        hosts => "hostname"
        data_stream => "true"
    }
}

This example shows the minimal settings for processing data streams. Events with data_stream.*` fields are routed to the appropriate data streams. If the fields are missing, routing defaults to logs-generic-default.

Example: Customize data stream name

output {
    elasticsearch {
        hosts => "hostname"
        data_stream => "true"
        data_stream_type => "metrics"
        data_stream_dataset => "foo"
        data_stream_namespace => "bar"
    }
}

Writing to different indices: best practices

edit

You cannot use dynamic variable substitution when ilm_enabled is true and when using ilm_rollover_alias.

If you’re sending events to the same Elasticsearch cluster, but you’re targeting different indices you can:

  • use different Elasticsearch outputs, each one with a different value for the index parameter
  • use one Elasticsearch output and use the dynamic variable substitution for the index parameter

Each Elasticsearch output is a new client connected to the cluster:

  • it has to initialize the client and connect to Elasticsearch (restart time is longer if you have more clients)
  • it has an associated connection pool

In order to minimize the number of open connections to Elasticsearch, maximize the bulk size and reduce the number of "small" bulk requests (which could easily fill up the queue), it is usually more efficient to have a single Elasticsearch output.

Example:

    output {
      elasticsearch {
        index => "%{[some_field][sub_field]}-%{+YYYY.MM.dd}"
      }
    }

What to do in case there is no field in the event containing the destination index prefix?

You can use the mutate filter and conditionals to add a [@metadata] field to set the destination index for each event. The [@metadata] fields will not be sent to Elasticsearch.

Example:

    filter {
      if [log_type] in [ "test", "staging" ] {
        mutate { add_field => { "[@metadata][target_index]" => "test-%{+YYYY.MM}" } }
      } else if [log_type] == "production" {
        mutate { add_field => { "[@metadata][target_index]" => "prod-%{+YYYY.MM.dd}" } }
      } else {
        mutate { add_field => { "[@metadata][target_index]" => "unknown-%{+YYYY}" } }
      }
    }
    output {
      elasticsearch {
        index => "%{[@metadata][target_index]}"
      }
    }

Retry Policy

edit

The retry policy has changed significantly in the 8.1.1 release. This plugin uses the Elasticsearch bulk API to optimize its imports into Elasticsearch. These requests may experience either partial or total failures. The bulk API sends batches of requests to an HTTP endpoint. Error codes for the HTTP request are handled differently than error codes for individual documents.

HTTP requests to the bulk API are expected to return a 200 response code. All other response codes are retried indefinitely.

The following document errors are handled as follows:

  • 400 and 404 errors are sent to the dead letter queue (DLQ), if enabled. If a DLQ is not enabled, a log message will be emitted, and the event will be dropped. See DLQ Policy for more info.
  • 409 errors (conflict) are logged as a warning and dropped.

Note that 409 exceptions are no longer retried. Please set a higher retry_on_conflict value if you experience 409 exceptions. It is more performant for Elasticsearch to retry these exceptions than this plugin.

DLQ Policy

edit

Mapping (404) errors from Elasticsearch can lead to data loss. Unfortunately mapping errors cannot be handled without human intervention and without looking at the field that caused the mapping mismatch. If the DLQ is enabled, the original events causing the mapping errors are stored in a file that can be processed at a later time. Often times, the offending field can be removed and re-indexed to Elasticsearch. If the DLQ is not enabled, and a mapping error happens, the problem is logged as a warning, and the event is dropped. See Dead letter queues (DLQ) for more information about processing events in the DLQ. The list of error codes accepted for DLQ could be customized with dlq_custom_codes but should be used only in motivated cases.

Index lifecycle management (ILM)

edit
  • The Index lifecycle management (ILM) feature does not apply for Elasticsearch on serverless. Any ILM settings in your plugin configuration are ignored and may cause errors.
  • The ILM feature requires plugin version 9.3.1 or higher.
  • This feature requires an Elasticsearch instance of 6.6.0 or higher with at least a Basic license

Logstash can use index lifecycle management to automate the management of indices over time.

The use of index lifecycle management is controlled by the ilm_enabled setting. By default, this setting detects whether the Elasticsearch instance supports ILM, and uses it if it is available. ilm_enabled can also be set to true or false to override the automatic detection, or disable ILM.

This will overwrite the index settings and adjust the Logstash template to write the necessary settings for the template to support index lifecycle management, including the index policy and rollover alias to be used.

Logstash creates a rollover alias for the indices to be written to, including a pattern for how the actual indices will be named, and unless an ILM policy that already exists has been specified, a default policy will also be created. The default policy is configured to rollover an index when it reaches either 50 gigabytes in size, or is 30 days old, whichever happens first.

The default rollover alias is called logstash, with a default pattern for the rollover index of {now/d}-00001, which will name indices on the date that the index is rolled over, followed by an incrementing number. Note that the pattern must end with a dash and a number that will be incremented.

See the Rollover API documentation for more details on naming.

The rollover alias, ilm pattern and policy can be modified.

See config below for an example:

    output {
      elasticsearch {
        ilm_rollover_alias => "custom"
        ilm_pattern => "000001"
        ilm_policy => "custom_policy"
      }
    }
  • Custom ILM policies must already exist on the Elasticsearch cluster before they can be used.
  • If the rollover alias or pattern is modified, the index template will need to be overwritten as the settings index.lifecycle.name and index.lifecycle.rollover_alias are automatically written to the template
  • If the index property is supplied in the output definition, it will be overwritten by the rollover alias.

Batch Sizes

edit

This plugin attempts to send batches of events to the Elasticsearch Bulk API as a single request. However, if a batch exceeds 20MB we break it up into multiple bulk requests. If a single document exceeds 20MB it is sent as a single request.

DNS Caching

edit

This plugin uses the JVM to lookup DNS entries and is subject to the value of networkaddress.cache.ttl, a global setting for the JVM.

As an example, to set your DNS TTL to 1 second you would set the LS_JAVA_OPTS environment variable to -Dnetworkaddress.cache.ttl=1.

Keep in mind that a connection with keepalive enabled will not reevaluate its DNS value while the keepalive is in effect.

HTTP Compression

edit

This plugin always reads compressed responses from Elasticsearch. By default, it sends compressed bulk requests to Elasticsearch.

If you are concerned about bandwidth, you can set a higher compression_level to trade CPU capacity for a reduction in network IO.

Authentication

edit

Authentication to a secure Elasticsearch cluster is possible using one of the user/password, cloud_auth or api_key options.

Authorization

edit

Authorization to a secure Elasticsearch cluster requires read permission at index level and monitoring permissions at cluster level. The monitoring permission at cluster level is necessary to perform periodic connectivity checks.

Handling non UTF-8 data

edit

This plugin transmits events to Elasticsearch using a JSON API, and therefore requires that all string values in events to be valid UTF-8. When a string value on an event contains one or more byte sequences that are not valid in UTF-8, each offending byte sequence is replaced with the UTF-8 replacement character (\uFFFD).

Elasticsearch Output Configuration Options

edit

This plugin supports the following configuration options plus the Common Options and the Elasticsearch Output Deprecated Configuration Options described later.

Setting Input type Required

action

string

No

api_key

password

No

bulk_path

string

No

ca_trusted_fingerprint

string

No

cloud_auth

password

No

cloud_id

string

No

compression_level

number, one of [0 ~ 9]

No

custom_headers

hash

No

data_stream

string, one of ["true", "false", "auto"]

No

data_stream_auto_routing

boolean

No

data_stream_dataset

string

No

data_stream_namespace

string

No

data_stream_sync_fields

boolean

No

data_stream_type

string

No

dlq_custom_codes

number

No

dlq_on_failed_indexname_interpolation

boolean

No

doc_as_upsert

boolean

No

document_id

string

No

document_type

string

No

ecs_compatibility

string

No

failure_type_logging_whitelist

array

No

healthcheck_path

string

No

hosts

uri

No

http_compression

boolean

No

ilm_enabled

string, one of ["true", "false", "auto"]

No

ilm_pattern

string

No

ilm_policy

string

No

ilm_rollover_alias

string

No

index

string

No

silence_errors_in_log

array

No

manage_template

boolean

No

parameters

hash

No

parent

string

No

password

password

No

path

string

No

pipeline

string

No

pool_max

number

No

pool_max_per_route

number

No

proxy

uri

No

resurrect_delay

number

No

retry_initial_interval

number

No

retry_max_interval

number

No

retry_on_conflict

number

No

routing

string

No

script

string

No

script_lang

string

No

script_type

string, one of ["inline", "indexed", "file"]

No

script_var_name

string

No

scripted_upsert

boolean

No

sniffing

boolean

No

sniffing_delay

number

No

sniffing_path

string

No

ssl_certificate

path

No

ssl_certificate_authorities

list of path

No

ssl_cipher_suites

list of string

No

ssl_enabled

boolean

No

ssl_key

path

No

ssl_keystore_password

password

No

ssl_keystore_path

path

No

ssl_keystore_type

string

No

ssl_supported_protocols

string

No

ssl_truststore_password

password

No

ssl_truststore_path

path

No

ssl_truststore_type

string

No

ssl_verification_mode

string, one of ["full", "none"]

No

template

a valid filesystem path

No

template_api

string, one of ["auto", "legacy", "composable"]

No

template_name

string

No

template_overwrite

boolean

No

timeout

number

No

upsert

string

No

user

string

No

validate_after_inactivity

number

No

version

string

No

version_type

string, one of ["internal", "external", "external_gt", "external_gte", "force"]

No

Also see Common Options for a list of options supported by all output plugins.

 

action

edit
  • Value type is string
  • Default value is create for data streams, and index for non-time series data.

The Elasticsearch action to perform. Valid actions are:

  • index: indexes a document (an event from Logstash).
  • delete: deletes a document by id (An id is required for this action)
  • create: indexes a document, fails if a document by that id already exists in the index.
  • update: updates a document by id. Update has a special case where you can upsert — update a document if not already present. See the doc_as_upsert option. NOTE: This does not work and is not supported in Elasticsearch 1.x. Please upgrade to ES 2.x or greater to use this feature with Logstash!
  • A sprintf style string to change the action based on the content of the event. The value %{[foo]} would use the foo field for the action. If resolved action is not in [index, delete, create, update], the event will not be sent to Elasticsearch. Instead the event will be sent to the pipeline’s dead-letter-queue (DLQ) (if enabled), or it will be logged and dropped.

For more details on actions, check out the Elasticsearch bulk API documentation.

api_key

edit
  • Value type is password
  • There is no default value for this setting.

Authenticate using Elasticsearch API key. Note that this option also requires SSL/TLS, which can be enabled by supplying a cloud_id, a list of HTTPS hosts, or by setting ssl_enabled => true.

Format is id:api_key where id and api_key are as returned by the Elasticsearch Create API key API.

bulk_path

edit
  • Value type is string
  • The default value for this settings is /_bulk?filter_path=errors,items.*.error,items.*.status

HTTP Path to perform the _bulk requests to * This default bulk path is the concatenation of the value of path parameter and /_bulk?filter_path=errors,items.*.error,items.*.status * The filter_path query parameter is appended to the bulk path to reduce the payload between logstash and elasticsearch. However, if a custom filter_path query parameter is included in the bulk_path setting, then that value will be used.

ca_trusted_fingerprint

edit
  • Value type is string, and must contain exactly 64 hexadecimal characters.
  • There is no default value for this setting.
  • Use of this option requires Logstash 8.3+

The SHA-256 fingerprint of an SSL Certificate Authority to trust, such as the autogenerated self-signed CA for an Elasticsearch cluster.

cloud_auth

edit
  • Value type is password
  • There is no default value for this setting.

Cloud authentication string ("<username>:<password>" format) is an alternative for the user/password pair.

For more details, check out the Logstash-to-Cloud documentation.

cloud_id

edit
  • Value type is string
  • There is no default value for this setting.

Cloud ID, from the Elastic Cloud web console. If set hosts should not be used.

For more details, check out the Logstash-to-Cloud documentation.

compression_level

edit
  • Value can be any of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
  • Default value is 1

The gzip compression level. Setting this value to 0 disables compression. The compression level must be in the range of 1 (best speed) to 9 (best compression).

Increasing the compression level will reduce the network usage but will increase the CPU usage.

data_stream

edit
  • Value can be any of: true, false and auto
  • Default is false in Logstash 7.x and auto starting in Logstash 8.0.

Defines whether data will be indexed into an Elasticsearch data stream. The other data_stream_* settings will be used only if this setting is enabled.

Logstash handles the output as a data stream when the supplied configuration is compatible with data streams and this value is set to auto. Note that ECS compatibility must be enabled (set to v1 or v8) for data streams to work properly.

data_stream_auto_routing

edit
  • Value type is boolean
  • Default value is true.

Automatically routes events by deriving the data stream name using specific event fields with the %{[data_stream][type]}-%{[data_stream][dataset]}-%{[data_stream][namespace]} format.

If enabled, the data_stream.* event fields will take precedence over the data_stream_type, data_stream_dataset, and data_stream_namespace settings, but will fall back to them if any of the fields are missing from the event.

data_stream_dataset

edit
  • Value type is string
  • Default value is generic.

The data stream dataset used to construct the data stream at index time.

data_stream_namespace

edit
  • Value type is string
  • Default value is default.

The data stream namespace used to construct the data stream at index time.

data_stream_sync_fields

edit
  • Value type is boolean
  • Default value is true

Automatically adds and syncs the data_stream.* event fields if they are missing from the event. This ensures that fields match the name of the data stream that is receiving events.

If existing data_stream.* event fields do not match the data stream name and data_stream_auto_routing is disabled, the event fields will be overwritten with a warning.

data_stream_type

edit
  • Value type is string
  • Default value is logs.

The data stream type used to construct the data stream at index time. Currently, only logs, metrics, synthetics and traces are supported.

dlq_custom_codes

edit
  • Value type is number
  • Default value is [].

List single-action error codes from Elasticsearch’s Bulk API that are considered valid to move the events into the dead letter queue. This list is an addition to the ordinary error codes considered for this feature, 400 and 404. It’s considered a configuration error to re-use the same predefined codes for success, DLQ or conflict. The option accepts a list of natural numbers corresponding to HTTP errors codes.

dlq_on_failed_indexname_interpolation

edit
  • Value type is boolean
  • Default value is true.

If enabled, failed index name interpolation events go into dead letter queue.

doc_as_upsert

edit
  • Value type is boolean
  • Default value is false

Enable doc_as_upsert for update mode. Create a new document with source if document_id doesn’t exist in Elasticsearch.

document_id

edit
  • Value type is string
  • There is no default value for this setting.

The document ID for the index. Useful for overwriting existing entries in Elasticsearch with the same ID.

document_type

edit
  • Value type is string
  • There is no default value for this setting.
  • This option is deprecated

This option is deprecated due to the removal of types in Elasticsearch 6.0. It will be removed in the next major version of Logstash.

This value is ignored and has no effect for Elasticsearch clusters 8.x.

This sets the document type to write events to. Generally you should try to write only similar events to the same type. String expansion %{foo} works here. If you don’t set a value for this option:

  • for elasticsearch clusters 8.x: no value will be used;
  • for elasticsearch clusters 7.x: the value of _doc will be used;
  • for elasticsearch clusters 6.x: the value of doc will be used;
  • for elasticsearch clusters 5.x and below: the event’s type field will be used, if the field is not present the value of doc will be used.

ecs_compatibility

edit
  • Value type is string
  • Supported values are:

    • disabled: does not provide ECS-compatible templates
    • v1,v8: Elastic Common Schema-compliant behavior
  • Default value depends on which version of Logstash is running:

    • When Logstash provides a pipeline.ecs_compatibility setting, its value is used as the default
    • Otherwise, the default value is disabled.

Controls this plugin’s compatibility with the Elastic Common Schema (ECS), including the installation of ECS-compatible index templates. The value of this setting affects the default values of:

failure_type_logging_whitelist

edit
  • Value type is array
  • Default value is []

Deprecated, refer to silence_errors_in_log.

custom_headers

edit
  • Value type is hash
  • There is no default value for this setting.

Pass a set of key value pairs as the headers sent in each request to an elasticsearch node. The headers will be used for any kind of request (_bulk request, template installation, health checks and sniffing). These custom headers will be overidden by settings like compression_level.

healthcheck_path

edit
  • Value type is string
  • There is no default value for this setting.

HTTP Path where a HEAD request is sent when a backend is marked down the request is sent in the background to see if it has come back again before it is once again eligible to service requests. If you have custom firewall rules you may need to change this

hosts

edit
  • Value type is uri
  • Default value is [//127.0.0.1]

Sets the host(s) of the remote instance. If given an array it will load balance requests across the hosts specified in the hosts parameter. Remember the http protocol uses the http address (eg. 9200, not 9300).

Examples:

`"127.0.0.1"`
`["127.0.0.1:9200","127.0.0.2:9200"]`
`["http://127.0.0.1"]`
`["https://127.0.0.1:9200"]`
`["https://127.0.0.1:9200/mypath"]` (If using a proxy on a subpath)

Exclude dedicated master nodes from the hosts list to prevent Logstash from sending bulk requests to the master nodes. This parameter should reference only data or client nodes in Elasticsearch.

Any special characters present in the URLs here MUST be URL escaped! This means # should be put in as %23 for instance.

http_compression

edit

Deprecated in 11.17.0.

Replaced by compression_level

  • Value type is boolean
  • Default value is false

Setting true enables gzip compression level 1 on requests.

This setting allows you to reduce this plugin’s outbound network traffic by compressing each bulk request to Elasticsearch.

This output plugin reads compressed responses from Elasticsearch regardless of the value of this setting.

ilm_enabled

edit
  • Value can be any of: true, false, auto
  • Default value is auto

The default setting of auto will automatically enable Index Lifecycle Management, if the Elasticsearch cluster is running Elasticsearch version 7.0.0 or higher with the ILM feature enabled, and disable it otherwise.

Setting this flag to false will disable the Index Lifecycle Management feature, even if the Elasticsearch cluster supports ILM. Setting this flag to true will enable Index Lifecycle Management feature, if the Elasticsearch cluster supports it. This is required to enable Index Lifecycle Management on a version of Elasticsearch earlier than version 7.0.0.

This feature requires a Basic License or above to be installed on an Elasticsearch cluster version 6.6.0 or later.

ilm_pattern

edit
  • Value type is string
  • Default value is {now/d}-000001

Pattern used for generating indices managed by Index Lifecycle Management. The value specified in the pattern will be appended to the write alias, and incremented automatically when a new index is created by ILM.

Date Math can be used when specifying an ilm pattern, see Rollover API docs for details.

Updating the pattern will require the index template to be rewritten.

The pattern must finish with a dash and a number that will be automatically incremented when indices rollover.

The pattern is a 6-digit string padded by zeros, regardless of prior index name. Example: 000001. See Rollover path parameters API docs for details.

ilm_policy

edit
  • Value type is string
  • Default value is logstash-policy

Modify this setting to use a custom Index Lifecycle Management policy, rather than the default. If this value is not set, the default policy will be automatically installed into Elasticsearch

If this setting is specified, the policy must already exist in Elasticsearch cluster.

ilm_rollover_alias

edit
  • Value type is string
  • Default value depends on whether ecs_compatibility is enabled:

    • ECS Compatibility disabled: logstash
    • ECS Compatibility enabled: ecs-logstash

The rollover alias is the alias where indices managed using Index Lifecycle Management will be written to.

If both index and ilm_rollover_alias are specified, ilm_rollover_alias takes precedence.

Updating the rollover alias will require the index template to be rewritten.

ilm_rollover_alias does NOT support dynamic variable substitution as index does.

index

edit
  • Value type is string
  • Default value depends on whether ecs_compatibility is enabled:

    • ECS Compatibility disabled: "logstash-%{+yyyy.MM.dd}"
    • ECS Compatibility enabled: "ecs-logstash-%{+yyyy.MM.dd}"

The indexing target to write events to. Can point to an index, alias, or data stream. This can be dynamic using the %{foo} syntax. The default value will partition your indices by day so you can more easily delete old data or only search specific date ranges. Indexes may not contain uppercase characters. For weekly indexes ISO 8601 format is recommended, eg. logstash-%{+xxxx.ww}. Logstash uses Joda formats and the @timestamp field of each event is being used as source for the date.

manage_template

edit
  • Value type is boolean
  • Default value is true for non-time series data, and false for data streams.

From Logstash 1.3 onwards, a template is applied to Elasticsearch during Logstash’s startup if one with the name template_name does not already exist. By default, the contents of this template is the default template for logstash-%{+YYYY.MM.dd} which always matches indices based on the pattern logstash-*. Should you require support for other index names, or would like to change the mappings in the template in general, a custom template can be specified by setting template to the path of a template file.

Setting manage_template to false disables this feature. If you require more control over template creation, (e.g. creating indices dynamically based on field names) you should set manage_template to false and use the REST API to apply your templates manually.

parameters

edit
  • Value type is hash
  • There is no default value for this setting.

Pass a set of key value pairs as the URL query string. This query string is added to every host listed in the hosts configuration. If the hosts list contains urls that already have query strings, the one specified here will be appended.

parent

edit
  • Value type is string
  • Default value is nil

For child documents, ID of the associated parent. This can be dynamic using the %{foo} syntax.

password

edit
  • Value type is password
  • There is no default value for this setting.

Password to authenticate to a secure Elasticsearch cluster

path

edit
  • Value type is string
  • There is no default value for this setting.

HTTP Path at which the Elasticsearch server lives. Use this if you must run Elasticsearch behind a proxy that remaps the root path for the Elasticsearch HTTP API lives. Note that if you use paths as components of URLs in the hosts field you may not also set this field. That will raise an error at startup

pipeline

edit
  • Value type is string
  • There is no default value.

Set which ingest pipeline you wish to execute for an event. You can also use event dependent configuration here like pipeline => "%{[@metadata][pipeline]}". The pipeline parameter won’t be set if the value resolves to empty string ("").

pool_max

edit
  • Value type is number
  • Default value is 1000

While the output tries to reuse connections efficiently we have a maximum. This sets the maximum number of open connections the output will create. Setting this too low may mean frequently closing / opening connections which is bad.

pool_max_per_route

edit
  • Value type is number
  • Default value is 100

While the output tries to reuse connections efficiently we have a maximum per endpoint. This sets the maximum number of open connections per endpoint the output will create. Setting this too low may mean frequently closing / opening connections which is bad.

proxy

edit
  • Value type is uri
  • There is no default value for this setting.

Set the address of a forward HTTP proxy. This setting accepts only URI arguments to prevent leaking credentials. An empty string is treated as if proxy was not set. This is useful when using environment variables e.g. proxy => '${LS_PROXY:}'.

resurrect_delay

edit
  • Value type is number
  • Default value is 5

How frequently, in seconds, to wait between resurrection attempts. Resurrection is the process by which backend endpoints marked down are checked to see if they have come back to life

retry_initial_interval

edit
  • Value type is number
  • Default value is 2

Set initial interval in seconds between bulk retries. Doubled on each retry up to retry_max_interval

retry_max_interval

edit
  • Value type is number
  • Default value is 64

Set max interval in seconds between bulk retries.

retry_on_conflict

edit
  • Value type is number
  • Default value is 1

The number of times Elasticsearch should internally retry an update/upserted document.

routing

edit
  • Value type is string
  • There is no default value for this setting.

A routing override to be applied to all processed events. This can be dynamic using the %{foo} syntax.

script

edit
  • Value type is string
  • Default value is ""

Set script name for scripted update mode

Example:

    output {
      elasticsearch {
        script => "ctx._source.message = params.event.get('message')"
      }
    }

script_lang

edit
  • Value type is string
  • Default value is "painless"

Set the language of the used script. When using indexed (stored) scripts on Elasticsearch 6.0 and higher, you must set this parameter to "" (empty string).

script_type

edit
  • Value can be any of: inline, indexed, file
  • Default value is ["inline"]

Define the type of script referenced by "script" variable inline : "script" contains inline script indexed : "script" contains the name of script directly indexed in elasticsearch file : "script" contains the name of script stored in elasticsearch’s config directory

script_var_name

edit
  • Value type is string
  • Default value is "event"

Set variable name passed to script (scripted update)

scripted_upsert

edit
  • Value type is boolean
  • Default value is false

if enabled, script is in charge of creating non-existent document (scripted update)

silence_errors_in_log

edit
  • Value type is array
  • Default value is []

Defines the list of Elasticsearch errors that you don’t want to log. A useful example is when you want to skip all 409 errors which are version_conflict_engine_exception.

    output {
      elasticsearch {
        silence_errors_in_log => ["version_conflict_engine_exception"]
      }
    }

sniffing

edit
  • Value type is boolean
  • Default value is false

This setting asks Elasticsearch for the list of all cluster nodes and adds them to the hosts list. For Elasticsearch 5.x and 6.x any nodes with http.enabled (on by default) will be added to the hosts list, excluding master-only nodes.

sniffing_delay

edit
  • Value type is number
  • Default value is 5

How long to wait, in seconds, between sniffing attempts

sniffing_path

edit
  • Value type is string
  • There is no default value for this setting.

HTTP Path to be used for the sniffing requests the default value is computed by concatenating the path value and "_nodes/http" if sniffing_path is set it will be used as an absolute path do not use full URL here, only paths, e.g. "/sniff/_nodes/http"

ssl_certificate

edit
  • Value type is path
  • There is no default value for this setting.

SSL certificate to use to authenticate the client. This certificate should be an OpenSSL-style X.509 certificate file.

This setting can be used only if ssl_key is set.

ssl_certificate_authorities

edit
  • Value type is a list of path
  • There is no default value for this setting

The .cer or .pem files to validate the server’s certificate.

You cannot use this setting and ssl_truststore_path at the same time.

ssl_cipher_suites

edit
  • Value type is a list of string
  • There is no default value for this setting

The list of cipher suites to use, listed by priorities. Supported cipher suites vary depending on the Java and protocol versions.

ssl_enabled

edit
  • Value type is boolean
  • There is no default value for this setting.

Enable SSL/TLS secured communication to Elasticsearch cluster. Leaving this unspecified will use whatever scheme is specified in the URLs listed in hosts or extracted from the cloud_id. If no explicit protocol is specified plain HTTP will be used.

ssl_key

edit
  • Value type is path
  • There is no default value for this setting.

OpenSSL-style RSA private key that corresponds to the ssl_certificate.

This setting can be used only if ssl_certificate is set.

ssl_keystore_password

edit
  • Value type is password
  • There is no default value for this setting.

Set the keystore password

ssl_keystore_path

edit
  • Value type is path
  • There is no default value for this setting.

The keystore used to present a certificate to the server. It can be either .jks or .p12

You cannot use this setting and ssl_certificate at the same time.

ssl_keystore_type

edit
  • Value can be any of: jks, pkcs12
  • If not provided, the value will be inferred from the keystore filename.

The format of the keystore file. It must be either jks or pkcs12.

ssl_supported_protocols

edit
  • Value type is string
  • Allowed values are: 'TLSv1.1', 'TLSv1.2', 'TLSv1.3'
  • Default depends on the JDK being used. With up-to-date Logstash, the default is ['TLSv1.2', 'TLSv1.3']. 'TLSv1.1' is not considered secure and is only provided for legacy applications.

List of allowed SSL/TLS versions to use when establishing a connection to the Elasticsearch cluster.

For Java 8 'TLSv1.3' is supported only since 8u262 (AdoptOpenJDK), but requires that you set the LS_JAVA_OPTS="-Djdk.tls.client.protocols=TLSv1.3" system property in Logstash.

If you configure the plugin to use 'TLSv1.1' on any recent JVM, such as the one packaged with Logstash, the protocol is disabled by default and needs to be enabled manually by changing jdk.tls.disabledAlgorithms in the $JDK_HOME/conf/security/java.security configuration file. That is, TLSv1.1 needs to be removed from the list.

ssl_truststore_password

edit
  • Value type is password
  • There is no default value for this setting.

Set the truststore password

ssl_truststore_path

edit
  • Value type is path
  • There is no default value for this setting.

The truststore to validate the server’s certificate. It can be either .jks or .p12.

You cannot use this setting and ssl_certificate_authorities at the same time.

ssl_truststore_type

edit
  • Value can be any of: jks, pkcs12
  • If not provided, the value will be inferred from the truststore filename.

The format of the truststore file. It must be either jks or pkcs12.

ssl_verification_mode

edit
  • Value can be any of: full, none
  • Default value is full

Defines how to verify the certificates presented by another party in the TLS connection:

full validates that the server certificate has an issue date that’s within the not_before and not_after dates; chains to a trusted Certificate Authority (CA), and has a hostname or IP address that matches the names within the certificate.

none performs no certificate validation.

Setting certificate verification to none disables many security benefits of SSL/TLS, which is very dangerous. For more information on disabling certificate verification please read https://www.cs.utexas.edu/~shmat/shmat_ccs12.pdf

template

edit
  • Value type is path
  • There is no default value for this setting.

You can set the path to your own template here, if you so desire. If not set, the included template will be used.

template_api

edit
  • Value can be any of: auto, legacy, composable
  • Default value is auto

The default setting of auto will use index template API to create index template, if the Elasticsearch cluster is running Elasticsearch version 8.0.0 or higher, and use legacy template API otherwise.

Setting this flag to legacy will use legacy template API to create index template. Setting this flag to composable will use index template API to create index template.

The format of template provided to template needs to match the template API being used.

template_name

edit
  • Value type is string
  • Default value depends on whether ecs_compatibility is enabled:

    • ECS Compatibility disabled: logstash
    • ECS Compatibility enabled: ecs-logstash

This configuration option defines how the template is named inside Elasticsearch. Note that if you have used the template management features and subsequently change this, you will need to prune the old template manually, e.g.

curl -XDELETE <http://localhost:9200/_template/OldTemplateName?pretty>

where OldTemplateName is whatever the former setting was.

template_overwrite

edit
  • Value type is boolean
  • Default value is false

The template_overwrite option will always overwrite the indicated template in Elasticsearch with either the one indicated by template or the included one. This option is set to false by default. If you always want to stay up to date with the template provided by Logstash, this option could be very useful to you. Likewise, if you have your own template file managed by puppet, for example, and you wanted to be able to update it regularly, this option could help there as well.

Please note that if you are using your own customized version of the Logstash template (logstash), setting this to true will make Logstash to overwrite the "logstash" template (i.e. removing all customized settings)

timeout

edit
  • Value type is number
  • Default value is 60

Set the timeout, in seconds, for network operations and requests sent Elasticsearch. If a timeout occurs, the request will be retried.

upsert

edit
  • Value type is string
  • Default value is ""

Set upsert content for update mode. Create a new document with this parameter as json string if document_id doesn’t exists

user

edit
  • Value type is string
  • There is no default value for this setting.

Username to authenticate to a secure Elasticsearch cluster

validate_after_inactivity

edit
  • Value type is number
  • Default value is 10000

How long to wait before checking for a stale connection to determine if a keepalive request is needed. Consider setting this value lower than the default, possibly to 0, if you get connection errors regularly.

This client is based on Apache Commons. Here’s how the Apache Commons documentation describes this option: "Defines period of inactivity in milliseconds after which persistent connections must be re-validated prior to being leased to the consumer. Non-positive value passed to this method disables connection validation. This check helps detect connections that have become stale (half-closed) while kept inactive in the pool."

version

edit
  • Value type is string
  • There is no default value for this setting.

The version to use for indexing. Use sprintf syntax like %{my_version} to use a field value here. See the versioning support blog for more information.

version_type

edit
  • Value can be any of: internal, external, external_gt, external_gte, force
  • There is no default value for this setting.

The version_type to use for indexing. See the versioning support blog and Version types in the Elasticsearch documentation.

Elasticsearch Output Deprecated Configuration Options

edit

This plugin supports the following deprecated configurations.

Deprecated options are subject to removal in future releases.

cacert

edit

Deprecated in 11.14.0.

Replaced by ssl_certificate_authorities

  • Value type is a list of path
  • There is no default value for this setting.

The .cer or .pem file to validate the server’s certificate.

keystore

edit

Deprecated in 11.14.0.

Replaced by ssl_keystore_path

  • Value type is path
  • There is no default value for this setting.

The keystore used to present a certificate to the server. It can be either .jks or .p12

You cannot use this setting and ssl_certificate at the same time.

keystore_password

edit

Deprecated in 11.14.0.

Replaced by ssl_keystore_password

  • Value type is password
  • There is no default value for this setting.

Set the keystore password

ssl

edit

Deprecated in 11.14.0.

Replaced by ssl_enabled

  • Value type is boolean
  • There is no default value for this setting.

Enable SSL/TLS secured communication to Elasticsearch cluster. Leaving this unspecified will use whatever scheme is specified in the URLs listed in hosts or extracted from the cloud_id. If no explicit protocol is specified plain HTTP will be used.

ssl_certificate_verification

edit

Deprecated in 11.14.0.

Replaced by ssl_verification_mode

  • Value type is boolean
  • Default value is true

Option to validate the server’s certificate. Disabling this severely compromises security. For more information on disabling certificate verification please read https://www.cs.utexas.edu/~shmat/shmat_ccs12.pdf

truststore

edit

Deprecated in 11.14.0.

Replaced by ssl_truststore_path

  • Value type is path
  • There is no default value for this setting.

The truststore to validate the server’s certificate. It can be either .jks or .p12. Use either :truststore or :cacert.

truststore_password

edit

Deprecated in 11.14.0.

Replaced by ssl_truststore_password

  • Value type is password
  • There is no default value for this setting.

Set the truststore password

Common Options

edit

The following configuration options are supported by all output plugins:

Setting Input type Required

enable_metric

boolean

No

id

string

No

enable_metric

edit
  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance. By default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type. For example, if you have 2 elasticsearch outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  elasticsearch {
    id => "my_plugin_id"
  }
}

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.