For other versions, see theVersioned plugin docs.
For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github.For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
This is a JSON parsing filter. It takes an existing field which contains JSON andexpands it into an actual data structure within the Logstash event.
By default, it will place the parsed JSON in the root (top level) of the Logstash event, but thisfilter can be configured to place the JSON into any arbitrary event field, using thetarget
configuration.
This plugin has a few fallback scenarios when something bad happens during the parsing of the event.If the JSON parsing fails on the data, the event will be untouched and it will be tagged with_jsonparsefailure
; you can then use conditionals to clean the data. You can configure this tag with thetag_on_failure
option.
If the parsed data contains a @timestamp
field, the plugin will try to use it for the events @timestamp
, and if theparsing fails, the field will be renamed to _@timestamp
and the event will be tagged with a_timestampparsefailure
.
This plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
Yes |
||
No |
||
No |
Also see Common Options for a list of options supported by allfilter plugins.
false
Allows for skipping the filter on invalid JSON (this allows you to handle JSON and non-JSON data without warnings)
The configuration for the JSON filter:
source => source_field
For example, if you have JSON data in the message
field:
filter { json { source => "message" }}
The above would parse the JSON from the message
field.
["_jsonparsefailure"]
Append values to the tags
field when there has been nosuccessful match
Define the target field for placing the parsed data. If this setting isomitted, the JSON data will be stored at the root (top level) of the event.
For example, if you want the data to be put in the doc
field:
filter { json { target => "doc" }}
JSON in the value of the source
field will be expanded into adata structure in the target
field.
if the target
field already exists, it will be overwritten!
The following configuration options are supported by all filter plugins:
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
{}
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 { json { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" } }}
# You can also add multiple fields at once:filter { json { 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 thevalue above and the %{host}
piece replaced with that value from theevent. The second example would also add a hardcoded field.
[]
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 { json { add_tag => [ "foo_%{somefield}" ] }}
# You can also add multiple tags at once:filter { json { 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).
true
Disable or enable metric logging for this specific plugin instanceby default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.
Add a unique ID
to the plugin configuration. If no ID is specified, Logstash will generate one.It is strongly recommended to set this ID in your configuration. This is particularly usefulwhen you have two or more plugins of the same type, for example, if you have 2 json filters.Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
filter { json { id => "ABC" }}
false
Call the filter flush method at regular interval.Optional.
[]
If this filter is successful, remove arbitrary fields from this event.Example:
filter { json { remove_field => [ "foo_%{somefield}" ] }}
# You can also remove multiple fields at once:filter { json { 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 secondexample would remove an additional, non-dynamic field.
[]
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 { json { remove_tag => [ "foo_%{somefield}" ] }}
# You can also remove multiple tags at once:filter { json { 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 examplewould remove a sad, unwanted tag as well.