Tcp input plugin
editTcp input plugin
edit- Plugin version: v6.0.2
- Released on: 2019-03-09
- 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
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
.
Accepting log4j2 logs
editLog4j2 can send JSON over a socket, and we can use that combined with our tcp input to accept the logs.
First, we need to configure your application to send logs in JSON over a socket. The following log4j2.xml accomplishes this task.
Note, you will want to change the host
and port
settings in this
configuration to match your needs.
<Configuration> <Appenders> <Socket name="Socket" host="localhost" port="12345"> <JsonLayout compact="true" eventEol="true" /> </Socket> </Appenders> <Loggers> <Root level="info"> <AppenderRef ref="Socket"/> </Root> </Loggers> </Configuration>
To accept this in Logstash, you will want tcp input and a date filter:
input { tcp { port => 12345 codec => json } }
and add a date filter to take log4j2’s timeMillis
field and use it as the
event timestamp
filter { date { match => [ "timeMillis", "UNIX_MS" ] } }
Tcp Input Configuration Options
editThis plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
string, one of |
No |
|
Yes |
||
No |
||
a valid filesystem path |
No |
|
No |
||
No |
||
No |
||
a valid filesystem path |
No |
|
No |
||
No |
||
No |
||
No |
Also see Common Options for a list of options supported by all input plugins.
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.
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_cert
edit- Value type is path
- There is no default value for this setting.
Path to certificate in PEM format. This certificate will be presented to the connecting clients.
ssl_certificate_authorities
edit- Value type is array
-
Default value is
[]
Validate client certificate or certificate chain against these authorities. You can define multiple files or paths. All the certificates will be read and added to the trust store.
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 paths to extra X509 certificates. These are used together with the certificate to construct the certificate chain presented to the client.
ssl_key
edit- Value type is path
- There is no default value for this setting.
The path to the private key corresponding to the specified certificate (PEM format).
ssl_key_passphrase
edit- Value type is password
-
Default value is
nil
SSL key passphrase for the private key.
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.
tcp_keep_alive
edit- Value type is boolean
-
Default value is
false
Instruct the socket to use TCP keep alives. Uses OS defaults for keep alive settings.
dns_reverse_lookup_enabled
edit- Value type is boolean
-
Default value is
true
It is possible to avoid DNS reverse-lookups by disabling this setting. If disabled, the address metadata that is added to events will contain the source address as-specified at the TCP layer and IPs will not be resolved to hostnames.
Common Options
editThe following configuration options are supported by all input plugins:
Details
edit
codec
edit- Value type is codec
-
Default value is
"line"
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.
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 inputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
input { tcp { id => "my_plugin_id" } }
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.
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.