elasticsearchedit

Note

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

Search Elasticsearch for a previous log event and copy some fields from it into the current event.

Below is a complete example of how this filter might be used. 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"
         }
      }

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

elasticsearch {
}

Available configuration options:

Setting Input typeRequiredDefault value

add_field

hash

No

{}

add_tag

array

No

[]

ca_file

a valid filesystem path

No

enable_sort

boolean

No

true

fields

array

No

{}

hosts

array

No

["localhost:9200"]

index

string

No

""

password

password

No

periodic_flush

boolean

No

false

query

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

Detailsedit

 

add_fieldedit

  • 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_tagedit

  • 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_fileedit

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

SSL Certificate Authority file

enable_sortedit

  • Value type is boolean
  • Default value is true

Whether results should be sorted or not

fieldsedit

  • Value type is array
  • Default value is {}

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

hostsedit

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

List of elasticsearch hosts to use for querying.

indexedit

  • 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

passwordedit

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

Basic Auth - password

periodic_flushedit

  • Value type is boolean
  • Default value is false

Call the filter flush method at regular interval. Optional.

queryedit

  • 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

remove_fieldedit

  • Value type is array
  • Default value is []

If this filter is successful, remove arbitrary fields from this event. 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_tagedit

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

result_sizeedit

  • Value type is number
  • Default value is 1

How many results to return

sortedit

  • Value type is string
  • Default value is "@timestamp:desc"

Comma-delimited list of <field>:<direction> pairs that define the sort order

ssledit

  • Value type is boolean
  • Default value is false

SSL

tag_on_failureedit

  • Value type is array
  • Default value is ["_elasticsearch_lookup_failure"]

Tags the event on failure to look up geo information. This can be used in later analysis.

useredit

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

Basic Auth - username