Syslog inputedit
Use the syslog
input to read events over TCP or UDP, this input will parse BSD (rfc3164)
event and some variant.
Example configurations:
filebeat.inputs: - type: syslog protocol.udp: host: "localhost:9000"
filebeat.inputs: - type: syslog protocol.tcp: host: "localhost:9000"
Configuration optionsedit
The syslog
input supports protocol specific configuration options plus the
Common options described later.
Protocol udp
:
max_message_size
edit
The maximum size of the message received over UDP. The default is 10KiB
.
host
edit
The host and UDP port to listen on for event streams.
Protocol tcp
:
max_message_size
edit
The maximum size of the message received over TCP. The default is 20MiB
.
host
edit
The host and TCP port to listen on for event streams.
line_delimiter
edit
Specify the characters used to split the incoming events. The default is \n.
timeout
edit
The number of seconds of inactivity before a remote connection is closed. The default is 300s
.
Common optionsedit
The following configuration options are supported by all inputs.
enabled
edit
Use the enabled
option to enable and disable inputs. By default, enabled is
set to true.
tags
edit
A list of tags that Filebeat includes in the tags
field of each published
event. Tags make it easy to select specific events in Kibana or apply
conditional filtering in Logstash. These tags will be appended to the list of
tags specified in the general configuration.
Example:
filebeat.inputs: - type: syslog . . . tags: ["json"]
fields
edit
Optional fields that you can specify to add additional information to the
output. For example, you might add fields that you can use for filtering log
data. Fields can be scalar values, arrays, dictionaries, or any nested
combination of these. By default, the fields that you specify here will be
grouped under a fields
sub-dictionary in the output document. To store the
custom fields as top-level fields, set the fields_under_root
option to true.
If a duplicate field is declared in the general configuration, then its value
will be overwritten by the value declared here.
filebeat.inputs: - type: syslog . . . fields: app_id: query_engine_12
fields_under_root
edit
If this option is set to true, the custom
fields are stored as top-level fields in
the output document instead of being grouped under a fields
sub-dictionary. If
the custom field names conflict with other field names added by Filebeat,
then the custom fields overwrite the other fields.
processors
edit
A list of processors to apply to the input data.
See Filter and enhance the exported data for information about specifying processors in your config.
pipeline
edit
The Ingest Node pipeline ID to set for the events generated by this input.
The pipeline ID can also be configured in the Elasticsearch output, but this option usually results in simpler configuration files. If the pipeline is configured both in the input and output, the option from the input is used.