Parsers

Parsers are an important component of Fluent Bit, with them you can take any unstructured log entry and give them a structure that makes easier it processing and further filtering.

The parser engine is fully configurable and can process log entries based in two types of format:

By default, Fluent Bit provides a set of pre-configured parsers that can be used for different use cases such as logs from:

  • Apache
  • Nginx
  • Docker
  • Syslog rfc5424
  • Syslog rfc3164

Parsers are defined in one or multiple configuration files that are loaded at start time, either from the command line or through the main Fluent Bit configuration file.

Note: if you are using Regular Expressions note that Fluent Bit uses Ruby based regular expressions and we encourage to use Rubular web site as an online editor to test them.

Configuration Parameters

Multiple parsers can be defined and each section have it own properties. The following table describes the available options for each parser definition:

Key Description
Name Set an unique name for the parser in question.
Format Specify the format of the parser, the available options here are: json, regex, ltsv or [logfmt][logfmt.md].
Regex If format is regex, this option must be set specifying the Ruby Regular Expression that will be used to parse and compose the structured message.
Time_Key If the log entry provides a field with a timestamp, this option specify the name of that field.
Time_Format Specify the format of the time field so it can be recognized and analyzed properly. Fluent-bit uses strptime(3) to parse time so you can ferer to strptime documentation for available modifiers.
Time_Offset Specify a fixed UTC time offset (e.g. -0600, +0200, etc.) for local dates.
Time_Keep By default when a time key is recognized and parsed, the parser will drop the original time field. Enabling this option will make the parser to keep the original time field and it value in the log entry.
Types Specify the data type of parsed field. The syntax is types <field_name_1>:<type_name_1> <field_name_2>:<type_name_2> .... The supported types are string(default), integer, bool, float, hex.
Decode_Field Decode a field value, the only decoder available is json. The syntax is: Decode_Field json <field_name>.

Parsers Configuration File

All parsers must be defined in a parsers.conf file, not in the Fluent Bit global configuration file. The parsers file expose all parsers available that can be used by the Input plugins that are aware of this feature. A parsers file can have multiple entries like this:

  1. [PARSER]
  2.     Name        docker
  3.     Format      json
  4.     Time_Key    time
  5.     Time_Format %Y-%m-%dT%H:%M:%S.%L
  6.     Time_Keep   On
  8. [PARSER]
  9.     Name        syslog-rfc5424
  10.     Format      regex
  11.     Regex       ^\<(?<pri>[0-9]{1,5})\>1 (?<time>[^ ]+) (?<host>[^ ]+) (?<ident>[^ ]+) (?<pid>[-0-9]+) (?<msgid>[^ ]+) (?<extradata>(\[(.*)\]|-)) (?<message>.+)$
  12.     Time_Key    time
  13.     Time_Format %Y-%m-%dT%H:%M:%S.%L
  14.     Time_Keep   On
  15.     Types pid:integer

For more information about the parsers available, please refer to the default parsers file distributed with Fluent Bit source code:

https://github.com/fluent/fluent-bit/blob/master/conf/parsers.conf

Time Resolution and Fractional Seconds

Time resolution and it format supported are handled by using the strftime(3) libc system function.

In addition, we extended our time resolution to support fractional seconds like 2017-05-17T15:44:31.187512963Z. Since Fluent Bit v0.12 we have full support for nanoseconds resolution, the %L format option for Time_Format is provided as a way to indicate that content must be interpreted as fractional seconds.

Note: The option %L is only valid when used after seconds (%S) or seconds since the Epoch (%s), e.g: %S.%L or %s.%L