:plugin: tld
:type: filter

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}s-{plugin}"]

=== Tld filter plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

This example filter will replace the contents of the default 
message field with whatever you specify in the configuration.

It is only intended to be used as an example.

[id="plugins-{type}s-{plugin}-options"]
==== Tld Filter Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-source>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
filter plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-source"]
===== `source` 

  * Value type is <<string,string>>
  * Default value is `"message"`

Setting the config_name here is required. This is how you
configure this filter from your Logstash config.

filter {
  example {
    message => "My message..."
  }
}

The source field to parse

[id="plugins-{type}s-{plugin}-target"]
===== `target` 

  * Value type is <<string,string>>
  * Default value is `"tld"`

The target field to place all the data



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]