mirror of https://github.com/0rangebananaspy/authelia.git synced 2024-09-14 22:47:21 +07:00

feat(configuration): add error and warn log levels (#2050 )

This is so levels like warn and error can be used to exclude info or warn messages. Additionally there is a reasonable refactoring of logging moving the log config options to the logging key because there are a significant number of log options now. This also decouples the expvars and pprof handlers from the log level, and they are now configured by server.enable_expvars and server.enable_pprof at any logging level.

2021-06-01 14:09:50 +10:00

2.5 KiB

Raw Blame History

layout	title	parent	nav_order
default	Logging	Configuration	4

Logging

The logging section tunes the logging settings.

Configuration

logging:
  level: info
  format: text
  file_path: ""
  keep_stdout: false

Options

level

type: string {: .label .label-config .label-purple } default: info {: .label .label-config .label-blue } required: no {: .label .label-config .label-green }

Defines the level of logs used by Authelia. This level can be set to trace, debug, info, warn, or error. When setting level to trace, you will generate a large amount of log entries and expose the /debug/vars and /debug/pprof/ endpoints which should not be enabled in production.

logging:
  level: debug

format

type: string {: .label .label-config .label-purple } default: text {: .label .label-config .label-blue } required: no {: .label .label-config .label-green }

Defines the format of the logs written by Authelia. This format can be set to json or text.

logging:
  format: json

JSON format

{"level":"info","msg":"Logging severity set to info","time":"2020-01-01T00:00:00+11:00"}
{"level":"info","msg":"Authelia is listening for non-TLS connections on 0.0.0.0:9091","time":"2020-01-01T00:00:00+11:00"}

Text format

time="2020-01-01T00:00:00+11:00" level=info msg="Logging severity set to info"
time="2020-01-01T00:00:00+11:00" level=info msg="Authelia is listening for non-TLS connections on 0.0.0.0:9091"

file_path

type: string (path) {: .label .label-config .label-purple } default: "" {: .label .label-config .label-blue } required: no {: .label .label-config .label-green }

Logs can be stored in a file when file path is provided. Otherwise logs are written to standard output. When setting the level to debug or trace this will generate large amount of log entries. Administrators will need to ensure that they rotate and/or truncate the logs over time to prevent significant long-term disk usage.

logging:
  file_path: /config/authelia.log

keep_stdout

type: boolean {: .label .label-config .label-purple } default: false {: .label .label-config .label-blue } required: no {: .label .label-config .label-green }

Overrides the behaviour to redirect logging only to the file_path. If set to true logs will be written to both standard output, and the defined logging location.

logging:
  keep_stdout: true

2.5 KiB Raw Blame History