--- title: JSON filter plugin v3.0.6 description: Plugin version: v3.0.6, Released on: 2019-02-04, Changelog. For other versions, see the overview list. To learn more about Logstash, see the Logstash... url: https://www.elastic.co/docs/reference/logstash/versioned-plugins/v3-0-6-plugins-filters-json products: - Logstash applies_to: - Elastic Stack: Generally available --- # JSON filter plugin v3.0.6 - Plugin version: v3.0.6 - Released on: 2019-02-04 - [Changelog](https://github.com/logstash-plugins/logstash-filter-json/blob/v3.0.6/CHANGELOG.md) For other versions, see the [overview list](https://www.elastic.co/docs/reference/logstash/versioned-plugins/filter-json-index). To learn more about Logstash, see the [Logstash Reference](https://www.elastic.co/guide/en/logstash/current/index.html). ## Getting help For questions about the plugin, open a topic in the [Discuss](http://discuss.elastic.co) forums. For bugs or feature requests, open an issue in [Github](https://github.com/logstash-plugins/logstash-filter-json). For the list of Elastic supported plugins, please consult the [Elastic Support Matrix](https://www.elastic.co/support/matrix#matrix_logstash_plugins). ## Description This is a JSON parsing filter. It takes an existing field which contains JSON and expands 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 this filter can be configured to place the JSON into any arbitrary event field, using the `target` 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 the `tag_on_failure` option. If the parsed data contains a `@timestamp` field, the plugin will try to use it for the events `@timestamp`, and if the parsing fails, the field will be renamed to `_@timestamp` and the event will be tagged with a `_timestampparsefailure`. ## JSON Filter Configuration Options This plugin supports the following configuration options plus the [Common options](#v3.0.6-plugins-filters-json-common-options) described later. | Setting | Input type | Required | |-----------------------------------------------------------------------------|-----------------------------------------------------------------|----------| | [`skip_on_invalid_json`](#v3.0.6-plugins-filters-json-skip_on_invalid_json) | [boolean](/docs/reference/logstash/plugins/value-types#boolean) | No | | [`source`](#v3.0.6-plugins-filters-json-source) | [string](/docs/reference/logstash/plugins/value-types#string) | Yes | | [`tag_on_failure`](#v3.0.6-plugins-filters-json-tag_on_failure) | [array](/docs/reference/logstash/plugins/value-types#array) | No | | [`target`](#v3.0.6-plugins-filters-json-target) | [string](/docs/reference/logstash/plugins/value-types#string) | No | Also see [Common options](#v3.0.6-plugins-filters-json-common-options) for a list of options supported by all filter plugins. ### `skip_on_invalid_json` - Value type is [boolean](/docs/reference/logstash/plugins/value-types#boolean) - Default value is `false` Allows for skipping the filter on invalid JSON (this allows you to handle JSON and non-JSON data without warnings) ### `source` - This is a required setting. - Value type is [string](/docs/reference/logstash/plugins/value-types#string) - There is no default value for this setting. 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. ### `tag_on_failure` - Value type is [array](/docs/reference/logstash/plugins/value-types#array) - Default value is `["_jsonparsefailure"]` Append values to the `tags` field when there has been no successful match ### `target` - Value type is [string](/docs/reference/logstash/plugins/value-types#string) - There is no default value for this setting. Define the target field for placing the parsed data. If this setting is omitted, 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 a data structure in the `target` field. if the `target` field already exists, it will be overwritten! ## Common options These configuration options are supported by all filter plugins: | Setting | Input type | Required | |-----------------------------------------------------------------|-----------------------------------------------------------------|----------| | [`add_field`](#v3.0.6-plugins-filters-json-add_field) | [hash](/docs/reference/logstash/plugins/value-types#hash) | No | | [`add_tag`](#v3.0.6-plugins-filters-json-add_tag) | [array](/docs/reference/logstash/plugins/value-types#array) | No | | [`enable_metric`](#v3.0.6-plugins-filters-json-enable_metric) | [boolean](/docs/reference/logstash/plugins/value-types#boolean) | No | | [`id`](#v3.0.6-plugins-filters-json-id) | [string](/docs/reference/logstash/plugins/value-types#string) | No | | [`periodic_flush`](#v3.0.6-plugins-filters-json-periodic_flush) | [boolean](/docs/reference/logstash/plugins/value-types#boolean) | No | | [`remove_field`](#v3.0.6-plugins-filters-json-remove_field) | [array](/docs/reference/logstash/plugins/value-types#array) | No | | [`remove_tag`](#v3.0.6-plugins-filters-json-remove_tag) | [array](/docs/reference/logstash/plugins/value-types#array) | No | ### `add_field` - Value type is [hash](/docs/reference/logstash/plugins/value-types#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 { 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 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` - Value type is [array](/docs/reference/logstash/plugins/value-types#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 { 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). ### `enable_metric` - Value type is [boolean](/docs/reference/logstash/plugins/value-types#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. ### `id` - Value type is [string](/docs/reference/logstash/plugins/value-types#string) - There is no default value for this setting. 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 useful when 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" } } ``` ### `periodic_flush` - Value type is [boolean](/docs/reference/logstash/plugins/value-types#boolean) - Default value is `false` Call the filter flush method at regular interval. Optional. ### `remove_field` - Value type is [array](/docs/reference/logstash/plugins/value-types#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 { 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 second example would remove an additional, non-dynamic field. ### `remove_tag` - Value type is [array](/docs/reference/logstash/plugins/value-types#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 { 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 example would remove a sad, unwanted tag as well.