cluster: log warning when retention values are invalid

Author: AstroProfundis

pkg/cluster/spec/monitoring.go

@@ -30,6 +30,7 @@ import (
 	"github.com/pingcap/tiup/pkg/cluster/ctxt"
 	"github.com/pingcap/tiup/pkg/cluster/template/config"
 	"github.com/pingcap/tiup/pkg/cluster/template/scripts"
+	logprinter "github.com/pingcap/tiup/pkg/logger/printer"
 	"github.com/pingcap/tiup/pkg/meta"
 	"github.com/pingcap/tiup/pkg/set"
 	"github.com/pingcap/tiup/pkg/utils"
@@ -284,12 +285,13 @@ func (i *MonitorInstance) InitConfig(
 		AdditionalArgs: spec.AdditionalArgs,
 	}
 	// Set retention policy
-	if spec.RetentionTime == "" {
-		cfg.RetentionTime = getRetentionTime(spec.Retention)
+	logPtr := ctx.Value(logprinter.ContextKeyLogger).(*logprinter.Logger)
+	if spec.RetentionTime == "" { // keep backward compatiability
+		cfg.RetentionTime = getRetentionTime(logPtr, spec.Retention)
 	} else {
-		cfg.RetentionTime = getRetentionTime(spec.RetentionTime)
+		cfg.RetentionTime = getRetentionTime(logPtr, spec.RetentionTime)
 	}
-	cfg.RetentionSize = getRetentionSize(spec.RetentionSize)
+	cfg.RetentionSize = getRetentionSize(logPtr, spec.RetentionSize)
 
 	// Check if agent mode is enabled in additional arguments
 	if !cfg.EnablePromAgentMode {
@@ -683,19 +685,25 @@ func mergeAdditionalScrapeConf(source string, addition map[string]any) error {
 	return utils.WriteFile(source, bytes, 0644)
 }
 
-func getRetentionSize(retention string) string {
+func getRetentionSize(l *logprinter.Logger, retention string) string {
 	retention = strings.ToUpper(strings.TrimSpace(retention))
 	valid, _ := regexp.MatchString("^[1-9]\\d*(B|KB|MB|GB|TB|PB|EB)$", retention)
 	if retention == "" || !valid {
+		if !valid && l != nil {
+			l.Warnf("invalid retention size %s, ignored.", retention)
+		}
 		return ""
 	}
 	return retention
 }
 
-func getRetentionTime(retention string) string {
+func getRetentionTime(l *logprinter.Logger, retention string) string {
 	retention = strings.TrimSpace(retention)
 	valid, _ := regexp.MatchString("^[1-9]\\d*d$", retention)
 	if retention == "" || !valid {
+		if !valid && l != nil {
+			l.Warnf("invalid retention time %s, using 30d as default", retention)
+		}
 		return "30d"
 	}
 	return retention

pkg/cluster/spec/monitoring_test.go

@@ -229,67 +229,67 @@ scrape_configs:
 
 func TestGetRetention(t *testing.T) {
 	var val string
-	val = getRetentionTime("-1d")
+	val = getRetentionTime(nil, "-1d")
 	assert.EqualValues(t, "30d", val)
 
-	val = getRetentionTime("0d")
+	val = getRetentionTime(nil, "0d")
 	assert.EqualValues(t, "30d", val)
 
-	val = getRetentionTime("01d")
+	val = getRetentionTime(nil, "01d")
 	assert.EqualValues(t, "30d", val)
 
-	val = getRetentionTime("1dd")
+	val = getRetentionTime(nil, "1dd")
 	assert.EqualValues(t, "30d", val)
 
-	val = getRetentionTime("*1d")
+	val = getRetentionTime(nil, "*1d")
 	assert.EqualValues(t, "30d", val)
 
-	val = getRetentionTime("1d ")
+	val = getRetentionTime(nil, "1d ")
 	assert.EqualValues(t, "1d", val)
 
-	val = getRetentionTime(" 1d")
+	val = getRetentionTime(nil, " 1d")
 	assert.EqualValues(t, "1d", val)
 
-	val = getRetentionTime("ddd")
+	val = getRetentionTime(nil, "ddd")
 	assert.EqualValues(t, "30d", val)
 
-	val = getRetentionTime("60d")
+	val = getRetentionTime(nil, "60d")
 	assert.EqualValues(t, "60d", val)
 
-	val = getRetentionTime("999d")
+	val = getRetentionTime(nil, "999d")
 	assert.EqualValues(t, "999d", val)
 
-	val = getRetentionSize("-1MB")
+	val = getRetentionSize(nil, "-1MB")
 	assert.EqualValues(t, "", val)
 
-	val = getRetentionSize("30d")
+	val = getRetentionSize(nil, "30d")
 	assert.EqualValues(t, "", val)
 
-	val = getRetentionSize("1k")
+	val = getRetentionSize(nil, "1k")
 	assert.EqualValues(t, "", val)
 
-	val = getRetentionSize("01G")
+	val = getRetentionSize(nil, "01G")
 	assert.EqualValues(t, "", val)
 
-	val = getRetentionSize("233mb")
+	val = getRetentionSize(nil, "233mb")
 	assert.EqualValues(t, "233MB", val)
 
-	val = getRetentionSize("*1GB")
+	val = getRetentionSize(nil, "*1GB")
 	assert.EqualValues(t, "", val)
 
-	val = getRetentionSize("20GB ")
+	val = getRetentionSize(nil, "20GB ")
 	assert.EqualValues(t, "20GB", val)
 
-	val = getRetentionSize(" 20GB")
+	val = getRetentionSize(nil, " 20GB")
 	assert.EqualValues(t, "20GB", val)
 
-	val = getRetentionSize("3TB")
+	val = getRetentionSize(nil, "3TB")
 	assert.EqualValues(t, "3TB", val)
 
-	val = getRetentionSize("30GB")
+	val = getRetentionSize(nil, "30GB")
 	assert.EqualValues(t, "30GB", val)
 
-	val = getRetentionSize("1EB")
+	val = getRetentionSize(nil, "1EB")
 	assert.EqualValues(t, "1EB", val)
 }