cluster: support retention by size for prometheus

Author: AstroProfundis

embed/templates/scripts/run_prometheus.sh.tpl

@@ -55,5 +55,10 @@ exec bin/prometheus/prometheus \
 {{- end}}
 {{- end}}
 {{- if not .EnablePromAgentMode}}
-    --storage.tsdb.retention="{{.Retention}}"
+{{- if .RetentionSize}}
+    --storage.tsdb.retention.size="{{.RetentionSize}}"
+{{- end}}
+{{- if .RetentionTime}}
+    --storage.tsdb.retention.time="{{.RetentionTime}}"
+{{- end}}
 {{- end}}

pkg/cluster/spec/monitoring.go

@@ -55,7 +55,9 @@ type PrometheusSpec struct {
 	RemoteConfig          Remote                 `yaml:"remote_config,omitempty" validate:"remote_config:ignore"`
 	ExternalAlertmanagers []ExternalAlertmanager `yaml:"external_alertmanagers" validate:"external_alertmanagers:ignore"`
 	PushgatewayAddrs      []string               `yaml:"pushgateway_addrs,omitempty" validate:"pushgateway_addrs:ignore"`
-	Retention             string                 `yaml:"storage_retention,omitempty" validate:"storage_retention:editable"`
+	Retention             string                 `yaml:"storage_retention,omitempty" validate:"storage_retention:editable"` // deprecated
+	RetentionSize         string                 `yaml:"storage_retention_size,omitempty" validate:"storage_retention_size:editable"`
+	RetentionTime         string                 `yaml:"storage_retention_time,omitempty" validate:"storage_retention_time:editable"`
 	ResourceControl       meta.ResourceControl   `yaml:"resource_control,omitempty" validate:"resource_control:editable"`
 	Arch                  string                 `yaml:"arch,omitempty"`
 	OS                    string                 `yaml:"os,omitempty"`
@@ -276,7 +278,6 @@ func (i *MonitorInstance) InitConfig(
 	cfg := &scripts.PrometheusScript{
 		Port:                spec.Port,
 		WebExternalURL:      fmt.Sprintf("http://%s", utils.JoinHostPort(spec.Host, spec.Port)),
-		Retention:           getRetention(spec.Retention),
 		EnableNG:            spec.NgPort > 0,
 		EnablePromAgentMode: spec.EnablePromAgentMode, // Get from spec directly
 
@@ -288,6 +289,13 @@ func (i *MonitorInstance) InitConfig(
 
 		AdditionalArgs: spec.AdditionalArgs,
 	}
+	// Set retention policy
+	if spec.RetentionTime == "" {
+		cfg.RetentionTime = getRetentionTime(spec.Retention)
+	} else {
+		cfg.RetentionTime = getRetentionTime(spec.RetentionTime)
+	}
+	cfg.RetentionSize = getRetentionSize(spec.RetentionSize)
 
 	// Check if agent mode is enabled in additional arguments
 	if !cfg.EnablePromAgentMode {
@@ -681,7 +689,17 @@ func mergeAdditionalScrapeConf(source string, addition map[string]any) error {
 	return utils.WriteFile(source, bytes, 0644)
 }
 
-func getRetention(retention string) string {
+func getRetentionSize(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 {
+		return ""
+	}
+	return retention
+}
+
+func getRetentionTime(retention string) string {
+	retention = strings.TrimSpace(retention)
 	valid, _ := regexp.MatchString("^[1-9]\\d*d$", retention)
 	if retention == "" || !valid {
 		return "30d"

pkg/cluster/spec/monitoring_test.go

@@ -229,32 +229,68 @@ scrape_configs:
 
 func TestGetRetention(t *testing.T) {
 	var val string
-	val = getRetention("-1d")
+	val = getRetentionTime("-1d")
 	assert.EqualValues(t, "30d", val)
 
-	val = getRetention("0d")
+	val = getRetentionTime("0d")
 	assert.EqualValues(t, "30d", val)
 
-	val = getRetention("01d")
+	val = getRetentionTime("01d")
 	assert.EqualValues(t, "30d", val)
 
-	val = getRetention("1dd")
+	val = getRetentionTime("1dd")
 	assert.EqualValues(t, "30d", val)
 
-	val = getRetention("*1d")
+	val = getRetentionTime("*1d")
 	assert.EqualValues(t, "30d", val)
 
-	val = getRetention("1d ")
-	assert.EqualValues(t, "30d", val)
+	val = getRetentionTime("1d ")
+	assert.EqualValues(t, "1d", val)
+
+	val = getRetentionTime(" 1d")
+	assert.EqualValues(t, "1d", val)
 
-	val = getRetention("ddd")
+	val = getRetentionTime("ddd")
 	assert.EqualValues(t, "30d", val)
 
-	val = getRetention("60d")
+	val = getRetentionTime("60d")
 	assert.EqualValues(t, "60d", val)
 
-	val = getRetention("999d")
+	val = getRetentionTime("999d")
 	assert.EqualValues(t, "999d", val)
+
+	val = getRetentionSize("-1MB")
+	assert.EqualValues(t, "", val)
+
+	val = getRetentionSize("30d")
+	assert.EqualValues(t, "", val)
+
+	val = getRetentionSize("1k")
+	assert.EqualValues(t, "", val)
+
+	val = getRetentionSize("01G")
+	assert.EqualValues(t, "", val)
+
+	val = getRetentionSize("233mb")
+	assert.EqualValues(t, "233MB", val)
+
+	val = getRetentionSize("*1GB")
+	assert.EqualValues(t, "", val)
+
+	val = getRetentionSize("20GB ")
+	assert.EqualValues(t, "20GB", val)
+
+	val = getRetentionSize(" 20GB")
+	assert.EqualValues(t, "20GB", val)
+
+	val = getRetentionSize("3TB")
+	assert.EqualValues(t, "3TB", val)
+
+	val = getRetentionSize("30GB")
+	assert.EqualValues(t, "30GB", val)
+
+	val = getRetentionSize("1EB")
+	assert.EqualValues(t, "1EB", val)
 }
 
 // TestHandleRemoteWrite verifies that remote write configurations are properly handled

pkg/cluster/template/scripts/monitoring.go

@@ -26,7 +26,8 @@ import (
 type PrometheusScript struct {
 	Port                int
 	WebExternalURL      string
-	Retention           string
+	RetentionSize       string
+	RetentionTime       string
 	EnableNG            bool
 	EnablePromAgentMode bool
 

pkg/cluster/template/scripts/monitoring_test.go

@@ -32,7 +32,8 @@ func TestPrometheusScriptWithAgentMode(t *testing.T) {
 	script := &PrometheusScript{
 		Port:                9090,
 		WebExternalURL:      "http://localhost:9090",
-		Retention:           "30d",
+		RetentionTime:       "30d",
+		RetentionSize:       "100GB",
 		EnableNG:            false,
 		EnablePromAgentMode: true,
 		DeployDir:           "/deploy",