From 6daab333bf683089e21d29df8d31a1e1bbe5bb29 Mon Sep 17 00:00:00 2001 From: Alexandr Yepishev Date: Thu, 14 Nov 2024 14:50:17 +0000 Subject: [PATCH] Update Log.Level config docs --- .changeset/rude-geckos-switch.md | 5 +++++ core/config/docs/core.toml | 4 ++-- docs/CONFIG.md | 4 ++-- 3 files changed, 9 insertions(+), 4 deletions(-) create mode 100644 .changeset/rude-geckos-switch.md diff --git a/.changeset/rude-geckos-switch.md b/.changeset/rude-geckos-switch.md new file mode 100644 index 00000000000..866b1c40c63 --- /dev/null +++ b/.changeset/rude-geckos-switch.md @@ -0,0 +1,5 @@ +--- +"chainlink": minor +--- + +#bugfix Update Log.Level and MaxSize configs description in the docs diff --git a/core/config/docs/core.toml b/core/config/docs/core.toml index 083633ab57f..e0fc76f449c 100644 --- a/core/config/docs/core.toml +++ b/core/config/docs/core.toml @@ -124,7 +124,7 @@ JsonWrapperKey = 'event' # Example Headers = ['Authorization: token', 'X-SomeOther-Header: value with spaces | and a bar+*'] # Example [Log] -# Level determines both what is printed on the screen and what is written to the log file. +# Level determines only what is printed on the screen/console. This configuration does not apply to the logs that are recorded in a file (see [`Log.File`](#logfile) for more details). # # The available levels are: # - "debug": Useful for forensic debugging of issues. @@ -145,7 +145,7 @@ UnixTS = false # Default [Log.File] # Dir sets the log directory. By default, Chainlink nodes write log data to `$ROOT/log.jsonl`. Dir = '/my/log/directory' # Example -# MaxSize determines the log file's max size in megabytes before file rotation. Having this not set will disable logging to disk. If your disk doesn't have enough disk space, the logging will pause and the application will log errors until space is available again. +# MaxSize determines the log file's max size before file rotation. Having this not set or set to a value smaller than 1Mb will disable logging to disk. If your disk doesn't have enough disk space, the logging will pause and the application will log errors until space is available again. # # Values must have suffixes with a unit like: `5120mb` (5,120 megabytes). If no unit suffix is provided, the value defaults to `b` (bytes). The list of valid unit suffixes are: # diff --git a/docs/CONFIG.md b/docs/CONFIG.md index 47ba5b574cd..ff918468c07 100644 --- a/docs/CONFIG.md +++ b/docs/CONFIG.md @@ -389,7 +389,7 @@ UnixTS = false # Default ```toml Level = 'info' # Default ``` -Level determines both what is printed on the screen and what is written to the log file. +Level determines only what is printed on the screen/console. This configuration does not apply to the logs that are recorded in a file (see [`Log.File`](#logfile) for more details). The available levels are: - "debug": Useful for forensic debugging of issues. @@ -434,7 +434,7 @@ Dir sets the log directory. By default, Chainlink nodes write log data to `$ROOT ```toml MaxSize = '5120mb' # Default ``` -MaxSize determines the log file's max size in megabytes before file rotation. Having this not set will disable logging to disk. If your disk doesn't have enough disk space, the logging will pause and the application will log errors until space is available again. +MaxSize determines the log file's max size before file rotation. Having this not set or set to a value smaller than 1Mb will disable logging to disk. If your disk doesn't have enough disk space, the logging will pause and the application will log errors until space is available again. Values must have suffixes with a unit like: `5120mb` (5,120 megabytes). If no unit suffix is provided, the value defaults to `b` (bytes). The list of valid unit suffixes are: