Add the look back duration flag for linting check

Signed-off-by: zhaowang <zhaowang@apac.freewheel.com>

cmd/promtool/main.go

@@ -74,9 +74,6 @@ const (
 	lintOptionNone               = "none"
 	checkHealth                  = "/-/healthy"
 	checkReadiness               = "/-/ready"
-
-	// Remove when the lookback delta can be set as a command line flag on PromTool.
-	defaultLookbackDelta = 5 * time.Minute
 )
 
 var lintOptions = []string{lintOptionAll, lintOptionDuplicateRules, lintOptionNone}
@@ -144,6 +141,10 @@ func main() {
 	checkRulesLintFatal := checkRulesCmd.Flag(
 		"lint-fatal",
 		"Make lint errors exit with exit code 3.").Default("false").Bool()
+	checkRulesLintLookbackDelta := checkRulesCmd.Flag(
+		"lint.lookback-delta",
+		"The maximum lookback duration. This config is only used for rules linting checks.",
+	).Default("5m").Duration()
 
 	checkMetricsCmd := checkCmd.Command("metrics", checkMetricsUsage)
 	checkMetricsExtended := checkCmd.Flag("extended", "Print extended information related to the cardinality of the metrics.").Bool()
@@ -341,7 +342,7 @@ func main() {
 		os.Exit(CheckSD(*sdConfigFile, *sdJobName, *sdTimeout, noDefaultScrapePort, prometheus.DefaultRegisterer))
 
 	case checkConfigCmd.FullCommand():
-		os.Exit(CheckConfig(*agentMode, *checkConfigSyntaxOnly, newLintConfig(*checkConfigLint, *checkConfigLintFatal), *configFiles...))
+		os.Exit(CheckConfig(*agentMode, *checkConfigSyntaxOnly, newLintConfig(*checkConfigLint, *checkConfigLintFatal, *checkRulesLintLookbackDelta), *configFiles...))
 
 	case checkServerHealthCmd.FullCommand():
 		os.Exit(checkErr(CheckServerStatus(serverURL, checkHealth, httpRoundTripper)))
@@ -353,7 +354,7 @@ func main() {
 		os.Exit(CheckWebConfig(*webConfigFiles...))
 
 	case checkRulesCmd.FullCommand():
-		os.Exit(CheckRules(newLintConfig(*checkRulesLint, *checkRulesLintFatal), *ruleFiles...))
+		os.Exit(CheckRules(newLintConfig(*checkRulesLint, *checkRulesLintFatal, *checkRulesLintLookbackDelta), *ruleFiles...))
 
 	case checkMetricsCmd.FullCommand():
 		os.Exit(CheckMetrics(*checkMetricsExtended))
@@ -451,12 +452,14 @@ type lintConfig struct {
 	duplicateRules     bool
 	longScrapeInterval bool
 	fatal              bool
+	lookbackDelta      model.Duration
 }
 
-func newLintConfig(stringVal string, fatal bool) lintConfig {
+func newLintConfig(stringVal string, fatal bool, lookbackDelta time.Duration) lintConfig {
 	items := strings.Split(stringVal, ",")
 	ls := lintConfig{
 		fatal:         fatal,
+		lookbackDelta: model.Duration(lookbackDelta),
 	}
 	for _, setting := range items {
 		switch setting {
@@ -623,7 +626,7 @@ func checkConfig(agentMode bool, filename string, checkSyntaxOnly bool, lintSett
 
 	for _, scfg := range scfgs {
 		if lintSettings.lintLongScrapeInterval() {
-			if scfg.ScrapeInterval >= model.Duration(defaultLookbackDelta) {
+			if scfg.ScrapeInterval >= lintSettings.lookbackDelta {
 				errMessage := fmt.Sprintf("Long Scrape Interval found. Data point will be marked as stale. Job: %s. Interval: %s", scfg.JobName, scfg.ScrapeInterval.String())
 				return nil, fmt.Errorf("%w %s", errLint, errMessage)
 			}

cmd/promtool/main_test.go

@@ -219,7 +219,7 @@ func TestCheckTargetConfig(t *testing.T) {
 	}
 	for _, test := range cases {
 		t.Run(test.name, func(t *testing.T) {
-			_, err := checkConfig(false, "testdata/"+test.file, false, newLintConfig(lintOptionNone, false))
+			_, err := checkConfig(false, "testdata/"+test.file, false, newLintConfig(lintOptionNone, false, 5*time.Minute))
 			if test.err != "" {
 				require.Equalf(t, test.err, err.Error(), "Expected error %q, got %q", test.err, err.Error())
 				return
@@ -302,7 +302,7 @@ func TestCheckConfigSyntax(t *testing.T) {
 	}
 	for _, test := range cases {
 		t.Run(test.name, func(t *testing.T) {
-			_, err := checkConfig(false, "testdata/"+test.file, test.syntaxOnly, newLintConfig(lintOptionNone, false))
+			_, err := checkConfig(false, "testdata/"+test.file, test.syntaxOnly, newLintConfig(lintOptionNone, false, 5*time.Minute))
 			expectedErrMsg := test.err
 			if strings.Contains(runtime.GOOS, "windows") {
 				expectedErrMsg = test.errWindows
@@ -336,7 +336,7 @@ func TestAuthorizationConfig(t *testing.T) {
 
 	for _, test := range cases {
 		t.Run(test.name, func(t *testing.T) {
-			_, err := checkConfig(false, "testdata/"+test.file, false, newLintConfig(lintOptionNone, false))
+			_, err := checkConfig(false, "testdata/"+test.file, false, newLintConfig(lintOptionNone, false, 5*time.Minute))
 			if test.err != "" {
 				require.Contains(t, err.Error(), test.err, "Expected error to contain %q, got %q", test.err, err.Error())
 				return
@@ -484,7 +484,7 @@ func TestCheckRules(t *testing.T) {
 		defer func(v *os.File) { os.Stdin = v }(os.Stdin)
 		os.Stdin = r
 
-		exitCode := CheckRules(newLintConfig(lintOptionDuplicateRules, false))
+		exitCode := CheckRules(newLintConfig(lintOptionDuplicateRules, false, 5*time.Minute))
 		require.Equal(t, successExitCode, exitCode, "")
 	})
 
@@ -506,7 +506,7 @@ func TestCheckRules(t *testing.T) {
 		defer func(v *os.File) { os.Stdin = v }(os.Stdin)
 		os.Stdin = r
 
-		exitCode := CheckRules(newLintConfig(lintOptionDuplicateRules, false))
+		exitCode := CheckRules(newLintConfig(lintOptionDuplicateRules, false, 5*time.Minute))
 		require.Equal(t, failureExitCode, exitCode, "")
 	})
 
@@ -528,30 +528,49 @@ func TestCheckRules(t *testing.T) {
 		defer func(v *os.File) { os.Stdin = v }(os.Stdin)
 		os.Stdin = r
 
-		exitCode := CheckRules(newLintConfig(lintOptionDuplicateRules, true))
+		exitCode := CheckRules(newLintConfig(lintOptionDuplicateRules, true, 5*time.Minute))
 		require.Equal(t, lintErrExitCode, exitCode, "")
 	})
 
+	for _, c := range []struct {
+		lookbackDelta  time.Duration
+		expectedErrMsg string
+	}{
+		{
+			lookbackDelta:  5 * time.Minute,
+			expectedErrMsg: "lint error Long Scrape Interval found. Data point will be marked as stale. Job: long_scrape_interval_test. Interval: 10m",
+		},
+		{
+			lookbackDelta:  20 * time.Minute,
+			expectedErrMsg: "",
+		},
+	} {
 		t.Run("config-lint-fatal", func(t *testing.T) {
-		_, err := checkConfig(false, "./testdata/prometheus-config.lint.yml", false, newLintConfig(lintOptionLongScrapeInterval, false))
+			_, err := checkConfig(false, "./testdata/prometheus-config.lint.yml", false, newLintConfig(lintOptionLongScrapeInterval, false, c.lookbackDelta))
-		expectedErrMsg := "lint error Long Scrape Interval found. Data point will be marked as stale. Job: long_scrape_interval_test. Interval: 1h"
+			var errMsg string
-		require.Equalf(t, expectedErrMsg, err.Error(), "Expected error %q, got %q", expectedErrMsg, err.Error())
+			if err != nil {
+				errMsg = err.Error()
+			} else {
+				errMsg = ""
+			}
+			require.Equalf(t, c.expectedErrMsg, errMsg, "Expected error %q, got %q", c.expectedErrMsg, errMsg)
 		})
+	}
 }
 
 func TestCheckRulesWithRuleFiles(t *testing.T) {
 	t.Run("rules-good", func(t *testing.T) {
-		exitCode := CheckRules(newLintConfig(lintOptionDuplicateRules, false), "./testdata/rules.yml")
+		exitCode := CheckRules(newLintConfig(lintOptionDuplicateRules, false, 5*time.Minute), "./testdata/rules.yml")
 		require.Equal(t, successExitCode, exitCode, "")
 	})
 
 	t.Run("rules-bad", func(t *testing.T) {
-		exitCode := CheckRules(newLintConfig(lintOptionDuplicateRules, false), "./testdata/rules-bad.yml")
+		exitCode := CheckRules(newLintConfig(lintOptionDuplicateRules, false, 5*time.Minute), "./testdata/rules-bad.yml")
 		require.Equal(t, failureExitCode, exitCode, "")
 	})
 
 	t.Run("rules-lint-fatal", func(t *testing.T) {
-		exitCode := CheckRules(newLintConfig(lintOptionDuplicateRules, true), "./testdata/prometheus-rules.lint.yml")
+		exitCode := CheckRules(newLintConfig(lintOptionDuplicateRules, true, 5*time.Minute), "./testdata/prometheus-rules.lint.yml")
 		require.Equal(t, lintErrExitCode, exitCode, "")
 	})
 }

cmd/promtool/testdata/prometheus-config.lint.yml

@@ -1,3 +1,3 @@
 scrape_configs:
   - job_name: long_scrape_interval_test
-    scrape_interval: 1h
+    scrape_interval: 10m

docs/command-line/promtool.md

@@ -177,6 +177,7 @@ Check if the rule files are valid or not.
 | --- | --- | --- |
 | <code class="text-nowrap">--lint</code> | Linting checks to apply. Available options are: all, duplicate-rules, none. Use --lint=none to disable linting | `duplicate-rules` |
 | <code class="text-nowrap">--lint-fatal</code> | Make lint errors exit with exit code 3. | `false` |
+| <code class="text-nowrap">--lint.lookback-delta</code> | The maximum lookback duration. This config is only used for rules linting checks. | `5m` |