This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
unix input to read events over a stream-oriented Unix domain socket.
filebeat.inputs: - type: unix max_message_size: 10MiB path: "/var/run/filebeat.sock"
unix input supports the following configuration options plus the
Common options described later.
The maximum size of the message received over the socket. The default is
The path to the Unix socket that will receive events.
The type to of the Unix socket that will receive events. Valid values
datagram. The default is
The group ownership of the Unix socket that will be created by Filebeat. The default is the primary group name for the user Filebeat is running as. This option is ignored on Windows.
The file mode of the Unix socket that will be created by Filebeat. This is
expected to be a file mode as an octal string. The default value is the system
Specify the framing used to split incoming events. Can be one of
delimiter uses the characters specified
line_delimiter to split the incoming events.
octet counting and non-transparent framing as described in
used to split the events in non-transparent framing. The default is
Specify the characters used to split the incoming events. The default is \n.
The at most number of connections to accept at any given point in time.
The number of seconds of inactivity before a connection is closed. The default is
See SSL for more information.
The following configuration options are supported by all inputs.
enabled option to enable and disable inputs. By default, enabled is
set to true.
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.
filebeat.inputs: - type: unix . . . tags: ["json"]
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: unix . . . fields: app_id: query_engine_12
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.
A list of processors to apply to the input data.
See Processors for information about specifying processors in your config.
The ingest 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.
If this option is set to true, fields with
null values will be published in
the output document. By default,
keep_null is set to
If present, this formatted string overrides the index for events from this input
(for elasticsearch outputs), or sets the
raw_index field of the event’s
metadata (for other outputs). This string can only refer to the agent name and
version and the event timestamp; for access to dynamic fields, use
output.elasticsearch.index or a processor.
By default, all events contain
host.name. This option can be set to
disable the addition of this field to all events. The default value is