Tcp output plugin
editTcp output plugin
edit- Plugin version: v6.0.0
- Released on: 2019-01-11
- Changelog
For other versions, see the Versioned plugin docs.
Getting Help
editFor 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.
Description
editWrite events over a TCP socket.
Each event json is separated by a newline.
Can either accept connections from clients or connect to a server,
depending on mode
.
Tcp Output Configuration Options
editThis plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
Yes |
||
string, one of |
No |
|
Yes |
||
No |
||
a valid filesystem path |
No |
|
a valid filesystem path |
No |
|
No |
||
a valid filesystem path |
No |
|
No |
||
No |
Also see Common Options for a list of options supported by all output plugins.
host
edit- This is a required setting.
- Value type is string
- There is no default value for this setting.
When mode is server
, the address to listen on.
When mode is client
, the address to connect to.
mode
edit-
Value can be any of:
server
,client
-
Default value is
"client"
Mode to operate in. server
listens for client connections,
client
connects to a server.
port
edit- This is a required setting.
- Value type is number
- There is no default value for this setting.
When mode is server
, the port to listen on.
When mode is client
, the port to connect to.
reconnect_interval
edit- Value type is number
-
Default value is
10
When connect failed,retry interval in sec.
ssl_cacert
edit- Value type is path
- There is no default value for this setting.
The SSL CA certificate, chainfile or CA path. The system CA path is automatically included.
Common Options
editThe following configuration options are supported by all output plugins:
codec
edit- Value type is codec
-
Default value is
"json"
The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output without needing a separate filter in your Logstash pipeline.
enable_metric
edit- Value type is 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
edit- Value type is 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 tcp outputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { tcp { id => "my_plugin_id" } }
Variable substitution in the id
field only supports environment variables
and does not support the use of values from the secret store.