- Filebeat Reference: other versions:
- Overview
- Getting Started With Filebeat
- Step 1: Install Filebeat
- Step 2: Configure Filebeat
- Step 3: Configure Filebeat to use Logstash
- Step 4: Load the index template in Elasticsearch
- Step 5: Set up the Kibana dashboards
- Step 6: Start Filebeat
- Step 7: View the sample Kibana dashboards
- Quick start: modules for common log formats
- Repositories for APT and YUM
- Setting up and running Filebeat
- Upgrading Filebeat
- How Filebeat works
- Configuring Filebeat
- Specify which modules to run
- Configure inputs
- Manage multiline messages
- Specify general settings
- Load external configuration files
- Configure the internal queue
- Configure the output
- Set up index lifecycle management
- Load balance the output hosts
- Specify SSL settings
- Filter and enhance the exported data
- Parse data by using ingest node
- Enrich events with geoIP information
- Set up project paths
- Set up the Kibana endpoint
- Load the Kibana dashboards
- Load the Elasticsearch index template
- Configure logging
- Use environment variables in the configuration
- Autodiscover
- YAML tips and gotchas
- Regular expression support
- HTTP Endpoint
- filebeat.reference.yml
- Beats central management
- Modules
- Exported fields
- Alias fields
- Apache2 fields
- Auditd fields
- Beat fields
- Cloud provider metadata fields
- Docker fields
- elasticsearch fields
- haproxy fields
- Host fields
- Icinga fields
- IIS fields
- Kafka fields
- kibana fields
- Kubernetes fields
- Log file content fields
- logstash fields
- mongodb fields
- MySQL fields
- Nginx fields
- Osquery fields
- PostgreSQL fields
- Redis fields
- System fields
- Traefik fields
- Monitoring Filebeat
- Securing Filebeat
- Troubleshooting
- Migrating from Logstash Forwarder to Filebeat
- Contributing to Beats
Regular expression support
editRegular expression support
editFilebeat regular expression support is based on RE2.
Filebeat has several configuration options that accept regular expressions.
For example, multiline.pattern
, include_lines
, exclude_lines
, and
exclude_files
all accept regular expressions. Some options, however, such as
the input paths
option, accept only glob-based paths.
Before using a regular expression in the config file, refer to the documentation to verify that the option you are setting accepts a regular expression.
We recommend that you wrap regular expressions in single quotation marks to work around YAML’s string escaping rules. For example, '^\[?[0-9][0-9]:?[0-9][0-9]|^[[:graph:]]+'
.
For more examples of supported regexp patterns, see Managing Multiline Messages. Although the examples pertain to Filebeat, the regexp patterns are applicable to other use cases.
The following patterns are supported:
Pattern | Description |
---|---|
|
single character |
|
any character |
|
character class |
|
negated character class |
|
ASCII character class |
|
negated ASCII character class |
|
Perl character class |
|
negated Perl character class |
|
Unicode character class (one-letter name) |
|
Unicode character class |
|
negated Unicode character class (one-letter name) |
|
negated Unicode character class |
|
|
|
|
|
zero or more |
|
one or more |
|
zero or one |
|
|
|
|
|
exactly |
|
zero or more |
|
one or more |
|
zero or one |
|
|
|
|
|
exactly |
|
numbered capturing group (submatch) |
|
named & numbered capturing group (submatch) |
|
non-capturing group |
|
set flags within current group, non-capturing |
|
set flags during re, non-capturing |
|
case-insensitive (default false) |
|
multi-line mode: |
|
let |
|
ungreedy: swap meaning of |
|
at beginning of text or line ( |
|
at end of text (like |
|
at beginning of text |
|
at ASCII word boundary ( |
|
not at ASCII word boundary |
|
at end of text |
|
bell (same as |
|
form feed (same as |
|
horizontal tab (same as |
|
newline (same as |
|
carriage return (same as |
|
vertical tab character (same as |
|
literal |
|
octal character code (up to three digits) |
|
two-digit hex character code |
|
hex character code |
|
literal text |
|
alphanumeric (same as |
|
alphabetic (same as |
|
ASCII (same as |
|
blank (same as |
|
control (same as |
|
digits (same as |
|
graphical (same as |
|
lower case (same as |
|
printable (same as |
|
punctuation (same as |
|
whitespace (same as |
|
upper case (same as |
|
word characters (same as |
|
hex digit (same as |
|
digits (same as |
|
not digits (same as |
|
whitespace (same as |
|
not whitespace (same as |
|
word characters (same as |
|
not word characters (same as |