Elasticsearch

The Elasticsearch action to perform. Valid actions are: index, delete.

Use of this setting REQUIRES you also configure the document_id setting because delete actions all require a document id.

What does each action do?

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

The name/address of the host to bind to for Elasticsearch clustering

This is only valid for the node protocol.

The port for the node to listen on.

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

The name of your cluster if you set it on the Elasticsearch side. Useful for discovery.

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

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

Run the Elasticsearch server embedded in this process. This option is useful if you want to run a single Logstash process that handles log processing and indexing; it saves you from needing to run a separate Elasticsearch process.

If you are running the embedded Elasticsearch server, you can set the http port it listens on here; it is not common to need this setting changed from default.

Only handle events without any of these tags. Note this check is additional to type and tags.

This plugin uses the bulk index api for improved indexing performance. To make efficient bulk api calls, we will buffer a certain number of events before flushing that out to Elasticsearch. This setting controls how many events will be buffered before sending a batch of events.

The hostname or IP address of the host to use for Elasticsearch unicast discovery This is only required if the normal multicast/cluster discovery stuff won’t work in your environment.

`"127.0.0.1"`
`["127.0.0.1:9300","127.0.0.2:9300"]`

The amount of time since last flush before a flush is forced.

This setting helps ensure slow event rates don’t get stuck in Logstash. For example, if your flush_size is 100, and you have received 10 events, and it has been more than idle_flush_time seconds since the last flush, Logstash will flush those 10 events automatically.

This helps keep both fast and slow log streams moving along in near-real-time.

The index to write events to. 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}

The index type to write events to. Generally you should try to write only similar events to the same type. String expansion %{foo} works here.

Starting in Logstash 1.3 (unless you set option manage_template to false) a default mapping template for Elasticsearch will be applied, if you do not already have one set to match the index pattern defined (default of logstash-%{+YYYY.MM.dd}), minus any variables. For example, in this case the template will be applied to all indices starting with logstash-*

If you have dynamic templating (e.g. creating indices based on field names) then you should set manage_template to false and use the REST API to upload your templates manually.

This setting no longer does anything. It exists to keep config validation from failing. It will be removed in future versions.

The node name Elasticsearch will use when joining a cluster.

By default, this is generated internally by the ES client.

The port for Elasticsearch transport to use.

If you do not set this, the following defaults are used: * protocol => http - port 9200 * protocol => transport - port 9300-9305 * protocol => node - port 9300-9305

Choose the protocol used to talk to Elasticsearch.

The node protocol will connect to the cluster as a normal Elasticsearch node (but will not store data). This allows you to use things like multicast discovery. If you use the node protocol, you must permit bidirectional communication on the port 9300 (or whichever port you have configured).

The transport protocol will connect to the host you specify and will not show up as a node in the Elasticsearch cluster. This is useful in situations where you cannot permit connections outbound from the Elasticsearch cluster to this Logstash server.

The http protocol will use the Elasticsearch REST/HTTP interface to talk to elasticsearch.

All protocols will use bulk requests when talking to Elasticsearch.

The default protocol setting under java/jruby is "node". The default protocol on non-java rubies is "http"

SSL Configurations (HTTP only)

Enable SSL

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

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

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.

Overwrite the current template with whatever is configured in the template and template_name directives.

The JKS truststore to validate the server’s certificate Use either :truststore or :cacert

Set the truststore password

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s type attribute for more. Optional.

Username and password (HTTP only)

The number of workers to use for this output. Note that this setting may not be useful for all outputs.