Menu

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Open source

mimir.rules.kubernetes

mimir.rules.kubernetes discovers PrometheusRule Kubernetes resources and loads them into a Mimir instance.

  • Multiple mimir.rules.kubernetes components can be specified by giving them different labels.
  • Kubernetes label selectors can be used to limit the Namespace and PrometheusRule resources considered during reconciliation.
  • Compatible with the Ruler APIs of Grafana Mimir, Grafana Cloud, and Grafana Enterprise Metrics.
  • Compatible with the PrometheusRule CRD from the prometheus-operator.

Usage

river
mimir.rules.kubernetes "LABEL" {
  address = MIMIR_RULER_URL
}

Arguments

mimir.rules.kubernetes supports the following arguments:

NameTypeDescriptionDefaultRequired
addressstringURL of the Mimir ruler.yes
tenant_idstringMimir tenant ID.no
use_legacy_routesboolWhether to use deprecated ruler API endpoints.falseno
sync_intervaldurationAmount of time between reconciliations with Mimir.“30s”no
mimir_namespace_prefixstringPrefix used to differentiate multiple agent deployments.“agent”no

If no tenant_id is provided, the component assumes that the Mimir instance at address is running in single-tenant mode and no X-Scope-OrgID header is sent.

The sync_interval argument determines how often Mimir’s ruler API is accessed to reload the current state of rules. Interaction with the Kubernetes API works differently. Updates are processed as events from the Kubernetes API server according to the informer pattern.

The mimir_namespace_prefix argument can be used to separate the rules managed by multiple agent deployments across your infrastructure. It should be set to a unique value for each deployment.

Blocks

The following blocks are supported inside the definition of mimir.rules.kubernetes:

HierarchyBlockDescriptionRequired
rule_namespace_selectorlabel_selectorLabel selector for Namespace resources.no
rule_namespace_selector > match_expressionmatch_expressionLabel match expression for Namespace resources.no
rule_selectorlabel_selectorLabel selector for PrometheusRule resources.no
rule_selector > match_expressionmatch_expressionLabel match expression for PrometheusRule resources.no
http_client_confighttp_client_configHTTP client settings when connecting to the endpoint.no
http_client_config > basic_authbasic_authConfigure basic_auth for authenticating to the endpoint.no
http_client_config > authorizationauthorizationConfigure generic authorization to the endpoint.no
http_client_config > oauth2oauth2Configure OAuth2 for authenticating to the endpoint.no
http_client_config > oauth2 > tls_configtls_configConfigure TLS settings for connecting to the endpoint.no
http_client_config > tls_configtls_configConfigure TLS settings for connecting to the endpoint.no

The > symbol indicates deeper levels of nesting. For example, http_client_config > basic_auth refers to a basic_auth block defined inside an http_client_config block.

label_selector block

The label_selector block describes a Kubernetes label selector for rule or namespace discovery.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
match_labelsmap(string)Label keys and values used to discover resources.{}yes

When the match_labels argument is empty, all resources will be matched.

match_expression block

The match_expression block describes a Kubernetes label match expression for rule or namespace discovery.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
keystringThe label name to match against.yes
operatorstringThe operator to use when matching.yes
values[]stringThe values used when matching.no

The operator argument should be one of the following strings:

  • "in"
  • "notin"
  • "exists"

http_client_config block

The http_client_config configures settings used to connect to the Mimir API.

NameTypeDescriptionDefaultRequired
bearer_tokensecretBearer token to authenticate with.no
bearer_token_filestringFile containing a bearer token to authenticate with.no
proxy_urlstringHTTP proxy to proxy requests through.no
follow_redirectsboolWhether redirects returned by the server should be followed.trueno
enable_http_2boolWhether HTTP2 is supported for requests.trueno

bearer_token, bearer_token_file, basic_auth, authorization, and oauth2 are mutually exclusive and only one can be provided inside of a http_client_config block.

