Buffer

Buffer

disabled (bool, optional)

Disable buffer section (default: false)

Default: false,hidden

type (string, optional)

Fluentd core bundles memory and file plugins. 3rd party plugins are also available when installed.

Default: -

tags (*string, optional)

When tag is specified as buffer chunk key, output plugin writes events into chunks separately per tags.

Default: tag,time

path (string, optional)

The path where buffer chunks are stored. The ‘*’ is replaced with random characters. It’s highly recommended to leave this default.

Default: operator generated

chunk_limit_size (string, optional)

The max size of each chunks: events will be written into chunks until the size of chunks become this size (default: 8MB)

Default: 8MB

chunk_limit_records (int, optional)

The max number of events that each chunks can store in it

Default: -

total_limit_size (string, optional)

The size limitation of this buffer plugin instance. Once the total size of stored buffer reached this threshold, all append operations will fail with error (and data will be lost)

Default: -

queue_limit_length (int, optional)

The queue length limitation of this buffer plugin instance

Default: -

chunk_full_threshold (string, optional)

The percentage of chunk size threshold for flushing. output plugin will flush the chunk when actual size reaches chunk_limit_size * chunk_full_threshold (== 8MB * 0.95 in default)

Default: -

queued_chunks_limit_size (int, optional)

Limit the number of queued chunks. If you set smaller flush_interval, e.g. 1s, there are lots of small queued chunks in buffer. This is not good with file buffer because it consumes lots of fd resources when output destination has a problem. This parameter mitigates such situations.

Default: -

compress (string, optional)

If you set this option to gzip, you can get Fluentd to compress data records before writing to buffer chunks.

Default: -

flush_at_shutdown (bool, optional)

The value to specify to flush/write all buffer chunks at shutdown, or not

Default: -

flush_mode (string, optional)

Default: default (equals to lazy if time is specified as chunk key, interval otherwise) lazy: flush/write chunks once per timekey interval: flush/write chunks per specified time via flush_interval immediate: flush/write chunks immediately after events are appended into chunks

Default: -

flush_interval (string, optional)

Default: 60s

Default: -

flush_thread_count (int, optional)

The number of threads of output plugins, which is used to write chunks in parallel

Default: -

flush_thread_interval (string, optional)

The sleep interval seconds of threads to wait next flush trial (when no chunks are waiting)

Default: -

flush_thread_burst_interval (string, optional)

The sleep interval seconds of threads between flushes when output plugin flushes waiting chunks next to next

Default: -

delayed_commit_timeout (string, optional)

The timeout seconds until output plugin decides that async write operation fails

Default: -

overflow_action (string, optional)

How output plugin behaves when its buffer queue is full throw_exception: raise exception to show this error in log block: block processing of input plugin to emit events into that buffer drop_oldest_chunk: drop/purge oldest chunk to accept newly incoming chunk

Default: -

retry_timeout (string, optional)

The maximum seconds to retry to flush while failing, until plugin discards buffer chunks

Default: -

retry_forever (*bool, optional)

If true, plugin will ignore retry_timeout and retry_max_times options and retry flushing forever

Default: true

retry_max_times (int, optional)

The maximum number of times to retry to flush while failing

Default: -

retry_secondary_threshold (string, optional)

The ratio of retry_timeout to switch to use secondary while failing (Maximum valid value is 1.0)

Default: -

retry_type (string, optional)

exponential_backoff: wait seconds will become large exponentially per failures periodic: output plugin will retry periodically with fixed intervals (configured via retry_wait)

Default: -

retry_wait (string, optional)

Seconds to wait before next retry to flush, or constant factor of exponential backoff

Default: -

retry_exponential_backoff_base (string, optional)

The base number of exponential backoff for retries

Default: -

retry_max_interval (string, optional)

The maximum interval seconds for exponential backoff between retries while failing

Default: -

retry_randomize (bool, optional)

If true, output plugin will retry after randomized interval not to do burst retries

Default: -

disable_chunk_backup (bool, optional)

Instead of storing unrecoverable chunks in the backup directory, just discard them. This option is new in Fluentd v1.2.6.

Default: -

timekey (string, required)

Output plugin will flush chunks per specified time (enabled when time is specified in chunk keys)

Default: 10m

timekey_wait (string, optional)

Output plugin writes chunks after timekey_wait seconds later after timekey expiration

Default: 1m

timekey_use_utc (bool, optional)

Output plugin decides to use UTC or not to format placeholders using timekey

Default: -

timekey_zone (string, optional)

The timezone (-0700 or Asia/Tokyo) string for formatting timekey placeholders

Default: -