Browse Source

docs: comments

Signed-off-by: ilya.melnikov <ilya.melnikov@idp.zyfra.com>
ilya.melnikov 2 years ago
parent
commit
09a688d1bb
1 changed files with 4 additions and 0 deletions
  1. 4 0
      pkg/env/costmodelenv.go

+ 4 - 0
pkg/env/costmodelenv.go

@@ -165,6 +165,10 @@ func GetPrometheusRetryOnRateLimitDefaultWait() time.Duration {
 }
 
 // GetPrometheusHeaderXScopeOrgId returns the default value for X-Scope-OrgID header used for requests in Mimir API.
+// To use Mimir instead of Prometheus add variable from Mimir settings:
+// "PROMETHEUS_HEADER_X_SCOPE_ORGID": "my-cluster-name"
+// Then set Prometheus URL to Mimir prometheus API endpoint:
+// "PROMETHEUS_SERVER_ENDPOINT": "http://mimir-url/prometheus/"
 func GetPrometheusHeaderXScopeOrgId() string {
 	return Get(PrometheusHeaderXScopeOrgIdEnvVar, "")
 }