From b7cae53fcda02f5caf53ef6e7907035c8a970b76 Mon Sep 17 00:00:00 2001 From: CJ Cobb <46455409+cjcobb23@users.noreply.github.com> Date: Wed, 7 Sep 2022 18:28:32 -0400 Subject: [PATCH] cleanup README and example config (#247) * Indicate defaults for logging parameters * Remove log_to_file from example config * Remove online_delete from example config --- README.md | 8 ++++---- example-config.json | 2 -- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0d7976ef..fc65df4e 100644 --- a/README.md +++ b/README.md @@ -153,19 +153,19 @@ You must: Clio provides several logging options, all are configurable via the config file and are detailed below. `log_level`: The minimum level of severity at which the log message will be outputted. -Severity options are `trace`, `debug`, `info`, `warning`, `error`, `fatal`. +Severity options are `trace`, `debug`, `info`, `warning`, `error`, `fatal`. Defaults to `info`. `log_to_console`: Enable/disable log output to console. Options are `true`/`false`. Defaults to true. `log_directory`: Path to the directory where log files are stored. If such directory doesn't exist, Clio will create it. If not specified, logs are not written to a file. -`log_rotation_size`: The max size of the log file in **megabytes** before it will rotate into a smaller file. +`log_rotation_size`: The max size of the log file in **megabytes** before it will rotate into a smaller file. Defaults to 2GB. `log_directory_max_size`: The max size of the log directory in **megabytes** before old log files will be -deleted to free up space. +deleted to free up space. Defaults to 50GB. `log_rotation_hour_interval`: The time interval in **hours** after the last log rotation to automatically -rotate the current log file. +rotate the current log file. Defaults to 12 hours. Note, time-based log rotation occurs dependently on size-based log rotation, where if a size-based log rotation occurs, the timer for the time-based rotation will reset. diff --git a/example-config.json b/example-config.json index 2ecf0553..34246bc0 100644 --- a/example-config.json +++ b/example-config.json @@ -31,12 +31,10 @@ }, "log_level":"debug", "log_to_console": true, - "log_to_file": true, "log_directory":"./clio_log", "log_rotation_size": 2048, "log_directory_max_size": 51200, "log_rotation_hour_interval": 12, - "online_delete":0, "extractor_threads":8, "read_only":false }