elasticsearch

Add a field to an event

SSL Certificate Authority file

The character encoding used in this input. Examples include UTF-8 and cp1252

This setting is useful if your log files are in Latin-1 (aka cp1252) or in another character set other than UTF-8.

This only affects plain format logs since json is UTF-8 already.

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

If set, include Elasticsearch document information such as index, type, and the id in the event.

It might be important to note, with regards to metadata, that if you’re ingesting documents with the intent to re-index them (or just update them) that the action option in the elasticsearch output want’s to know how to handle those things. It can be dynamically assigned with a field added to the metadata.

Example

    input {
      elasticsearch {
        host => "es.production.mysite.org"
        index => "mydata-2018.09.*"
        query => "*"
        size => 500
        scroll => "5m"
        docinfo => true
      }
    }
    output {
      elasticsearch {
        index => "copy-of-production.%{[@metadata][_index]}"
        document_type => "%{[@metadata][_type]}"
        document_id => "%{[@metadata][_id]}"
      }
    }

List of document metadata to move to the docinfo_target field To learn more about Elasticsearch metadata fields read http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/_document_metadata.html

Where to move the Elasticsearch document information by default we use the @metadata field.

The format of input data (plain, json, json_event)

List of elasticsearch hosts to use for querying.

The index or alias to search.

If format is json, an event sprintf string to build what the display @message should be given (defaults to the raw JSON). sprintf format strings look like %{fieldname}

If format is json_event, ALL fields except for @type are expected to be present. Not receiving all fields will cause unexpected results.

Basic Auth - password

The HTTP port of your Elasticsearch server’s REST interface.

The query to be executed.

Enable the Elasticsearch "scan" search type. This will disable sorting but increase speed and performance.

This parameter controls the keepalive time in seconds of the scrolling request and initiates the scrolling process. The timeout applies per round trip (i.e. between the previous scan scroll request, to the next).

This allows you to set the maximum number of hits returned per scroll.

SSL

Add any number of arbitrary tags to your event.

This can help with processing later.

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

Basic Auth - username