tcp
edittcp
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
.
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
tcp { host => ... port => ... }
Available configuration options:
Details
edit
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.
exclude_tags
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events without any of these tags. Optional.
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.
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.
tags
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events with all of these tags. Optional.
type
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is string
-
Default value is
""
The type to act on. If a type is given, then this output will only
act on messages with the same type. See any input plugin’s type
attribute for more.
Optional.