Skip to content

Logger

Benthos logging prints to stdout (or stderr if your output is stdout) and is formatted as logfmt by default. Use these configuration options to change both the logging formats as well as the destination of logs.

YAML Configurations

Logfmt to Stdout

logger:
  level: INFO
  format: logfmt
  add_timestamp: false
  static_fields:
    '@service': benthos

JSON to File

logger:
  level: WARN
  format: json
  file:
    path: ./logs/benthos.ndjson
    rotate: true

Fields

level

Set the minimum severity level for emitting logs.

Type: string

Default: "INFO"

Options: OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL, NONE.

Specify fields for optionally writing logs to a file.

Type: object

file.path

The file path to write logs to, if the file does not exist it will be created. Leave this field empty or unset to disable file based logging.

Type: string

Default: ""

file.rotate

Whether to rotate log files automatically.

Type: bool

Default: false

file.rotate_max_age_days

The maximum number of days to retain old log files based on the timestamp encoded in their filename, after which they are deleted. Setting to zero disables this mechanism.

Type: int

Default: 0