ClusterInput

Set the address to listen to, default: 0.0.0.0

Set the port to listen to, default: 25826

Set the data specification file,default: /usr/share/collectd/types.db

Config holds any unsupported plugins classic configurations, if ConfigFileFormat is set to yaml, this filed will be ignored

YamlConfig holds the unsupported plugins yaml configurations, it only works when the ConfigFileFormat is yaml

Dummy JSON record.

Events number generated per second.

Sample events to generate.

Tag name associated to all records coming from this plugin.

Specify the whitelist of paths to be able to access paths from WASM programs.

Size of the buffer (check unit sizes for allowed values)

Polling interval (nanoseconds).

Polling interval (seconds).

Specify the name of a parser to interpret the entry as a structured message.

Indicates whether to run this input in its own thread. Default: false.

The place of a WASM program file.

Size of the stack size of Wasm execution. Review unit sizes for allowed values.

The rate at which metrics are collected from the host operating system. default is 2 seconds.

Scrape metrics upon start, useful to avoid waiting for 'scrape_interval' for the first round of metrics.

Specify maximum buffer memory size used to receive a forward message. The value must be according to the Unit Size specification.

Set the initial buffer size to store incoming data. This value is used too to increase buffer size as required. The value must be according to the Unit Size specification.

Listener network interface.

Port for forward plugin instance.

in_forward uses the tag value for incoming logs. If not set it uses tag from incoming log.

Adds the prefix to incoming event's tag

Threaded mechanism allows input plugin to run in a separate thread which helps to desaturate the main pipeline.

Specify the path to unix socket to receive a forward message. If set, Listen and port are ignnored.

Set the permission of unix socket file.

This sets the chunk size for incoming incoming JSON messages. These chunks are then stored/managed in the space available by buffer_max_size,default 512K.

Specify the maximum buffer size in KB to receive a JSON message,default 4M.

The address to listen on,default 0.0.0.0

The port for Fluent Bit to listen on,default 9880

Add an HTTP header key/value pair on success. Multiple headers can be set. Example: X-Custom custom-answer.

It allows to set successful response code. 200, 201 and 204 are supported,default 201.

Specify the key name to overwrite a tag. If set, the tag will be overwritten by a value of the key.

Set a database file to keep track of recorded Kubernetes events

Set a database sync method. values: extra, full, normal and off

Set the polling interval for each channel (sub seconds: nanoseconds).

Set the polling interval for each channel.

CA certificate file

Absolute path to scan for certificate files

Kubernetes namespace to query events from. Gets events from all namespaces by default

kubernetes limit parameter for events query, no limit applied when set to 0.

Kubernetes retention time for events.

Token file

configurable 'time to live' for the K8s token. By default, it is set to 600 seconds. After this time, the token is reloaded from Kube_Token_File or the Kube_Token_Command.

API Server end-point

Specifies if the input plugin should be paused (stop ingesting new data) when the storage.max_chunks_up value is reached.

Specifies the buffering mechanism for use with the input plugin, requires storage.path to be set in the service.

Tag name associated to all records coming from this plugin.

Debug level between 0 (nothing) and 4 (every detail).

When enabled, turns on certificate validation when connecting to the Kubernetes API server.

Set optional TLS virtual host.

Listener network interface, default: 0.0.0.0

TCP port where listening for connections, default: 1883

Name of the target host or IP address to check, default: localhost

Turn on NGINX plus mode,default: true

Port of the target nginx service to connect to, default: 80

The URL of the Stub Status Handler,default: /status

The rate at which metrics are collected from the host operating system, default is 5 seconds.

Tag name associated to all records coming from this plugin.

This sets the chunk size for incoming incoming JSON messages. These chunks are then stored/managed in the space available by buffer_max_size(default 512K).

Specify the maximum buffer size in KB to receive a JSON message(default 4M).

The address to listen on,default 0.0.0.0

The port for Fluent Bit to listen on.default 4318.

Route trace data as a log message(default false).

It allows to set successful response code. 200, 201 and 204 are supported(default 201).

opentelemetry uses the tag value for incoming metrics.

If true, tag will be created from uri. e.g. v1_metrics from /v1/metrics

Specify the key name to overwrite a tag. If set, the tag will be overwritten by a value of the key.

