Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make Pipeline.VerboseLogging turned on by default #12570

Merged
merged 1 commit into from
Mar 25, 2024
Merged

Make Pipeline.VerboseLogging turned on by default #12570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .changeset/afraid-baboons-nail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
"chainlink": patch
---

VerboseLogging is now turned on by default.

You may disable if this results in excessive log volume. Disable like so:

```
[Pipeline]
VerboseLogging = false
```
10 changes: 5 additions & 5 deletions core/config/docs/core.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,11 +281,11 @@ ReaperThreshold = '24h' # Default
# ResultWriteQueueDepth controls how many writes will be buffered before subsequent writes are dropped, for jobs that write results asynchronously for performance reasons, such as OCR.
ResultWriteQueueDepth = 100 # Default
# VerboseLogging enables detailed logging of pipeline execution steps.
# This is disabled by default because it increases log volume for pipeline
# runs, but can be useful for debugging failed runs without relying on the UI
# or database. Consider enabling this if you disabled run saving by setting
# MaxSuccessfulRuns to zero.
VerboseLogging = false # Default
# This can be useful for debugging failed runs without relying on the UI
# or database.
#
# You may disable if this results in excessive log volume.
VerboseLogging = true # Default

[JobPipeline.HTTPRequest]
# DefaultTimeout defines the default timeout for HTTP requests made by `http` and `bridge` adapters.
Expand Down
4 changes: 2 additions & 2 deletions core/services/chainlink/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ func TestConfig_Marshal(t *testing.T) {
ReaperInterval: commoncfg.MustNewDuration(4 * time.Hour),
ReaperThreshold: commoncfg.MustNewDuration(7 * 24 * time.Hour),
ResultWriteQueueDepth: ptr[uint32](10),
VerboseLogging: ptr(true),
VerboseLogging: ptr(false),
HTTPRequest: toml.JobPipelineHTTPRequest{
MaxSize: ptr[utils.FileSize](100 * utils.MB),
DefaultTimeout: commoncfg.MustNewDuration(time.Minute),
Expand Down Expand Up @@ -846,7 +846,7 @@ MaxSuccessfulRuns = 123456
ReaperInterval = '4h0m0s'
ReaperThreshold = '168h0m0s'
ResultWriteQueueDepth = 10
VerboseLogging = true
VerboseLogging = false

[JobPipeline.HTTPRequest]
DefaultTimeout = '1m0s'
Expand Down
2 changes: 1 addition & 1 deletion core/services/chainlink/testdata/config-empty-effective.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ MaxSuccessfulRuns = 10000
ReaperInterval = '1h0m0s'
ReaperThreshold = '24h0m0s'
ResultWriteQueueDepth = 100
VerboseLogging = false
VerboseLogging = true

[JobPipeline.HTTPRequest]
DefaultTimeout = '15s'
Expand Down
2 changes: 1 addition & 1 deletion core/services/chainlink/testdata/config-full.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ MaxSuccessfulRuns = 123456
ReaperInterval = '4h0m0s'
ReaperThreshold = '168h0m0s'
ResultWriteQueueDepth = 10
VerboseLogging = true
VerboseLogging = false

[JobPipeline.HTTPRequest]
DefaultTimeout = '1m0s'
Expand Down
2 changes: 1 addition & 1 deletion core/services/chainlink/testdata/config-multi-chain-effective.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ MaxSuccessfulRuns = 10000
ReaperInterval = '1h0m0s'
ReaperThreshold = '24h0m0s'
ResultWriteQueueDepth = 100
VerboseLogging = false
VerboseLogging = true

[JobPipeline.HTTPRequest]
DefaultTimeout = '30s'
Expand Down
2 changes: 1 addition & 1 deletion core/web/resolver/testdata/config-empty-effective.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ MaxSuccessfulRuns = 10000
ReaperInterval = '1h0m0s'
ReaperThreshold = '24h0m0s'
ResultWriteQueueDepth = 100
VerboseLogging = false
VerboseLogging = true

[JobPipeline.HTTPRequest]
DefaultTimeout = '15s'
Expand Down
2 changes: 1 addition & 1 deletion core/web/resolver/testdata/config-full.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ MaxSuccessfulRuns = 123456
ReaperInterval = '4h0m0s'
ReaperThreshold = '168h0m0s'
ResultWriteQueueDepth = 10
VerboseLogging = true
VerboseLogging = false

[JobPipeline.HTTPRequest]
DefaultTimeout = '1m0s'
Expand Down
2 changes: 1 addition & 1 deletion core/web/resolver/testdata/config-multi-chain-effective.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ MaxSuccessfulRuns = 10000
ReaperInterval = '1h0m0s'
ReaperThreshold = '24h0m0s'
ResultWriteQueueDepth = 100
VerboseLogging = false
VerboseLogging = true

[JobPipeline.HTTPRequest]
DefaultTimeout = '30s'
Expand Down
12 changes: 6 additions & 6 deletions docs/CONFIG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -776,7 +776,7 @@ MaxSuccessfulRuns = 10000 # Default
ReaperInterval = '1h' # Default
ReaperThreshold = '24h' # Default
ResultWriteQueueDepth = 100 # Default
VerboseLogging = false # Default
VerboseLogging = true # Default
```


Expand Down Expand Up @@ -826,13 +826,13 @@ ResultWriteQueueDepth controls how many writes will be buffered before subsequen

### VerboseLogging
```toml
VerboseLogging = false # Default
VerboseLogging = true # Default
```
VerboseLogging enables detailed logging of pipeline execution steps.
This is disabled by default because it increases log volume for pipeline
runs, but can be useful for debugging failed runs without relying on the UI
or database. Consider enabling this if you disabled run saving by setting
MaxSuccessfulRuns to zero.
This can be useful for debugging failed runs without relying on the UI
or database.

You may disable if this results in excessive log volume.

## JobPipeline.HTTPRequest
```toml
Expand Down
2 changes: 1 addition & 1 deletion testdata/scripts/node/validate/default.txtar
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ MaxSuccessfulRuns = 10000
ReaperInterval = '1h0m0s'
ReaperThreshold = '24h0m0s'
ResultWriteQueueDepth = 100
VerboseLogging = false
VerboseLogging = true

[JobPipeline.HTTPRequest]
DefaultTimeout = '15s'
Expand Down
2 changes: 1 addition & 1 deletion testdata/scripts/node/validate/disk-based-logging-disabled.txtar
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ MaxSuccessfulRuns = 10000
ReaperInterval = '1h0m0s'
ReaperThreshold = '24h0m0s'
ResultWriteQueueDepth = 100
VerboseLogging = false
VerboseLogging = true

[JobPipeline.HTTPRequest]
DefaultTimeout = '15s'
Expand Down
2 changes: 1 addition & 1 deletion testdata/scripts/node/validate/disk-based-logging-no-dir.txtar
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ MaxSuccessfulRuns = 10000
ReaperInterval = '1h0m0s'
ReaperThreshold = '24h0m0s'
ResultWriteQueueDepth = 100
VerboseLogging = false
VerboseLogging = true

[JobPipeline.HTTPRequest]
DefaultTimeout = '15s'
Expand Down
2 changes: 1 addition & 1 deletion testdata/scripts/node/validate/disk-based-logging.txtar
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ MaxSuccessfulRuns = 10000
ReaperInterval = '1h0m0s'
ReaperThreshold = '24h0m0s'
ResultWriteQueueDepth = 100
VerboseLogging = false
VerboseLogging = true

[JobPipeline.HTTPRequest]
DefaultTimeout = '15s'
Expand Down
2 changes: 1 addition & 1 deletion testdata/scripts/node/validate/invalid-ocr-p2p.txtar
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ MaxSuccessfulRuns = 10000
ReaperInterval = '1h0m0s'
ReaperThreshold = '24h0m0s'
ResultWriteQueueDepth = 100
VerboseLogging = false
VerboseLogging = true

[JobPipeline.HTTPRequest]
DefaultTimeout = '15s'
Expand Down
2 changes: 1 addition & 1 deletion testdata/scripts/node/validate/invalid.txtar
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ MaxSuccessfulRuns = 10000
ReaperInterval = '1h0m0s'
ReaperThreshold = '24h0m0s'
ResultWriteQueueDepth = 100
VerboseLogging = false
VerboseLogging = true

[JobPipeline.HTTPRequest]
DefaultTimeout = '15s'
Expand Down
2 changes: 1 addition & 1 deletion testdata/scripts/node/validate/valid.txtar
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ MaxSuccessfulRuns = 10000
ReaperInterval = '1h0m0s'
ReaperThreshold = '24h0m0s'
ResultWriteQueueDepth = 100
VerboseLogging = false
VerboseLogging = true

[JobPipeline.HTTPRequest]
DefaultTimeout = '15s'
Expand Down
2 changes: 1 addition & 1 deletion testdata/scripts/node/validate/warnings.txtar
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ MaxSuccessfulRuns = 10000
ReaperInterval = '1h0m0s'
ReaperThreshold = '24h0m0s'
ResultWriteQueueDepth = 100
VerboseLogging = false
VerboseLogging = true

[JobPipeline.HTTPRequest]
DefaultTimeout = '15s'
Expand Down
Loading