Unix input
editUnix input
editThis 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.
Use the unix
input to read events over a stream-oriented Unix domain socket.
Example configuration:
filebeat.inputs: - type: unix max_message_size: 10MiB path: "/var/run/filebeat.sock"
Configuration options
editThe unix
input supports the following configuration options plus the
Common options described later.
max_message_size
editThe maximum size of the message received over the socket. The default is 20MiB
.
path
editThe path to the Unix socket that will receive events.
socket_type
editThe type to of the Unix socket that will receive events. Valid values
are stream
and datagram
. The default is stream
.
group
editThe 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.
mode
editThe 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
default (generally 0755
).
framing
editSpecify the framing used to split incoming events. Can be one of
delimiter
or rfc6587
. delimiter
uses the characters specified
in line_delimiter
to split the incoming events. rfc6587
supports
octet counting and non-transparent framing as described in
RFC6587. line_delimiter
is
used to split the events in non-transparent framing. The default is delimiter
.
line_delimiter
editSpecify the characters used to split the incoming events. The default is \n.
max_connections
editThe at most number of connections to accept at any given point in time.
timeout
editThe number of seconds of inactivity before a connection is closed. The default is 300s
.
See SSL for more information.
Metrics
editThis input exposes metrics under the HTTP monitoring endpoint.
These metrics are exposed under the /inputs
path. They can be used to
observe the activity of the input.
Metric | Description |
---|---|
|
Path of the unix socket. |
|
Total number of packets (events) that have been received. |
|
Total number of bytes received. |
|
Histogram of the time between successive packets in nanoseconds. |
|
Histogram of the time taken to process packets in nanoseconds. |
Common options
editThe following configuration options are supported by all inputs.
enabled
editUse the enabled
option to enable and disable inputs. By default, enabled is
set to true.
tags
editA 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: unix . . . tags: ["json"]
fields
editOptional 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
fields_under_root
editIf 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
editA list of processors to apply to the input data.
See Processors for information about specifying processors in your config.
pipeline
editThe 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.
keep_null
editIf this option is set to true, fields with null
values will be published in
the output document. By default, keep_null
is set to false
.
index
editIf 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.
Example value: "%{[agent.name]}-myindex-%{+yyyy.MM.dd}"
might
expand to "filebeat-myindex-2019.11.01"
.
publisher_pipeline.disable_host
editBy default, all events contain host.name
. This option can be set to true
to
disable the addition of this field to all events. The default value is false
.