basic_auth block

NameTypeDescriptionDefaultRequired
usernamestringBasic auth username.no
passwordsecretBasic auth password.no
password_filestringFile containing the basic auth password.no

password and password_file are mututally exclusive and only one can be provided inside of a basic_auth block.

authorization block

NameTypeDescriptionDefaultRequired
typestringAuthorization type, for example, “Bearer”.no
credentialsecretSecret value.no
credentials_filestringFile containing the secret value.no

credential and credentials_file are mutually exclusive and only one can be provided inside of an authorization block.

oauth2 block

NameTypeDescriptionDefaultRequired
client_idstringOAuth2 client ID.no
client_secretsecretOAuth2 client secret.no
client_secret_filestringFile containing the OAuth2 client secret.no
scopeslist(string)List of scopes to authenticate with.no
token_urlstringURL to fetch the token from.no
endpoint_paramsmap(string)Optional parameters to append to the token URL.no
proxy_urlstringOptional proxy URL for OAuth2 requests.no

client_secret and client_secret_file are mututally exclusive and only one can be provided inside of an oauth2 block.

The oauth2 block may also contain its own separate tls_config sub-block.

tls_config block

NameTypeDescriptionDefaultRequired
ca_filestringCA certificate to validate the server with.no
cert_filestringCertificate file for client authentication.no
key_filestringKey file for client authentication.no
server_namestringServerName extension to indicate the name of the server.no
insecure_skip_verifyboolDisables validation of the server certificate.no
min_versionstringMinimum acceptable TLS version.no

When min_version is not provided, the minimum acceptable TLS version is inherited from Go’s default minimum version, TLS 1.2. If min_version is provided, it must be set to one of the following strings:

  • "TLS10" (TLS 1.0)
  • "TLS11" (TLS 1.1)
  • "TLS12" (TLS 1.2)
  • "TLS13" (TLS 1.3)

Exported fields

mimir.rules.kubernetes does not export any fields.

Component health

mimir.rules.kubernetes is reported as unhealthy if given an invalid configuration or an error occurs during reconciliation.

Debug information

mimir.rules.kubernetes exposes resource-level debug information.

The following are exposed per discovered PrometheusRule resource:

  • The Kubernetes namespace.
  • The resource name.
  • The resource uid.
  • The number of rule groups.

The following are exposed per discovered Mimir rule namespace resource:

  • The namespace name.
  • The number of rule groups.

Only resources managed by the component are exposed - regardless of how many actually exist.

Debug metrics

Metric NameTypeDescription
mimir_rules_config_updates_totalcounterNumber of times the configuration has been updated.
mimir_rules_events_totalcounterNumber of events processed, partitioned by event type.
mimir_rules_events_failed_totalcounterNumber of events that failed to be processed, partitioned by event type.
mimir_rules_events_retried_totalcounterNumber of events that were retried, partitioned by event type.
mimir_rules_client_request_duration_secondshistogramDuration of requests to the Mimir API.

Example

This example creates a mimir.rules.kubernetes component that loads discovered rules to a local Mimir instance under the team-a tenant. Only namespaces and rules with the agent label set to yes are included.

river
mimir.rules.kubernetes "local" {
    address = "mimir:8080"
    tenant_id = "team-a"

    rule_namespace_selector {
        match_labels = {
            agent = "yes",
        }
    }

    rule_selector {
        match_labels = {
            agent = "yes",
        }
    }
}

This example creates a mimir.rules.kubernetes component that loads discovered rules to Grafana Cloud.

river
mimir.rules.kubernetes "default" {
    address = "GRAFANA_CLOUD_METRICS_URL"
    http_client_config {
        basic_auth {
            username = "GRAFANA_CLOUD_USER"
            password = "GRAFANA_CLOUD_API_KEY"
            // Alternatively, load the password from a file:
            // password_file = "GRAFANA_CLOUD_API_KEY_PATH"
        }
    }
}