Sfoglia il codice sorgente

docs: comments

Signed-off-by: ilya.melnikov <ilya.melnikov@idp.zyfra.com>
ilya.melnikov 3 anni fa
parent
commit
2d469543b9
2 ha cambiato i file con 4 aggiunte e 4 eliminazioni
  1. 3 3
      pkg/env/costmodelenv.go
  2. 1 1
      pkg/prom/prom.go

+ 3 - 3
pkg/env/costmodelenv.go

@@ -164,10 +164,10 @@ func GetPrometheusRetryOnRateLimitDefaultWait() time.Duration {
 	return GetDuration(PrometheusRetryOnRateLimitDefaultWaitEnvVar, 100*time.Millisecond)
 }
 
-// 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:
+// GetPrometheusHeaderXScopeOrgId returns the default value for X-Scope-OrgID header used for requests in Mimir/Cortex-Tenant API.
+// To use Mimir(or Cortex-Tenant) instead of Prometheus add variable from cluster settings:
 // "PROMETHEUS_HEADER_X_SCOPE_ORGID": "my-cluster-name"
-// Then set Prometheus URL to Mimir prometheus API endpoint:
+// Then set Prometheus URL to prometheus API endpoint:
 // "PROMETHEUS_SERVER_ENDPOINT": "http://mimir-url/prometheus/"
 func GetPrometheusHeaderXScopeOrgId() string {
 	return Get(PrometheusHeaderXScopeOrgIdEnvVar, "")

+ 1 - 1
pkg/prom/prom.go

@@ -68,7 +68,7 @@ func (auth *ClientAuth) Apply(req *http.Request) {
 // during a retry. This is to prevent starvation on the request threads
 const MaxRetryAfterDuration = 10 * time.Second
 
-// Default header key for Mimir API requests
+// Default header key for Mimir/Cortex-Tenant API requests
 const HeaderXScopeOrgId = "X-Scope-OrgID"
 
 // RateLimitRetryOpts contains retry options