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 Agent Flow mode Reference Components reference prometheus.operator.servicemonitors

prometheus.operator.servicemonitors

BETA: This is a beta component. Beta components are subject to breaking changes, and may be replaced with equivalent functionality that cover the same use case.

prometheus.operator.servicemonitors discovers ServiceMonitor resources in your kubernetes cluster and scrapes the targets they reference. This component performs three main functions:

1. Discover ServiceMonitor resources from your Kubernetes cluster.
2. Discover Services and Endpoints in your cluster that match those ServiceMonitors.
3. Scrape metrics from those Endpoints, and forward them to a receiver.

The default configuration assumes the agent is running inside a Kubernetes cluster, and uses the in-cluster config to access the Kubernetes API. It can be run from outside the cluster by supplying connection info in the client block, but network level access to discovered endpoints is required to scrape metrics from them.

ServiceMonitors may reference secrets for authenticating to targets to scrape them. In these cases, the secrets are loaded and refreshed only when the ServiceMonitor is updated or when this component refreshes its’ internal state, which happens on a 5-minute refresh cycle.

Usage

river Copy

prometheus.operator.servicemonitors "LABEL" {
    forward_to = RECEIVER_LIST
}

Arguments

The following arguments are supported:

Blocks

The following blocks are supported inside the definition of prometheus.operator.servicemonitors:

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

client block

The client block configures the Kubernetes client used to discover ServiceMonitors. If the client block isn’t provided, the default in-cluster configuration with the service account of the running Grafana Agent pod is used.

The following arguments are supported:

At most one of the following can be provided:

• bearer_token argument.
• bearer_token_file argument.
• basic_auth block.
• authorization block.
• oauth2 block.

basic_auth block

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

authorization block

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

oauth2 block

client_secret and client_secret_file are mutually 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

The following pairs of arguments are mutually exclusive and cannot both be set simultaneously:

• ca_pem and ca_file
• cert_pem and cert_file
• key_pem and key_file

When configuring client authentication, both the client certificate (using cert_pem or cert_file) and the client key (using key_pem or key_file) must be provided.

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)

rule block

The rule block contains the definition of any relabeling rules that can be applied to an input metric. If more than one rule block is defined, the transformations are applied in top-down order.

The following arguments can be used to configure a rule. All arguments are optional. Omitted fields take their default values.

Here’s a list of the available actions, along with a brief description of their usage.

• replace - Matches regex to the concatenated labels. If there’s a match, it replaces the content of the target_label using the contents of the replacement field.
• keep - Keeps metrics where regex matches the string extracted using the source_labels and separator.
• drop - Drops metrics where regex matches the string extracted using the source_labels and separator.
• hashmod - Hashes the concatenated labels, calculates its modulo modulus and writes the result to the target_label.
• labelmap - Matches regex against all label names. Any labels that match are renamed according to the contents of the replacement field.
• labeldrop - Matches regex against all label names. Any labels that match are removed from the metric’s label set.
• labelkeep - Matches regex against all label names. Any labels that don’t match are removed from the metric’s label set.
• keepequal - Drop targets for which the concatenated source_labels do not match target_label.
• dropequal - Drop targets for which the concatenated source_labels do match target_label.
• lowercase - Sets target_label to the lowercase form of the concatenated source_labels.
• uppercase - Sets target_label to the uppercase form of the concatenated source_labels.

Finally, note that the regex capture groups can be referred to using either the $CAPTURE_GROUP_NUMBER or ${CAPTURE_GROUP_NUMBER} notation.

selector block

The selector block describes a Kubernetes label selector for ServiceMonitors.

The following arguments are supported:

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

match_expression block

The match_expression block describes a Kubernetes label matcher expression for ServiceMonitors discovery.

The following arguments are supported:

The operator argument must be one of the following strings:

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

If there are multiple match_expressions blocks inside of a selector block, they are combined together with AND clauses.

clustering (beta)

When the agent is using using clustering, and enabled is set to true, then this component instance opts-in to participating in the cluster to distribute scrape load between all cluster nodes.

Clustering assumes that all cluster nodes are running with the same configuration file, and that all prometheus.operator.servicemonitors components that have opted-in to using clustering, over the course of a scrape interval have the same configuration.

All prometheus.operator.servicemonitors components instances opting in to clustering use target labels and a consistent hashing algorithm to determine ownership for each of the targets between the cluster peers. Then, each peer only scrapes the subset of targets that it is responsible for, so that the scrape load is distributed. When a node joins or leaves the cluster, every peer recalculates ownership and continues scraping with the new target set. This performs better than hashmod sharding where all nodes have to be re-distributed, as only 1/N of the target’s ownership is transferred, but is eventually consistent (rather than fully consistent like hashmod sharding is).

If the agent is not running in clustered mode, then the block is a no-op, and prometheus.operator.servicemonitors scrapes every target it receives in its arguments.

Exported fields

prometheus.operator.servicemonitors does not export any fields. It forwards all metrics it scrapes to the receiver configures with the forward_to argument.

Component health

prometheus.operator.servicemonitors is reported as unhealthy when given an invalid configuration, Prometheus components fail to initialize, or the connection to the Kubernetes API could not be established properly.

Debug information

prometheus.operator.servicemonitors reports the status of the last scrape for each configured scrape job on the component’s debug endpoint, including discovered labels, and the last scrape time.

It also exposes some debug information for each ServiceMonitor it has discovered, including any errors found while reconciling the scrape configuration from the ServiceMonitor.

Debug metrics

Example

This example discovers all ServiceMonitors in your cluster, and forwards collected metrics to a prometheus.remote_write component.

river Copy

prometheus.remote_write "staging" {
  // Send metrics to a locally running Mimir.
  endpoint {
    url = "http://mimir:9009/api/v1/push"

    basic_auth {
      username = "example-user"
      password = "example-password"
    }
  }
}

prometheus.operator.servicemonitors "services" {
    forward_to = [prometheus.remote_write.staging.receiver]
}

This example will limit discovered ServiceMonitors to ones with the label team=ops in a specific namespace: my-app.

river Copy

prometheus.operator.servicemonitors "services" {
    forward_to = [prometheus.remote_write.staging.receiver]
    namespaces = ["my-app"]
    selector {
        match_expression {
            key = "team"
            operator = "In"
            values = ["ops"]
        }
    }
}

This example will apply additional relabel rules to discovered targets to filter by hostname. This may be useful if running the agent as a DaemonSet.

river Copy

prometheus.operator.servicemonitors "services" {
    forward_to = [prometheus.remote_write.staging.receiver]
    rule {
      action = "keep"
      regex = env("HOSTNAME")
      source_labels = ["__meta_kubernetes_pod_node_name"]
    }
}