tcp
edittcp
edit- Version: 4.1.0
- Released on: November 21, 2016
- Changelog
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
editRead events over a TCP socket.
Like stdin and file inputs, each event is assumed to be one line of text.
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 { port => ... }
Available configuration options:
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
||
string, one of |
No |
|
Yes |
||
No |
||
a valid filesystem path |
No |
|
No |
||
No |
||
a valid filesystem path |
No |
|
No |
||
No |
||
No |
||
No |
Details
edit
codec
edit- Value type is codec
-
Default value is
"plain"
The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.
data_timeout
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is number
-
Default value is
-1
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- Value type is string
-
Default value is
"0.0.0.0"
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 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 grok filters.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { stdout { id => "my_plugin_id" } }
mode
edit-
Value can be any of:
server
,client
-
Default value is
"server"
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.
proxy_protocol
edit- Value type is boolean
-
Default value is
false
Proxy protocol support, only v1 is supported at this time http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt
ssl_cacert
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- 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).
ssl_extra_chain_certs
edit- Value type is array
-
Default value is
[]
An Array of extra X509 certificates to be added to the certificate chain. Useful when the CA chain is not necessary in the system store.
ssl_verify
edit- Value type is boolean
-
Default value is
true
Verify the identity of the other end of the SSL connection against the CA.
For input, sets the field sslsubject
to that of the client certificate.
tags
edit- Value type is array
- There is no default value for this setting.
Add any number of arbitrary tags to your event.
This can help with processing later.
type
edit- Value type is string
- There is no default value for this setting.
This is the base class for Logstash inputs.
Add a type
field to all events handled by this input.
Types are used mainly for filter activation.
The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.
If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.