Skip to content

Commit

Permalink
Update Log.Level config docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chudilka1 committed Nov 14, 2024
1 parent 1956151 commit 6daab33
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
5 changes: 5 additions & 0 deletions .changeset/rude-geckos-switch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"chainlink": minor
---

#bugfix Update Log.Level and MaxSize configs description in the docs
4 changes: 2 additions & 2 deletions core/config/docs/core.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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:
#
Expand Down
4 changes: 2 additions & 2 deletions docs/CONFIG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:

Expand Down

0 comments on commit 6daab33

Please sign in to comment.