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"
}
}
This plugin supports the following configuration options:
Required configuration options:
elasticsearch {
}Available configuration options:
- 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.
- 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).
- Value type is path
- There is no default value for this setting.
SSL Certificate Authority file
- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events without all/any (controlled by exclude_any config
option) of these tags.
Optional.
- Value type is hash
-
Default value is
{}
Hash of fields to copy from old event (found via elasticsearch) into new event
- Value type is array
- There is no default value for this setting.
List of elasticsearch hosts to use for querying.
- Value type is boolean
-
Default value is
false
Call the filter flush method at regular interval. Optional.
- 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.
- 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.
- Value type is string
-
Default value is
"@timestamp:desc"
Comma-delimited list of <field>:<direction> pairs that define the sort order
- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events with all/any (controlled by include_any config option) of these tags.
Optional.
- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is string
-
Default value is
""
Note that all of the specified routing options (type,tags,exclude_tags,include_fields,
exclude_fields) must be met in order for the event to be handled by the filter.
The type to act on. If a type is given, then this filter will only
act on messages with the same type. See any input plugin’s "type"
attribute for more.
Optional.