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 4ada29c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 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
11 changes: 2 additions & 9 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 Expand Up @@ -10079,7 +10079,6 @@ OCR2CacheTTL = '1m' # Default
TxTimeout = '1m' # Default
TxRetryTimeout = '10s' # Default
TxConfirmTimeout = '30s' # Default
TxRetentionTimeout = '0s' # Default
SkipPreflight = true # Default
Commitment = 'confirmed' # Default
MaxRetries = 0 # Default
Expand Down Expand Up @@ -10149,12 +10148,6 @@ TxConfirmTimeout = '30s' # Default
```
TxConfirmTimeout is the duration to wait when confirming a tx signature, before discarding as unconfirmed.

### TxRetentionTimeout
```toml
TxRetentionTimeout = '0s' # Default
```
TxRetentionTimeout is the duration to retain transactions in storage after being marked as finalized or errored. Set to 0 to immediately drop transactions.

### SkipPreflight
```toml
SkipPreflight = true # Default
Expand Down

0 comments on commit 4ada29c

Please sign in to comment.