The host of the prometheus metric endpoint that you want to scrape

The metrics URI endpoint, that must start with a forward slash, deflaut: /metrics

The port of the promethes metric endpoint that you want to scrape

The interval to scrape metrics, default: 10s

Tag name associated to all records coming from this plugin

Listener network interface, default: 0.0.0.0

UDP port where listening for connections, default: 8125

By default the buffer to store the incoming Syslog messages, do not allocate the maximum memory allowed, instead it allocate memory when is required. The rounds of allocations are set by Buffer_Chunk_Size. If not set, Buffer_Chunk_Size is equal to 32000 bytes (32KB).

Specify the maximum buffer size to receive a Syslog message. If not set, the default size will be the value of Buffer_Chunk_Size.

If Mode is set to tcp or udp, specify the network interface to bind, default: 0.0.0.0

Defines transport protocol mode: unix_udp (UDP over Unix socket), unix_tcp (TCP over Unix socket), tcp or udp

Specify an alternative parser for the message. If Mode is set to tcp or udp then the default parser is syslog-rfc5424 otherwise syslog-rfc3164-local is used. If your syslog messages have fractional seconds set this Parser value to syslog-rfc5424 instead.

If Mode is set to unix_tcp or unix_udp, set the absolute path to the Unix socket file.

If Mode is set to tcp or udp, specify the TCP port to listen for incoming connections.

Specify the maximum socket receive buffer size. If not set, the default value is OS-dependant, but generally too low to accept thousands of syslog messages per second without loss on udp or unix_udp sockets. Note that on Linux the value is capped by sysctl net.core.rmem_max.

Specify the key where the source address will be injected.

Specify a tag to route incoming logs through different parsers to different outputs.

If Mode is set to unix_tcp or unix_udp, set the permission of the Unix socket file, default: 0644

Specify the database file to keep track of monitored files and offsets.

Set a default synchronization (I/O) method. values: Extra, Full, Normal, Off. This flag affects how the internal SQLite engine do synchronization to disk, for more details about each option please refer to this section. note: this option was introduced on Fluent Bit v1.4.6.

When Fluent Bit starts, the Journal might have a high number of logs in the queue. In order to avoid delays and reduce memory usage, this option allows to specify the maximum number of log entries that can be processed per round. Once the limit is reached, Fluent Bit will continue processing the remaining log entries once Journald performs the notification.

Set a maximum number of fields (keys) allowed per record.

Optional path to the Systemd journal directory, if not set, the plugin will use default paths to read local-only logs.

Specifies if the input plugin should be paused (stop ingesting new data) when the storage.max_chunks_up value is reached.

Start reading new entries. Skip entries already stored in Journald.

Set an optional location in the file system to store streams and chunks of data. If this parameter is not set, Input plugins can only use in-memory buffering.

Specify the buffering mechanism to use. It can be memory or filesystem

Remove the leading underscore of the Journald field (key). For example the Journald field _PID becomes the key PID.

Allows to perform a query over logs that contains a specific Journald key/value pairs, e.g: _SYSTEMD_UNIT=UNIT. The Systemd_Filter option can be specified multiple times in the input section to apply multiple filters as required.

Define the filter type when Systemd_Filter is specified multiple times. Allowed values are And and Or. With And a record is matched only when all of the Systemd_Filter have a match. With Or a record is matched when any of the Systemd_Filter has a match.

The tag is used to route messages but on Systemd plugin there is an extra functionality: if the tag includes a star/wildcard, it will be expanded with the Systemd Unit file (e.g: host.* => host.UNIT_NAME).

Set the initial buffer size to read files data. This value is used too to increase buffer size. The value must be according to the Unit Size specification.

Set the limit of the buffer size per monitored file. When a buffer needs to be increased (e.g: very long lines), this value is used to restrict how much the memory buffer can grow. If reading a file exceed this limit, the file is removed from the monitored file list The value must be according to the Unit Size specification.

Specify the database file to keep track of monitored files and offsets.

Specify that the database will be accessed only by Fluent Bit.

Set a default synchronization (I/O) method. Values: Extra, Full, Normal, Off.

DisableInotifyWatcher will disable inotify and use the file stat watcher instead.

If enabled, the plugin will recombine split Docker log lines before passing them to any parser as configured above. This mode cannot be used at the same time as Multiline.

