Update -metrics.rules.prometheus-config -> -metrics.rules.config-file

Signed-off-by: Harkishen-Singh <harkishensingh@hotmail.com>
timescale · May 10, 2022 · 3f7aa10 · 3f7aa10
1 parent d3d8f94
commit 3f7aa10
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -116,7 +116,7 @@ The following subsections cover all CLI flags which promscale supports. You can
 | metrics.rules.alert.for-grace-period | duration | 10 minutes | Minimum duration between alert and restored "for" state. This is maintained only for alerts with configured "for" time greater than grace period. |
 | metrics.rules.alert.for-outage-tolerance | duration | 1 hour | Max time to tolerate Promscale outage for restoring "for" state of alert. |
 | metrics.rules.alert.resend-delay | duration | 1 minute | Minimum amount of time to wait before resending an alert to Alertmanager. |
-| metrics.rules.prometheus-config | string | "" | Address of the Prometheus configuration. This is used to extract the alertmanager configuration and the addresses of rules files. Note: If this is empty or `rule_files` is empty, Promscale rule-manager will not start. If `alertmanager_config` is empty, alerting will not be initialized. |
+| metrics.rules.config-file | string | "" |  Path to configuration file in Prometheus-format, containing rule_files and optional `alerting`, `global` fields. For more details, see https://prometheus.io/docs/prometheus/latest/configuration/configuration/. Note: If this is flag or `rule_files` is empty, Promscale rule-manager will not start. If `alertmanagers` is empty, alerting will not be initialized. |
 
 ### Startup process flags
 

diff --git a/pkg/rules/config.go b/pkg/rules/config.go
@@ -52,9 +52,9 @@ func ParseFlags(fs *flag.FlagSet, cfg *Config) *Config {
 	fs.DurationVar(&cfg.OutageTolerance, "metrics.rules.alert.for-outage-tolerance", defaultOutageTolerance, "Max time to tolerate Promscale outage for restoring \"for\" state of alert.")
 	fs.DurationVar(&cfg.ForGracePeriod, "metrics.rules.alert.for-grace-period", defaultForGracePeriod, "Minimum duration between alert and restored \"for\" state. This is maintained only for alerts with configured \"for\" time greater than grace period.")
 	fs.DurationVar(&cfg.ResendDelay, "metrics.rules.alert.resend-delay", defaultResendDelay, "Minimum amount of time to wait before resending an alert to Alertmanager.")
-	fs.StringVar(&cfg.PrometheusConfigAddress, "metrics.rules.prometheus-config", "", "Address of the Prometheus configuration. This is used to extract the"+
-		" alertmanager configuration and the addresses of rules files."+
-		"Note: If this is empty or `rule_files` is empty, Promscale rule-manager will not start. If `alertmanager_config` is empty, alerting will not be initialized.")
+	fs.StringVar(&cfg.PrometheusConfigAddress, "metrics.rules.config-file", "", "Path to configuration file in Prometheus-format, containing `rule_files` and optional `alerting`, `global` fields. "+
+		"For more details, see https://prometheus.io/docs/prometheus/latest/configuration/configuration/. "+
+		"Note: If this is flag empty or `rule_files` is empty, Promscale rule-manager will not start. If `alertmanagers` is empty, alerting will not be initialized.")
 	return cfg
 }