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-extractnumbers.
This filter automatically extracts all numbers found inside a string
This is useful when you have lines that don’t match a grok pattern or use json but you still need to extract numbers.
Each numbers is returned in a @fields.intX or @fields.floatX field
where X indicates the position in the string.
The fields produced by this filter are extra useful used in combination with kibana number plotting features.
This plugin supports the following configuration options:
Required configuration options:
extractnumbers {
}
Available configuration options:
| Setting | Input type | Required | Default value |
|---|---|---|---|
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
- 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 {
extractnumbers {
add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
}
}
[source,ruby]
# You can also add multiple fields at once:
filter {
extractnumbers {
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 {
extractnumbers {
add_tag => [ "foo_%{somefield}" ]
}
}
[source,ruby]
# You can also add multiple tags at once:
filter {
extractnumbers {
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 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. Fields names can be dynamic and include parts of the event using the %{field} Example:
filter {
extractnumbers {
remove_field => [ "foo_%{somefield}" ]
}
}
[source,ruby]
# You can also remove multiple fields at once:
filter {
extractnumbers {
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 {
extractnumbers {
remove_tag => [ "foo_%{somefield}" ]
}
}
[source,ruby]
# You can also remove multiple tags at once:
filter {
extractnumbers {
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
"message"
The source field for the data. By default is message.