Wait period time in seconds to flush queued unfinished split lines.

Specify an optional parser for the first line of the docker multiline mode. The parser name to be specified must be registered in the parsers.conf file.

Set one or multiple shell patterns separated by commas to exclude files matching a certain criteria, e.g: exclude_path=*.gz,*.zip

Ignores records which are older than this time in seconds. Supports m,h,d (minutes, hours, days) syntax. Default behavior is to read all records from specified files. Only available when a Parser is specificied and it can parse the time of a record.

When a message is unstructured (no parser applied), it's appended as a string under the key name log. This option allows to define an alternative name for that key.

Set a limit of memory that Tail plugin can use when appending data to the Engine. If the limit is reach, it will be paused; when the data is flushed it resumes.

If enabled, the plugin will try to discover multiline messages and use the proper parsers to compose the outgoing messages. Note that when this option is enabled the Parser option is not used.

Wait period time in seconds to process queued multiline messages

This will help to reassembly multiline messages originally split by Docker or CRI Specify one or Multiline Parser definition to apply to the content.

If enabled, Fluent Bit appends the offset of the current monitored file as part of the record. The value assigned becomes the key in the map

Specify the name of a parser to interpret the entry as a structured message.

Name of the parser that matchs the beginning of a multiline message. Note that the regular expression defined in the parser must include a group name (named capture)

Optional-extra parser to interpret and structure multiline entries. This option can be used to define multiple parsers.

Pattern specifying a specific log files or multiple ones through the use of common wildcards.

If enabled, it appends the name of the monitored file as part of the record. The value assigned becomes the key in the map.

Specifies if the input plugin should be paused (stop ingesting new data) when the storage.max_chunks_up value is reached.

For new discovered files on start (without a database offset/position), read the content from the head of the file, not tail.

The interval of refreshing the list of watched files in seconds.

Specify the number of extra time in seconds to monitor a file once is rotated in case some pending data is flushed.

Skips empty lines in the log file from any further processing or output.

When a monitored file reach it buffer capacity due to a very long line (Buffer_Max_Size), the default behavior is to stop monitoring that file. Skip_Long_Lines alter that behavior and instruct Fluent Bit to skip long lines and continue processing other lines that fits into the buffer size.

Set an optional location in the file system to store streams and chunks of data. If this parameter is not set, Input plugins can only use in-memory buffering.

Specify the buffering mechanism to use. It can be memory or filesystem

Set a tag (with regex-extract fields) that will be placed on lines read. E.g. kube.<namespace_name>.<pod_name>.<container_name>

Set a regex to exctract fields from the file

Threaded mechanism allows input plugin to run in a separate thread which helps to desaturate the main pipeline.

Specify the maximum buffer size in KB to receive a JSON message. If not set, the default size will be the value of Chunk_Size.

By default the buffer to store the incoming JSON messages, do not allocate the maximum memory allowed, instead it allocate memory when is required. The rounds of allocations are set by Chunk_Size in KB. If not set, Chunk_Size is equal to 32 (32KB).

Specify the expected payload format. It support the options json and none. When using json, it expects JSON maps, when is set to none, it will split every record using the defined Separator (option below).

Listener network interface,default 0.0.0.0

TCP port where listening for connections,default 5170

When the expected Format is set to none, Fluent Bit needs a separator string to split the records. By default it uses the breakline character (LF or 0x10).

BufferSize Specify the maximum buffer size in KB to receive a JSON message. If not set, the default size will be the value of Chunk_Size.

By default the buffer to store the incoming JSON messages, do not allocate the maximum memory allowed, instead it allocate memory when is required. The rounds of allocations are set by Chunk_Size in KB. If not set, Chunk_Size is equal to 32 (32KB).

Format Specify the expected payload format. It support the options json and none. When using json, it expects JSON maps, when is set to none, it will split every record using the defined Separator (option below).

Listen Listener network interface, default: 0.0.0.0

Port Specify the UDP port where listening for connections, default: 5170

Separator When the expected Format is set to none, Fluent Bit needs a separator string to split the records. By default it uses the breakline character (LF or 0x10).

SourceAddressKey Specify the key where the source address will be injected.

Threaded mechanism allows input plugin to run in a separate thread which helps to desaturate the main pipeline.