ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2025-11-04 20:05:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

cleanup README and example config (#247)

Browse Source 
* Indicate defaults for logging parameters
* Remove log_to_file from example config
* Remove online_delete from example config
This commit is contained in:
CJ Cobb
2022-09-07 18:28:32 -04:00
committed by GitHub
parent ac45cce5bd
commit b7cae53fcd
2 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -153,19 +153,19 @@ You must:
Clio provides several logging options, all are configurable via the config file and are detailed below. 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. `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_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_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 `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 `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 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. size-based log rotation occurs, the timer for the time-based rotation will reset.

2
example-config.json
View File

@@ -31,12 +31,10 @@
}, },
"log_level":"debug", "log_level":"debug",
"log_to_console": true, "log_to_console": true,
"log_to_file": true,
"log_directory":"./clio_log", "log_directory":"./clio_log",
"log_rotation_size": 2048, "log_rotation_size": 2048,
"log_directory_max_size": 51200, "log_directory_max_size": 51200,
"log_rotation_hour_interval": 12, "log_rotation_hour_interval": 12,
"online_delete":0,
"extractor_threads":8, "extractor_threads":8,
"read_only":false "read_only":false
} }