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.

Documentation Grafana Alloy Reference Components mimir mimir.rules.kubernetes

mimir.rules.kubernetes

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

• You can specify multiple mimir.rules.kubernetes components 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.
• This component accesses the Kubernetes REST API from within a Pod.

Usage

alloy Copy

mimir.rules.kubernetes "<LABEL>" {
  address = "<MIMIR_RULER_URL>"
}

Arguments

You can use the following arguments with mimir.rules.kubernetes:

At most, one of the following can be provided:

• authorization block
• basic_auth block
• bearer_token_fileargument
• bearer_token argument
• oauth2 block

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 the Mimir 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 Alloy deployments across your infrastructure. It should be set to a unique value for each deployment.

If use_legacy_routes is set to true, mimir.rules.kubernetes contacts Mimir on a /api/v1/rules endpoint.

If prometheus_http_prefix is set to /mimir, mimir.rules.kubernetes contacts Mimir on a /mimir/config/v1/rules endpoint. This is useful if you configure Mimir to use a different prefix for its Prometheus endpoints than the default one.

prometheus_http_prefix is ignored if use_legacy_routes is set to true.

external_labels overrides label values if labels with the same names already exist inside the rule.

Blocks

You can use the following blocks with mimir.rules.kubernetes:

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

authorization

basic_auth

rule_selector and rule_namespace_selector

The rule_selector and rule_namespace_selector blocks describe a Kubernetes label selector for rule or namespace discovery.

The following arguments are supported:

When the match_labels argument is empty, all resources are matched.

match_expression

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

The following arguments are supported:

The operator argument should be one of the following strings:

• "In"
• "NotIn"
• "Exists"
• "DoesNotExist"

The values argument must not be provided when operator is set to "Exists" or "DoesNotExist".

oauth2

tls_config

Exported fields

mimir.rules.kubernetes doesn’t 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

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 alloy label set to yes are included.

alloy Copy

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

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

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

This example creates a mimir.rules.kubernetes component that loads discovered rules to Grafana Cloud. It also adds a "label1" label to each rule. If that label already exists, it’s overwritten with "value1".

alloy Copy

mimir.rules.kubernetes "default" {
    address = ">GRAFANA_CLOUD_METRICS_URL>"
    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>"
    }
    external_labels = {"label1" = "value1"}
}

The following example is an RBAC configuration for Kubernetes. It authorizes Alloy to query the Kubernetes REST API:

YAML Copy

apiVersion: v1
kind: ServiceAccount
metadata:
  name: alloy
  namespace: default
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: alloy
rules:
- apiGroups: [""]
  resources: ["namespaces"]
  verbs: ["get", "list", "watch"]
- apiGroups: ["monitoring.coreos.com"]
  resources: ["prometheusrules"]
  verbs: ["get", "list", "watch"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: alloy
subjects:
- kind: ServiceAccount
  name: alloy
  namespace: default
roleRef:
  kind: ClusterRole
  name: alloy
  apiGroup: rbac.authorization.k8s.io