Add selectors to ServiceMonitor, PodMonitor and Probe objects (#389)

grafana · Feb 26, 2024 · df734dd · df734dd
1 parent d73d5f6
commit df734dd
Show file tree

Hide file tree

Showing 5 changed files with 78 additions and 4 deletions.
diff --git a/charts/k8s-monitoring/README.md b/charts/k8s-monitoring/README.md
@@ -300,16 +300,19 @@ The Prometheus and Loki services may be hosted on the same cluster, or remotely
 | metrics.podMonitors.extraMetricRelabelingRules | string | `""` | Rule blocks to be added to the prometheus.relabel component for PodMonitor objects. ([docs](https://grafana.com/docs/agent/latest/flow/reference/components/prometheus.relabel/#rule-block)) |
 | metrics.podMonitors.namespaces | list | `[]` | Which namespaces to look for PodMonitor objects. |
 | metrics.podMonitors.scrapeInterval | string | 60s | How frequently to scrape metrics from PodMonitor objects. Only used if the PodMonitor does not specify the scrape interval. Overrides metrics.scrapeInterval |
+| metrics.podMonitors.selector | string | `""` | Which podMonitor objects to select |
 | metrics.probes.enabled | bool | `true` | Include service discovery for Probe objects. |
 | metrics.probes.extraMetricRelabelingRules | string | `""` | Rule blocks to be added to the prometheus.relabel component for Probe objects. ([docs](https://grafana.com/docs/agent/latest/flow/reference/components/prometheus.relabel/#rule-block)) |
 | metrics.probes.namespaces | list | `[]` | Which namespaces to look for Probe objects. |
 | metrics.probes.scrapeInterval | string | 60s | How frequently to scrape metrics from Probe objects. Only used if the Probe does not specify the scrape interval. Overrides metrics.scrapeInterval |
+| metrics.probes.selector | string | `""` | Which probe objects to select |
 | metrics.receiver.filters | object | `{"datapoint":[],"metric":[]}` | Apply a filter to metrics received via the OTLP or OTLP HTTP receivers. ([docs](https://grafana.com/docs/agent/latest/flow/reference/components/otelcol.processor.filter/)) |
 | metrics.scrapeInterval | string | `"60s"` | How frequently to scrape metrics |
 | metrics.serviceMonitors.enabled | bool | `true` | Include service discovery for ServiceMonitor objects |
 | metrics.serviceMonitors.extraMetricRelabelingRules | string | `""` | Rule blocks to be added to the prometheus.relabel component for ServiceMonitor objects. ([docs](https://grafana.com/docs/agent/latest/flow/reference/components/prometheus.relabel/#rule-block)) |
 | metrics.serviceMonitors.namespaces | list | `[]` | Which namespaces to look for ServiceMonitor objects. |
 | metrics.serviceMonitors.scrapeInterval | string | 60s | How frequently to scrape metrics from ServiceMonitor objects. Only used if the ServiceMonitor does not specify the scrape interval. Overrides metrics.scrapeInterval |
+| metrics.serviceMonitors.selector | string | `""` | Which serviceMonitors objects to select |
 | metrics.windows-exporter.enabled | bool | `false` | Scrape node metrics |
 | metrics.windows-exporter.extraMetricRelabelingRules | string | `""` | Rule blocks to be added to the prometheus.relabel component for Windows Exporter. ([docs](https://grafana.com/docs/agent/latest/flow/reference/components/prometheus.relabel/#rule-block)) |
 | metrics.windows-exporter.extraRelabelingRules | string | `""` | Rule blocks to be added to the discovery.relabel component for Windows Exporter. ([docs](https://grafana.com/docs/agent/latest/flow/reference/components/discovery.relabel/#rule-block)) |
@@ -418,12 +421,31 @@ For an example values file and generated output, see [this example](../../exampl
 
 ### Using Prometheus Operator CRDs
 
-The default config can deploy the CRDs for Prometheus Operator, and will add support for `PodMonitor` and
-`ServiceMonitor` objects.
+The default config can deploy the CRDs for Prometheus Operator, and will add support for `PodMonitor`,
+`ServiceMonitor` and `Probe` objects.
 
 Simply deploy a PodMonitor or a ServiceMonitor in the same namespace as the Grafana Agent and it will discover it and
 take the appropriate action.
 
+Use a selector to limit the discovered objects
+
+Example:
+
+In this example, the Agent will find `ServiceMonitor` objects labeld with
+`example.com/environment=production`, scrape them for Prometheus metrics, and send those metrics to Grafana Cloud.
+
+```yaml
+serviceMonitors:
+  enabled: true
+  selector: |-
+    match_expression {
+      key = "example.com/environment"
+      operator = "In"
+      values = ["production"]
+    }
+
+```
+
 ## Platform-specific instructions
 
 ### OpenShift

diff --git a/charts/k8s-monitoring/README.md.gotmpl b/charts/k8s-monitoring/README.md.gotmpl
@@ -145,12 +145,31 @@ For an example values file and generated output, see [this example](../../exampl
 
 ### Using Prometheus Operator CRDs
 
-The default config can deploy the CRDs for Prometheus Operator, and will add support for `PodMonitor` and
-`ServiceMonitor` objects.
+The default config can deploy the CRDs for Prometheus Operator, and will add support for `PodMonitor`, 
+`ServiceMonitor` and `Probe` objects.
 
 Simply deploy a PodMonitor or a ServiceMonitor in the same namespace as the Grafana Agent and it will discover it and
 take the appropriate action.
 
+Use a selector to limit the discovered objects
+
+Example: 
+
+In this example, the Agent will find `ServiceMonitor` objects labeld with
+`example.com/environment=production`, scrape them for Prometheus metrics, and send those metrics to Grafana Cloud.
+
+```yaml
+serviceMonitors:
+  enabled: true
+  selector: |-
+    match_expression {
+      key = "example.com/environment"
+      operator = "In"
+      values = ["production"]
+    }
+
+```
+
 ## Platform-specific instructions
 
 ### OpenShift

diff --git a/charts/k8s-monitoring/templates/agent_config/_prometheus_operator_objects.txt b/charts/k8s-monitoring/templates/agent_config/_prometheus_operator_objects.txt
@@ -3,6 +3,11 @@
 prometheus.operator.podmonitors "pod_monitors" {
   namespaces = {{ .Values.metrics.podMonitors.namespaces | toJson }}
   forward_to = [prometheus.relabel.podmonitors.receiver]
+{{- if .Values.metrics.podMonitors.selector }}
+  selector {
+{{ .Values.metrics.podMonitors.selector | indent 4 }}
+  }
+{{- end }}
 {{- if (index .Values "grafana-agent").agent.clustering.enabled }}
   clustering {
     enabled = true
@@ -26,6 +31,11 @@ prometheus.relabel "podmonitors" {
 prometheus.operator.probes "probes" {
   namespaces = {{ .Values.metrics.probes.namespaces | toJson }}
   forward_to = [prometheus.relabel.probes.receiver]
+{{- if .Values.metrics.probes.selector }}
+  selector {
+{{ .Values.metrics.probes.selector | indent 4 }}
+  }
+{{- end }}
 {{- if (index .Values "grafana-agent").agent.clustering.enabled }}
   clustering {
     enabled = true
@@ -50,6 +60,11 @@ prometheus.relabel "probes" {
 prometheus.operator.servicemonitors "service_monitors" {
   namespaces = {{ .Values.metrics.serviceMonitors.namespaces | toJson }}
   forward_to = [prometheus.relabel.servicemonitors.receiver]
+{{- if .Values.metrics.serviceMonitors.selector }}
+  selector {
+{{ .Values.metrics.serviceMonitors.selector | indent 4 }}
+  }
+{{- end }}
 {{- if (index .Values "grafana-agent").agent.clustering.enabled }}
   clustering {
     enabled = true

diff --git a/charts/k8s-monitoring/values.schema.json b/charts/k8s-monitoring/values.schema.json
@@ -997,6 +997,9 @@
                         },
                         "scrapeInterval": {
                             "type": "string"
+                        },
+                        "selector": {
+                            "type": "string"
                         }
                     }
                 },
@@ -1014,6 +1017,9 @@
                         },
                         "scrapeInterval": {
                             "type": "string"
+                        },
+                        "selector": {
+                            "type": "string"
                         }
                     }
                 },
@@ -1050,6 +1056,9 @@
                         },
                         "scrapeInterval": {
                             "type": "string"
+                        },
+                        "selector": {
+                            "type": "string"
                         }
                     }
                 },

diff --git a/charts/k8s-monitoring/values.yaml b/charts/k8s-monitoring/values.yaml
@@ -600,6 +600,9 @@ metrics:
     # -- Rule blocks to be added to the prometheus.relabel component for PodMonitor objects. ([docs](https://grafana.com/docs/agent/latest/flow/reference/components/prometheus.relabel/#rule-block))
     extraMetricRelabelingRules: ""
 
+    # -- Which podMonitor objects to select
+    selector: ""
+
   probes:
     # -- Include service discovery for Probe objects.
     enabled: true
@@ -615,6 +618,9 @@ metrics:
     # -- Rule blocks to be added to the prometheus.relabel component for Probe objects. ([docs](https://grafana.com/docs/agent/latest/flow/reference/components/prometheus.relabel/#rule-block))
     extraMetricRelabelingRules: ""
 
+    # -- Which probe objects to select
+    selector: ""
+
   serviceMonitors:
     # -- Include service discovery for ServiceMonitor objects
     enabled: true
@@ -630,6 +636,9 @@ metrics:
     # -- Rule blocks to be added to the prometheus.relabel component for ServiceMonitor objects. ([docs](https://grafana.com/docs/agent/latest/flow/reference/components/prometheus.relabel/#rule-block))
     extraMetricRelabelingRules: ""
 
+    # -- Which serviceMonitors objects to select
+    selector: ""
+
   kubernetesMonitoring:
     # -- Report telemetry about this Kubernetes Monitoring chart as a metric.
     enabled: true