Skip to content

cortex-proxy.md

Latest commit

 

History

History
56 lines (39 loc) · 2.74 KB

cortex-proxy.md

File metadata and controls

56 lines (39 loc) · 2.74 KB
Raw

Important

This project is a permanent hard-fork of the origin project.

Cortex Proxy

Architecture

Cortex/Mimir tenants (separate namespaces where metrics are stored to and queried from) are identified by X-Scope-OrgID HTTP header on both writes and queries.

This software solves the problem using the following logic:

  • Receive Prometheus remote write
  • Search each timeseries for a specific label name and extract a tenant ID from its value. If the label wasn't found then it can fall back to a configurable default ID. If none is configured then the write request will be rejected with HTTP code 400
  • Optionally removes this label from the timeseries
  • Groups timeseries by tenant
  • Issues a number of parallel per-tenant HTTP requests to Cortex/Mimir with the relevant tenant HTTP header (X-Scope-OrgID by default)

Installation

Association

Read the Association documentation for more information on how to associate tenant IDs.

Configuration

Read the Configuration documentation for more information on how to configure the proxy.

Monitoring

Via the /metrics endpoint and the dedicated port you can scrape Prometheus Metrics. Amongst the standard Kubebuilder Metrics we provide metrics, which show the current state of translators or tenants. This way you can always be informed, when something is not working as expected. Our custom metrics are prefixed with cortex_:

curl -s http://localhost:8080/metrics | grep "cortex_"

...

# HELP cca_tenant_condition The current condition status of a Tenant.
# TYPE cca_tenant_condition gauge
cca_tenant_condition{name="oil",status="NotReady"} 0
cca_tenant_condition{name="oil",status="Ready"} 1
cca_tenant_condition{name="solar",status="NotReady"} 1
cca_tenant_condition{name="solar",status="Ready"} 0
cca_tenant_condition{name="wind",status="NotReady"} 0
cca_tenant_condition{name="wind",status="Ready"} 1
# HELP cca_translator_condition The current condition status of a Translator.
# TYPE cca_translator_condition gauge
cca_translator_condition{name="default-onboarding",status="NotReady"} 1
cca_translator_condition{name="default-onboarding",status="Ready"} 0
cca_translator_condition{name="dev-onboarding",status="NotReady"} 1
cca_translator_condition{name="dev-onboarding",status="Ready"} 0

The Helm-Chart comes with a ServiceMonitor and PrometheusRules