fix(spanner): disable config logging by default (#13478)

olavloite · web-flow · commit ad19592ed7ba · 2025-12-15T05:46:38.000-05:00
Disables the config logging at startup by default. Config logging can be
enabled by setting either of the environment variables
`GOOGLE_CLOUD_SPANNER_ENABLE_LOG_CLIENT_OPTIONS` or
`GOOGLE_CLOUD_SPANNER_DISABLE_LOG_CLIENT_OPTIONS`. If neither of these
variables have been set, logging will be disabled.
diff --git a/spanner/client.go b/spanner/client.go
@@ -1527,12 +1527,20 @@ func parseServerTimingHeader(md metadata.MD) map[string]time.Duration {
 	return metrics
 }
 
-// enableLogClientOptions returns true if the environment variable for this doesn't exist or is set to false
+// enableLogClientOptions returns true if the environment variable for enabling has been set to true, or if the
+// environment variable for disabling has been set to false. It returns false by default if no env var has been set.
+// The function uses two environment variables because this function was initially added with a default return value of
+// true, which caused the config to always be logged. This again caused unnecessary log spamming.
 func enableLogClientOptions() bool {
+	if enableLogString, found := os.LookupEnv("GOOGLE_CLOUD_SPANNER_ENABLE_LOG_CLIENT_OPTIONS"); found {
+		if enableLog, err := strconv.ParseBool(enableLogString); err == nil {
+			return enableLog
+		}
+	}
 	if disableLogString, found := os.LookupEnv("GOOGLE_CLOUD_SPANNER_DISABLE_LOG_CLIENT_OPTIONS"); found {
 		if disableLog, err := strconv.ParseBool(disableLogString); err == nil {
 			return !disableLog
 		}
 	}
-	return true
+	return false
 }

Original file line number	Diff line number	Diff line change
`@@ -1527,12 +1527,20 @@ func parseServerTimingHeader(md metadata.MD) map[string]time.Duration {`
`1527`	`1527`	`return metrics`
`1528`	`1528`	`}`
`1529`	`1529`
`1530`		`-// enableLogClientOptions returns true if the environment variable for this doesn't exist or is set to false`
	`1530`	`+// enableLogClientOptions returns true if the environment variable for enabling has been set to true, or if the`
	`1531`	`+// environment variable for disabling has been set to false. It returns false by default if no env var has been set.`
	`1532`	`+// The function uses two environment variables because this function was initially added with a default return value of`
	`1533`	`+// true, which caused the config to always be logged. This again caused unnecessary log spamming.`
`1531`	`1534`	`func enableLogClientOptions() bool {`
	`1535`	`+ if enableLogString, found := os.LookupEnv("GOOGLE_CLOUD_SPANNER_ENABLE_LOG_CLIENT_OPTIONS"); found {`
	`1536`	`+ if enableLog, err := strconv.ParseBool(enableLogString); err == nil {`
	`1537`	`+ return enableLog`
	`1538`	`+ }`
	`1539`	`+ }`
`1532`	`1540`	`if disableLogString, found := os.LookupEnv("GOOGLE_CLOUD_SPANNER_DISABLE_LOG_CLIENT_OPTIONS"); found {`
`1533`	`1541`	`if disableLog, err := strconv.ParseBool(disableLogString); err == nil {`
`1534`	`1542`	`return !disableLog`
`1535`	`1543`	`}`
`1536`	`1544`	`}`
`1537`		`- return true`
	`1545`	`+ return false`
`1538`	`1546`	`}`