- Filebeat Reference: other versions:
- Filebeat overview
- Quick start: installation and configuration
- Set up and run
- Upgrade
- How Filebeat works
- Configure
- Inputs
- Multiline messages
- AWS CloudWatch
- AWS S3
- Azure Event Hub
- Azure Blob Storage
- Benchmark
- CEL
- Cloud Foundry
- CometD
- Container
- Entity Analytics
- ETW
- filestream
- GCP Pub/Sub
- Google Cloud Storage
- HTTP Endpoint
- HTTP JSON
- journald
- Kafka
- Log
- MQTT
- NetFlow
- Office 365 Management Activity API
- Redis
- Salesforce
- Stdin
- Streaming
- Syslog
- TCP
- UDP
- Unix
- winlog
- Modules
- General settings
- Project paths
- Config file loading
- Output
- Kerberos
- SSL
- Index lifecycle management (ILM)
- Elasticsearch index template
- Kibana endpoint
- Kibana dashboards
- Processors
- Define processors
- add_cloud_metadata
- add_cloudfoundry_metadata
- add_docker_metadata
- add_fields
- add_host_metadata
- add_id
- add_kubernetes_metadata
- add_labels
- add_locale
- add_network_direction
- add_nomad_metadata
- add_observer_metadata
- add_process_metadata
- add_tags
- append
- cache
- community_id
- convert
- copy_fields
- decode_base64_field
- decode_cef
- decode_csv_fields
- decode_duration
- decode_json_fields
- decode_xml
- decode_xml_wineventlog
- decompress_gzip_field
- detect_mime_type
- dissect
- dns
- drop_event
- drop_fields
- extract_array
- fingerprint
- include_fields
- move_fields
- parse_aws_vpc_flow_log
- rate_limit
- registered_domain
- rename
- replace
- script
- syslog
- timestamp
- translate_ldap_attribute
- translate_sid
- truncate_fields
- urldecode
- Autodiscover
- Internal queue
- Logging
- HTTP endpoint
- Regular expression support
- Instrumentation
- Feature flags
- filebeat.reference.yml
- Inputs
- How to guides
- Override configuration settings
- Load the Elasticsearch index template
- Change the index name
- Load Kibana dashboards
- Load ingest pipelines
- Enrich events with geoIP information
- Deduplicate data
- Parse data using an ingest pipeline
- Use environment variables in the configuration
- Avoid YAML formatting problems
- Migrate
log
input configurations tofilestream
- Migrating from a Deprecated Filebeat Module
- Modules
- Modules overview
- ActiveMQ module
- Apache module
- Auditd module
- AWS module
- AWS Fargate module
- Azure module
- CEF module
- Check Point module
- Cisco module
- CoreDNS module
- CrowdStrike module
- Cyberark PAS module
- Elasticsearch module
- Envoyproxy Module
- Fortinet module
- Google Cloud module
- Google Workspace module
- HAproxy module
- IBM MQ module
- Icinga module
- IIS module
- Iptables module
- Juniper module
- Kafka module
- Kibana module
- Logstash module
- Microsoft module
- MISP module
- MongoDB module
- MSSQL module
- MySQL module
- MySQL Enterprise module
- NATS module
- NetFlow module
- Nginx module
- Office 365 module
- Okta module
- Oracle module
- Osquery module
- Palo Alto Networks module
- pensando module
- PostgreSQL module
- RabbitMQ module
- Redis module
- Salesforce module
- Santa module
- Snyk module
- Sophos module
- Suricata module
- System module
- Threat Intel module
- Traefik module
- Zeek (Bro) Module
- ZooKeeper module
- Zoom module
- Exported fields
- ActiveMQ fields
- Apache fields
- Auditd fields
- AWS fields
- AWS CloudWatch fields
- AWS Fargate fields
- Azure fields
- Beat fields
- Decode CEF processor fields fields
- CEF fields
- Checkpoint fields
- Cisco fields
- Cloud provider metadata fields
- Coredns fields
- Crowdstrike fields
- CyberArk PAS fields
- Docker fields
- ECS fields
- Elasticsearch fields
- Envoyproxy fields
- Fortinet fields
- Google Cloud Platform (GCP) fields
- google_workspace fields
- HAProxy fields
- Host fields
- ibmmq fields
- Icinga fields
- IIS fields
- iptables fields
- Jolokia Discovery autodiscover provider fields
- Juniper JUNOS fields
- Kafka fields
- kibana fields
- Kubernetes fields
- Log file content fields
- logstash fields
- Lumberjack fields
- Microsoft fields
- MISP fields
- mongodb fields
- mssql fields
- MySQL fields
- MySQL Enterprise fields
- NATS fields
- NetFlow fields
- Nginx fields
- Office 365 fields
- Okta fields
- Oracle fields
- Osquery fields
- panw fields
- Pensando fields
- PostgreSQL fields
- Process fields
- RabbitMQ fields
- Redis fields
- s3 fields
- Salesforce fields
- Google Santa fields
- Snyk fields
- sophos fields
- Suricata fields
- System fields
- threatintel fields
- Traefik fields
- Windows ETW fields
- Zeek fields
- ZooKeeper fields
- Zoom fields
- Monitor
- Secure
- Troubleshoot
- Get help
- Debug
- Understand logged metrics
- Common problems
- Error extracting container id while using Kubernetes metadata
- Can’t read log files from network volumes
- Filebeat isn’t collecting lines from a file
- Too many open file handlers
- Registry file is too large
- Inode reuse causes Filebeat to skip lines
- Log rotation results in lost or duplicate events
- Open file handlers cause issues with Windows file rotation
- Filebeat is using too much CPU
- Dashboard in Kibana is breaking up data fields incorrectly
- Fields are not indexed or usable in Kibana visualizations
- Filebeat isn’t shipping the last line of a file
- Filebeat keeps open file handlers of deleted files for a long time
- Filebeat uses too much bandwidth
- Error loading config file
- Found unexpected or unknown characters
- Logstash connection doesn’t work
- Publishing to Logstash fails with "connection reset by peer" message
- @metadata is missing in Logstash
- Not sure whether to use Logstash or Beats
- SSL client fails to connect to Logstash
- Monitoring UI shows fewer Beats than expected
- Dashboard could not locate the index-pattern
- High RSS memory usage due to MADV settings
- Contribute to Beats
Syslog input
editSyslog input
edit[8.14.0] Deprecated in 8.14.0.
The syslog input is deprecated. Please use the syslog
processor for processing syslog messages.
The syslog
input reads Syslog events as specified by RFC 3164 and RFC 5424,
over TCP, UDP, or a Unix stream socket.
Example configurations:
filebeat.inputs: - type: syslog format: rfc3164 protocol.udp: host: "localhost:9000"
filebeat.inputs: - type: syslog format: rfc5424 protocol.tcp: host: "localhost:9000"
filebeat.inputs: - type: syslog format: auto protocol.unix: path: "/path/to/syslog.sock"
Configuration options
editThe syslog
input configuration includes format, protocol specific options, and
the Common options described later.
format
editThe syslog variant to use, rfc3164
or rfc5424
. To automatically detect the
format from the log entries, set this option to auto
. The default is
rfc3164
.
timezone
editIANA time zone name (e.g. America/New_York
) or fixed time offset (e.g.
+0200
) to use when parsing syslog timestamps that do not contain a time zone.
Local
may be specified to use the machine’s local time zone. Defaults to
Local
.
Protocol udp
:
editmax_message_size
editThe maximum size of the message received over UDP. The default is 10KiB
.
host
editThe host and UDP port to listen on for event streams.
network
editThe network type. Acceptable values are: "udp" (default), "udp4", "udp6"
read_buffer
editThe size of the read buffer on the UDP socket. If not specified the default from the operating system will be used.
timeout
editThe read and write timeout for socket operations. The default is 5m
.
Protocol tcp
:
editmax_message_size
editThe maximum size of the message received over TCP. The default is 20MiB
.
host
editThe host and TCP port to listen on for event streams.
network
editThe network type. Acceptable values are: "tcp" (default), "tcp4", "tcp6"
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 remote connection is closed. The default is 300s
.
ssl
editConfiguration options for SSL parameters like the certificate, key and the certificate authorities to use.
See SSL for more information.
Protocol unix
:
editmax_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.
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: syslog . . . 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: syslog . . . 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
.
On this page
- Configuration options
format
timezone
- Protocol
udp
: max_message_size
host
network
read_buffer
timeout
- Protocol
tcp
: max_message_size
host
network
framing
line_delimiter
max_connections
timeout
ssl
- Protocol
unix
: max_message_size
path
socket_type
group
mode
framing
line_delimiter
max_connections
timeout
- Common options
enabled
tags
fields
fields_under_root
processors
pipeline
keep_null
index
publisher_pipeline.disable_host