File

File Output

Overview

This plugin has been designed to output logs or metrics to File.

Configuration

FileOutputConfig

add_path_suffix (*bool, optional)

Add path suffix(default: true)

Default: true

append (bool, optional)

The flushed chunk is appended to existence file or not. The default is not appended.

buffer (*Buffer, optional)

Buffer

compress (string, optional)

Compresses flushed files using gzip. No compression is performed by default.

format (*Format, optional)

Format

path (string, required)

The Path of the file. The actual path is path + time + “.log” by default.

path_suffix (string, optional)

The suffix of output result.

Default: “.log”

recompress (bool, optional)

Performs compression again even if the buffer chunk is already compressed.

Default: false

slow_flush_log_threshold (string, optional)

The threshold for chunk flush performance check. Parameter type is float, not time, default: 20.0 (seconds) If chunk flush takes longer time than this threshold, fluentd logs warning message and increases metric fluentd_output_status_slow_flush_count.

symlink_path (bool, optional)

Create symlink to temporary buffered file when buffer_type is file. This is useful for tailing file content to check logs.

Default: false

Example File output configurations

apiVersion: logging.banzaicloud.io/v1beta1
kind: Output
metadata:
  name: demo-output

spec:
  file:
    path: /tmp/logs/${tag}/%Y/%m/%d.%H.%M
    append: true
    buffer:
      timekey: 1m
      timekey_wait: 10s
      timekey_use_utc: true

Fluentd config result:

  <match **>
	@type file
	@id test_file
	add_path_suffix true
	append true
	path /tmp/logs/${tag}/%Y/%m/%d.%H.%M
	<buffer tag,time>
	  @type file
	  path /buffers/test_file.*.buffer
	  retry_forever true
	  timekey 1m
	  timekey_use_utc true
	  timekey_wait 30s
	</buffer>
  </match>