--- title: Json_encode filter plugin description: Plugin version: v3.0.3 (Other versions), Released on: 2017-11-07, Changelog. For questions about the plugin, open a topic in the Discuss forums. For bugs... url: https://www.elastic.co/docs/reference/logstash/plugins/plugins-filters-json_encode products: - Logstash applies_to: - Elastic Stack: Generally available --- # Json_encode filter plugin - Plugin version: v3.0.3 ([Other versions](https://www.elastic.co/docs/reference/logstash/versioned-plugins/filter-json_encode-index)) - Released on: 2017-11-07 - [Changelog](https://github.com/logstash-plugins/logstash-filter-json_encode/blob/v3.0.3/CHANGELOG.md) ## 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_encode). For the list of Elastic supported plugins, please consult the [Elastic Support Matrix](https://www.elastic.co/support/matrix#matrix_logstash_plugins). ## Description JSON encode filter. Takes a field and serializes it into JSON If no target is specified, the source field is overwritten with the JSON text. For example, if you have a field named `foo`, and you want to store the JSON encoded string in `bar`, do this: ``` filter { json_encode { source => "foo" target => "bar" } } ``` ## Json_encode Filter Configuration Options This plugin supports the following configuration options plus the [Common options](#plugins-filters-json_encode-common-options) described later. | Setting | Input type | Required | |-------------------------------------------------|---------------------------------------------------------------|----------| | [`source`](#plugins-filters-json_encode-source) | [string](/docs/reference/logstash/plugins/value-types#string) | Yes | | [`target`](#plugins-filters-json_encode-target) | [string](/docs/reference/logstash/plugins/value-types#string) | No | Also see [Common options](#plugins-filters-json_encode-common-options) for a list of options supported by all filter plugins. ### `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 field to convert to JSON. ### `target` - Value type is [string](/docs/reference/logstash/plugins/value-types#string) - There is no default value for this setting. The field to write the JSON into. If not specified, the source field will be overwritten. ## Common options These configuration options are supported by all filter plugins: | Setting | Input type | Required | |-----------------------------------------------------------------|-----------------------------------------------------------------|----------| | [`add_field`](#plugins-filters-json_encode-add_field) | [hash](/docs/reference/logstash/plugins/value-types#hash) | No | | [`add_tag`](#plugins-filters-json_encode-add_tag) | [array](/docs/reference/logstash/plugins/value-types#array) | No | | [`enable_metric`](#plugins-filters-json_encode-enable_metric) | [boolean](/docs/reference/logstash/plugins/value-types#boolean) | No | | [`id`](#plugins-filters-json_encode-id) | [string](/docs/reference/logstash/plugins/value-types#string) | No | | [`periodic_flush`](#plugins-filters-json_encode-periodic_flush) | [boolean](/docs/reference/logstash/plugins/value-types#boolean) | No | | [`remove_field`](#plugins-filters-json_encode-remove_field) | [array](/docs/reference/logstash/plugins/value-types#array) | No | | [`remove_tag`](#plugins-filters-json_encode-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_encode { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" } } } ``` ``` # You can also add multiple fields at once: filter { json_encode { 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_encode { add_tag => [ "foo_%{somefield}" ] } } ``` ``` # You can also add multiple tags at once: filter { json_encode { 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_encode filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. ``` filter { json_encode { 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_encode { remove_field => [ "foo_%{somefield}" ] } } ``` ``` # You can also remove multiple fields at once: filter { json_encode { 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_encode { remove_tag => [ "foo_%{somefield}" ] } } ``` ``` # You can also remove multiple tags at once: filter { json_encode { 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.