From 459049990266a26b269aede05f5070945d1f7eab Mon Sep 17 00:00:00 2001 From: Victor Yves Crispim Date: Wed, 13 Mar 2024 11:58:07 -0300 Subject: [PATCH] feat: add option to disable configuration logs --- CHANGELOG.md | 1 + docs/config.md | 7 +++++++ internal/config/config.go | 4 ++++ internal/config/generate/Config.toml | 9 ++++++++- internal/config/get.go | 5 +++++ 5 files changed, 25 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 880f9dacb..6b0f96a9b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Added verification to ensure CARTESI_BLOCKCHAIN_ID matches the id returned from the Ethereum node - Added support for CARTESI_AUTH_PRIVATE_KEY and CARTESI_AUTH_PRIVATE_KEY_FILE - Added `CARTESI_EXPERIMENTAL_SERVER_MANAGER_BYPASS_LOG` env var to allow `server-manager` output to bypass all log configuration +- Added `CARTESI_EXPERIMENTAL_DISABLE_CONFIG_LOG` env var to disable log entries related to the node's configuration ## Changed diff --git a/docs/config.md b/docs/config.md index 6898a5555..d4027c0a1 100644 --- a/docs/config.md +++ b/docs/config.md @@ -147,6 +147,13 @@ Address of the InputBox contract. * **Type:** `string` +## `CARTESI_EXPERIMENTAL_DISABLE_CONFIG_LOG` + +Disables all log entries related to the node's configuration + +* **Type:** `bool` +* **Default:** `"false"` + ## `CARTESI_EXPERIMENTAL_SERVER_MANAGER_BYPASS_LOG` When enabled, prints server-manager output to stdout and stderr directly. diff --git a/internal/config/config.go b/internal/config/config.go index 00aa30a86..c0ecbdfc5 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -13,6 +13,7 @@ package config import ( "fmt" + "io" "log" "os" "strconv" @@ -104,6 +105,9 @@ var configLogger = log.New(os.Stdout, "CONFIG ", log.LstdFlags) func init() { cache.values = make(map[string]string) + if GetCartesiExperimentalDisableConfigLog() { + configLogger.SetOutput(io.Discard) + } } // Reads the value of an environment variable (loads from a cached value when possible). diff --git a/internal/config/generate/Config.toml b/internal/config/generate/Config.toml index a8b2771a6..269041c3e 100644 --- a/internal/config/generate/Config.toml +++ b/internal/config/generate/Config.toml @@ -261,4 +261,11 @@ default = "false" go-type = "bool" description = """ When enabled, prints server-manager output to stdout and stderr directly. -All other log configurations are ignored.""" \ No newline at end of file +All other log configurations are ignored.""" + +[experimental.CARTESI_EXPERIMENTAL_DISABLE_CONFIG_LOG] +default = "false" +go-type = "bool" +redact = true +description = """ +Disables all log entries related to the node's configuration""" \ No newline at end of file diff --git a/internal/config/get.go b/internal/config/get.go index 7e187d0dd..04be9cbc9 100644 --- a/internal/config/get.go +++ b/internal/config/get.go @@ -109,6 +109,11 @@ func GetCartesiContractsInputBoxAddress() string { return v } +func GetCartesiExperimentalDisableConfigLog() bool { + v := get("CARTESI_EXPERIMENTAL_DISABLE_CONFIG_LOG", "false", true, true, toBool) + return v +} + func GetCartesiExperimentalServerManagerBypassLog() bool { v := get("CARTESI_EXPERIMENTAL_SERVER_MANAGER_BYPASS_LOG", "false", true, false, toBool) return v