tcp
edittcp
edit- Version: 4.0.0
- Released on: 2016-09-13
- Changelog
- Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4
Write 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
.
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
tcp { host => ... port => ... }
Available configuration options:
Setting | Input type | Required | Default value |
---|---|---|---|
No |
|
||
No |
|
||
Yes |
|||
No |
|||
string, one of |
No |
|
|
Yes |
|||
No |
|
||
a valid filesystem path |
No |
||
a valid filesystem path |
No |
||
No |
|
||
a valid filesystem path |
No |
||
No |
|
||
No |
|
||
<<,>> |
No |
|
Details
edit
codec
edit- Value type is codec
-
Default value is
"plain"
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.
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.
id
edit- Value type is string
- There is no default value for this setting.
Add a unique ID
to the plugin instance, this ID
is used for tracking
information for a specific configuration of the plugin.
output { stdout { id => "ABC" } }
If you don’t explicitely set this variable Logstash will generate a unique name.
message_format
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is string
- There is no default value for this setting.
The format to use when writing events to the file. This value
supports any string and can include %{name}
and other dynamic
strings.
If this setting is omitted, the full json representation of the event will be written as a single line.
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.
ssl_enable
edit- Value type is boolean
-
Default value is
false
Enable SSL (must be set for other ssl_
options to take effect).