From e87acabfe548684213fdeb9175bc620b8f15646e Mon Sep 17 00:00:00 2001 From: Dimitry Kolyshev Date: Thu, 6 Jul 2023 10:09:38 +0300 Subject: [PATCH] Pull request: log-yaml-conf Squashed commit of the following: commit 6f560190ac646ff4d0aa5df63d339fe25d1976ea Author: Dimitry Kolyshev Date: Tue Jul 4 13:19:24 2023 +0400 Configuration: imp docs commit 31414a7480bd72808bfab92e22413ced41a17f80 Author: Dimitry Kolyshev Date: Fri Jun 30 11:10:25 2023 +0400 Configuration: imp docs commit eb02eccefbdb655d6782acbf33aea5637e62fe1f Author: Dimitry Kolyshev Date: Thu Jun 29 16:39:53 2023 +0400 Configuration: imp docs commit 07cbe5b39c30f2779fab76b81e85cd7419f00b85 Merge: 614f73b 2acda96 Author: Dimitry Kolyshev Date: Thu Jun 29 16:31:40 2023 +0400 Merge remote-tracking branch 'origin/master' into log-yaml-conf commit 614f73b0030b8b44d246de1b58277fecd27d9568 Author: Dimitry Kolyshev Date: Thu Jun 29 16:17:00 2023 +0400 Configuration: imp docs commit 7daa8ed78f55f4e3d6237aaf506bd54c498943e7 Author: Dimitry Kolyshev Date: Thu Jun 29 13:15:31 2023 +0400 Configuration: log object --- Configuration.md | 30 +++++++++++++++++++++++------- FAQ.md | 6 +++--- 2 files changed, 26 insertions(+), 10 deletions(-) diff --git a/Configuration.md b/Configuration.md index 09516d5..6ad8ed0 100644 --- a/Configuration.md +++ b/Configuration.md @@ -683,13 +683,29 @@ Settings are stored in [YAML format](https://en.wikipedia.org/wiki/YAML), possib - `dhcp` — Check AdGuard Home's DHCP leases for client's address. - `hosts` — Follow the operating system's hosts files. - **Log settings** - - `log_file` — Path to the log file. If empty, writes to stdout, if `syslog` -- system log (or eventlog on Windows). - - `log_compress` — Compress determines if the rotated log files should be compressed using gzip (default: false) - - `log_localtime` — If the time used for formatting the timestamps in is the computer's local time (default: false [UTC]) - - `log_max_backups` — Maximum number of old log files to retain (MaxAge may still cause them to get deleted) (default: 0, which retains all old log files) - - `log_max_size` — Maximum size in megabytes of the log file before it gets rotated (default: 100 MB) - - `log_max_age` — MaxAge is the maximum number of days to retain old log files (default: 3) - - `verbose` — Enable our disables debug verbose output (default: false) + - `log` (**since v0.107.34**): Log settings. + - `file` (**since v0.107.34**): Path to the log file. If empty, writes to + stdout, if `syslog` writes system log (or eventlog on Windows). + - `compress` (**since v0.107.34**): Compress determines if the rotated log + files should be compressed using gzip (default: false). + - `local_time` (**since v0.107.34**): If the time used for formatting the + timestamps in is the computer's local time (default: false [UTC]). + - `max_backups` (**since v0.107.34**): Maximum number of old log files to + retain (MaxAge may still cause them to get deleted) (default: 0, which + retains all old log files). + - `max_size` (**since v0.107.34**): Maximum size in megabytes of the log + file before it gets rotated (default: 100 MB). + - `max_age` (**since v0.107.34**): MaxAge is the maximum number of days to + retain old log files (default: 3). + - `verbose` (**since v0.107.34**): Enable our disables debug verbose output + (default: false). + - `log_file` (**before v0.107.34**): See `log.file` above. + - `log_compress` (**before v0.107.34**): See `log.compress` above. + - `log_localtime` (**before v0.107.34**): See `log.local_time` above. + - `log_max_backups` (**before v0.107.34**): See `log.max_backups` above. + - `log_max_size` (**before v0.107.34**): See `log.max_size` above. + - `log_max_age` (**before v0.107.34**): See `log.max_age` above. + - `verbose` (**before v0.107.34**): See `log.verbose` above. Removing an entry from settings file will reset it to the default value. Deleting the file will reset all settings to the default values. diff --git a/FAQ.md b/FAQ.md index d12baea..396ad58 100644 --- a/FAQ.md +++ b/FAQ.md @@ -118,11 +118,11 @@ required. Here's how to enable it: 1. Configure AdGuard Home to write verbose-level logs: 1. Open `AdGuardHome.yaml` in your editor. - - 1. Set `log_file` to the desired path of the log file, for example + 1. Set `log.file` to the desired path of the log file, for example `/tmp/aghlog.txt`. Note that the directory must exist. + 1. Set `log.verbose` to `true`. - 1. Set `verbose` to `true`. + **NOTE:** Before v0.107.34 use `verbose` and `log_file` properties. 1. Restart AdGuard Home and reproduce the issue: