Make Pipeline.VerboseLogging turned on by default

smartcontractkit · Mar 25, 2024 · 70cf384 · 70cf384
1 parent 8426a67
commit 70cf384
Show file tree

Hide file tree

Showing 18 changed files with 39 additions and 27 deletions.
diff --git a/.changeset/afraid-baboons-nail.md b/.changeset/afraid-baboons-nail.md
@@ -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
+```
diff --git a/core/config/docs/core.toml b/core/config/docs/core.toml
@@ -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.

diff --git a/core/services/chainlink/config_test.go b/core/services/chainlink/config_test.go
@@ -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),
@@ -846,7 +846,7 @@ MaxSuccessfulRuns = 123456
 ReaperInterval = '4h0m0s'
 ReaperThreshold = '168h0m0s'
 ResultWriteQueueDepth = 10
-VerboseLogging = true
+VerboseLogging = false
 
 [JobPipeline.HTTPRequest]
 DefaultTimeout = '1m0s'

diff --git a/core/services/chainlink/testdata/config-empty-effective.toml b/core/services/chainlink/testdata/config-empty-effective.toml
@@ -116,7 +116,7 @@ MaxSuccessfulRuns = 10000
 ReaperInterval = '1h0m0s'
 ReaperThreshold = '24h0m0s'
 ResultWriteQueueDepth = 100
-VerboseLogging = false
+VerboseLogging = true
 
 [JobPipeline.HTTPRequest]
 DefaultTimeout = '15s'

diff --git a/core/services/chainlink/testdata/config-full.toml b/core/services/chainlink/testdata/config-full.toml
@@ -122,7 +122,7 @@ MaxSuccessfulRuns = 123456
 ReaperInterval = '4h0m0s'
 ReaperThreshold = '168h0m0s'
 ResultWriteQueueDepth = 10
-VerboseLogging = true
+VerboseLogging = false
 
 [JobPipeline.HTTPRequest]
 DefaultTimeout = '1m0s'

diff --git a/core/services/chainlink/testdata/config-multi-chain-effective.toml b/core/services/chainlink/testdata/config-multi-chain-effective.toml
@@ -116,7 +116,7 @@ MaxSuccessfulRuns = 10000
 ReaperInterval = '1h0m0s'
 ReaperThreshold = '24h0m0s'
 ResultWriteQueueDepth = 100
-VerboseLogging = false
+VerboseLogging = true
 
 [JobPipeline.HTTPRequest]
 DefaultTimeout = '30s'

diff --git a/core/web/resolver/testdata/config-empty-effective.toml b/core/web/resolver/testdata/config-empty-effective.toml
@@ -116,7 +116,7 @@ MaxSuccessfulRuns = 10000
 ReaperInterval = '1h0m0s'
 ReaperThreshold = '24h0m0s'
 ResultWriteQueueDepth = 100
-VerboseLogging = false
+VerboseLogging = true
 
 [JobPipeline.HTTPRequest]
 DefaultTimeout = '15s'

diff --git a/core/web/resolver/testdata/config-full.toml b/core/web/resolver/testdata/config-full.toml
@@ -122,7 +122,7 @@ MaxSuccessfulRuns = 123456
 ReaperInterval = '4h0m0s'
 ReaperThreshold = '168h0m0s'
 ResultWriteQueueDepth = 10
-VerboseLogging = true
+VerboseLogging = false
 
 [JobPipeline.HTTPRequest]
 DefaultTimeout = '1m0s'

diff --git a/core/web/resolver/testdata/config-multi-chain-effective.toml b/core/web/resolver/testdata/config-multi-chain-effective.toml
@@ -116,7 +116,7 @@ MaxSuccessfulRuns = 10000
 ReaperInterval = '1h0m0s'
 ReaperThreshold = '24h0m0s'
 ResultWriteQueueDepth = 100
-VerboseLogging = false
+VerboseLogging = true
 
 [JobPipeline.HTTPRequest]
 DefaultTimeout = '30s'

diff --git a/docs/CONFIG.md b/docs/CONFIG.md
@@ -776,7 +776,7 @@ MaxSuccessfulRuns = 10000 # Default
 ReaperInterval = '1h' # Default
 ReaperThreshold = '24h' # Default
 ResultWriteQueueDepth = 100 # Default
-VerboseLogging = false # Default
+VerboseLogging = true # Default
 ```
 
 
@@ -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

diff --git a/testdata/scripts/node/validate/default.txtar b/testdata/scripts/node/validate/default.txtar
@@ -128,7 +128,7 @@ MaxSuccessfulRuns = 10000
 ReaperInterval = '1h0m0s'
 ReaperThreshold = '24h0m0s'
 ResultWriteQueueDepth = 100
-VerboseLogging = false
+VerboseLogging = true
 
 [JobPipeline.HTTPRequest]
 DefaultTimeout = '15s'

diff --git a/testdata/scripts/node/validate/disk-based-logging-disabled.txtar b/testdata/scripts/node/validate/disk-based-logging-disabled.txtar
@@ -172,7 +172,7 @@ MaxSuccessfulRuns = 10000
 ReaperInterval = '1h0m0s'
 ReaperThreshold = '24h0m0s'
 ResultWriteQueueDepth = 100
-VerboseLogging = false
+VerboseLogging = true
 
 [JobPipeline.HTTPRequest]
 DefaultTimeout = '15s'

diff --git a/testdata/scripts/node/validate/disk-based-logging-no-dir.txtar b/testdata/scripts/node/validate/disk-based-logging-no-dir.txtar
@@ -172,7 +172,7 @@ MaxSuccessfulRuns = 10000
 ReaperInterval = '1h0m0s'
 ReaperThreshold = '24h0m0s'
 ResultWriteQueueDepth = 100
-VerboseLogging = false
+VerboseLogging = true
 
 [JobPipeline.HTTPRequest]
 DefaultTimeout = '15s'

diff --git a/testdata/scripts/node/validate/disk-based-logging.txtar b/testdata/scripts/node/validate/disk-based-logging.txtar
@@ -172,7 +172,7 @@ MaxSuccessfulRuns = 10000
 ReaperInterval = '1h0m0s'
 ReaperThreshold = '24h0m0s'
 ResultWriteQueueDepth = 100
-VerboseLogging = false
+VerboseLogging = true
 
 [JobPipeline.HTTPRequest]
 DefaultTimeout = '15s'

diff --git a/testdata/scripts/node/validate/invalid-ocr-p2p.txtar b/testdata/scripts/node/validate/invalid-ocr-p2p.txtar
@@ -157,7 +157,7 @@ MaxSuccessfulRuns = 10000
 ReaperInterval = '1h0m0s'
 ReaperThreshold = '24h0m0s'
 ResultWriteQueueDepth = 100
-VerboseLogging = false
+VerboseLogging = true
 
 [JobPipeline.HTTPRequest]
 DefaultTimeout = '15s'

diff --git a/testdata/scripts/node/validate/invalid.txtar b/testdata/scripts/node/validate/invalid.txtar
@@ -162,7 +162,7 @@ MaxSuccessfulRuns = 10000
 ReaperInterval = '1h0m0s'
 ReaperThreshold = '24h0m0s'
 ResultWriteQueueDepth = 100
-VerboseLogging = false
+VerboseLogging = true
 
 [JobPipeline.HTTPRequest]
 DefaultTimeout = '15s'

diff --git a/testdata/scripts/node/validate/valid.txtar b/testdata/scripts/node/validate/valid.txtar
@@ -169,7 +169,7 @@ MaxSuccessfulRuns = 10000
 ReaperInterval = '1h0m0s'
 ReaperThreshold = '24h0m0s'
 ResultWriteQueueDepth = 100
-VerboseLogging = false
+VerboseLogging = true
 
 [JobPipeline.HTTPRequest]
 DefaultTimeout = '15s'

diff --git a/testdata/scripts/node/validate/warnings.txtar b/testdata/scripts/node/validate/warnings.txtar
@@ -151,7 +151,7 @@ MaxSuccessfulRuns = 10000
 ReaperInterval = '1h0m0s'
 ReaperThreshold = '24h0m0s'
 ResultWriteQueueDepth = 100
-VerboseLogging = false
+VerboseLogging = true
 
 [JobPipeline.HTTPRequest]
 DefaultTimeout = '15s'