IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« elapsed environment »

› ›

elasticsearch

edit

elasticsearch

edit

Version: 3.1.0
Released on: 2016-12-16
Changelog

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-filter-elasticsearch.

Compatibility Note

Starting with Elasticsearch 5.3, there’s an HTTP setting called http.content_type.required. If this option is set to true, and you are using Logstash 2.4 through 5.2, you need to update the Elasticsearch filter plugin to version 3.1.1 or higher.

Search Elasticsearch for a previous log event and copy some fields from it into the current event. Below are two complete examples of how this filter might be used.

The first example uses the legacy query parameter where the user is limited to an Elasticsearch query_string. Whenever logstash receives an "end" event, it uses this elasticsearch filter to find the matching "start" event based on some operation identifier. Then it copies the @timestamp field from the "start" event into a new field on the "end" event. Finally, using a combination of the "date" filter and the "ruby" filter, we calculate the time duration in hours between the two events.

      if [type] == "end" {
         elasticsearch {
            hosts => ["es-server"]
            query => "type:start AND operation:%{[opid]}"
            fields => { "@timestamp" => "started" }
         }

         date {
            match => ["[started]", "ISO8601"]
            target => "[started]"
         }

         ruby {
            code => "event['duration_hrs'] = (event['@timestamp'] - event['started']) / 3600 rescue nil"
         }
      }

 The example below reproduces the above example but utilises the query_template.  This query_template represents a full
 Elasticsearch query DSL and supports the standard Logstash field substitution syntax.  The example below issues
 the same query as the first example but uses the template shown.

  if [type] == "end" {
         elasticsearch {
            hosts => ["es-server"]
            query_template => "template.json"
         }

         date {
            match => ["[started]", "ISO8601"]
            target => "[started]"
         }

         ruby {
            code => "event['duration_hrs'] = (event['@timestamp'] - event['started']) / 3600 rescue nil"
         }
  }



  template.json:

 {
    "query": {
      "query_string": {
       "query": "type:start AND operation:%{[opid]}"
      }
    },
   "_source": ["@timestamp", "started"]
 }

As illustrated above, through the use of 'opid', fields from the Logstash events can be referenced within the template.
The template will be populated per event prior to being used to query Elasticsearch.

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

elasticsearch {
}

Available configuration options:

Setting	Input type	Required	Default value
`add_field`	hash	No	`{}`
`add_tag`	array	No	`[]`
`ca_file`	a valid filesystem path	No
`enable_metric`	boolean	No	`true`
`enable_sort`	boolean	No	`true`
`fields`	array	No	`{}`
`hosts`	array	No	`["localhost:9200"]`
`id`	string	No
`index`	string	No	`""`
`password`	password	No
`periodic_flush`	boolean	No	`false`
`query`	string	No
`query_template`	string	No
`remove_field`	array	No	`[]`
`remove_tag`	array	No	`[]`
`result_size`	number	No	`1`
`sort`	string	No	`"@timestamp:desc"`
`ssl`	boolean	No	`false`
`tag_on_failure`	array	No	`["_elasticsearch_lookup_failure"]`
`user`	string	No

Details

edit

`add_field`

edit

Value type is hash
Default value is {}

If this filter is successful, add any arbitrary fields to this event. Field names can be dynamic and include parts of the event using the %{field}.

Example:

    filter {
      elasticsearch {
        add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
      }
    }

    # You can also add multiple fields at once:
    filter {
      elasticsearch {
        add_field => {
          "foo_%{somefield}" => "Hello world, from %{host}"
          "new_field" => "new_static_value"
        }
      }
    }

If the event has field "somefield" == "hello" this filter, on success, would add field foo_hello if it is present, with the value above and the %{host} piece replaced with that value from the event. The second example would also add a hardcoded field.

`add_tag`

edit

Value type is array
Default value is []

If this filter is successful, add arbitrary tags to the event. Tags can be dynamic and include parts of the event using the %{field} syntax.

Example:

    filter {
      elasticsearch {
        add_tag => [ "foo_%{somefield}" ]
      }
    }

    # You can also add multiple tags at once:
    filter {
      elasticsearch {
        add_tag => [ "foo_%{somefield}", "taggedy_tag"]
      }
    }

If the event has field "somefield" == "hello" this filter, on success, would add a tag foo_hello (and the second example would of course add a taggedy_tag tag).

`ca_file`

edit

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

SSL Certificate Authority file

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

`enable_sort`

edit

Value type is boolean
Default value is true

Whether results should be sorted or not

`fields`

edit

Value type is array
Default value is {}

Array of fields to copy from old event (found via elasticsearch) into new event

`hosts`

edit

Value type is array
Default value is ["localhost:9200"]

List of elasticsearch hosts to use for querying.

`id`

edit

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

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

`index`

edit

Value type is string
Default value is ""

Comma-delimited list of index names to search; use _all or empty string to perform the operation on all indices

`password`

edit

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

Basic Auth - password

`periodic_flush`

edit

Value type is boolean
Default value is false

Call the filter flush method at regular interval. Optional.

`query`

edit

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

Elasticsearch query string. Read the Elasticsearch query string documentation. for more info at: https://www.elastic.co/guide/en/elasticsearch/reference/master/query-dsl-query-string-query.html#query-string-syntax

`query_template`

edit

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

File path to elasticsearch query in DSL format. Read the Elasticsearch query documentation for more info at: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html

`remove_field`

edit

Value type is array
Default value is []

If this filter is successful, remove arbitrary fields from this event. Fields names can be dynamic and include parts of the event using the %{field}

Example:

    filter {
      elasticsearch {
        remove_field => [ "foo_%{somefield}" ]
      }
    }

    # You can also remove multiple fields at once:
    filter {
      elasticsearch {
        remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
      }
    }

If the event has field "somefield" == "hello" this filter, on success, would remove the field with name foo_hello if it is present. The second example would remove an additional, non-dynamic field.

`remove_tag`

edit

Value type is array
Default value is []

If this filter is successful, remove arbitrary tags from the event. Tags can be dynamic and include parts of the event using the %{field} syntax.

Example:

    filter {
      elasticsearch {
        remove_tag => [ "foo_%{somefield}" ]
      }
    }

    # You can also remove multiple tags at once:
    filter {
      elasticsearch {
        remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
      }
    }

If the event has field "somefield" == "hello" this filter, on success, would remove the tag foo_hello if it is present. The second example would remove a sad, unwanted tag as well.