Prometheus Operator Concepts: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 24: Line 24:


==<span id='ServiceMonitor'></span>ServiceMonitor Resource==
==<span id='ServiceMonitor'></span>ServiceMonitor Resource==
A ServiceMonitor is a custom resource that can be used to specify a monitoring target to the Prometheus server. The ServiceMonitor describes how metrics can be retrieved from a set of [[Kubernetes_Service_Concepts#Service_.28ClusterIP_Service.29|Services]] exposing the monitoring targets' pods.
A ServiceMonitor is a custom resource that can be used to specify a monitoring target to the Prometheus server. The ServiceMonitor describes how metrics can be retrieved from a set of [[Kubernetes_Service_Concepts#Service_.28ClusterIP_Service.29|Services]] exposing the monitoring targets' pods. The [[#Prometheus_Resource|Prometheus]] instance is associated with the ServiceMonitors by labels: the ServiceMonitor instance must match [[#Prometheus_Resource|Prometheus]] serviceMonitorSelector. The Operator configures the Prometheus server instances to monitor all Services that match the included ServiceMonitors and keeps this configuration synchronized with any changes happening in the cluster. The Services are associated with their ServiceMonitors with labels
 
 
<font color=darkgray>The labels are important, they must match [[#Prometheus_Resource|Prometheus]] serviceMonitorSelector.</font>


The current service monitor list can be obtained with:
The current service monitor list can be obtained with:

Revision as of 22:46, 14 October 2020

Internal

Overview

The Operator decouples the deployment of Prometheus instances from the configuration of which targets they are monitoring. The Operator defines two custom resources: Prometheus and ServiceMonitor.

The Operator ensures that for each Prometheus resource there is a set of Prometheus servers that are running with the correct configuration. The operator manages the servers' configuration, including persistent volume claims, number of replicas, the server version, the Alertmanager instances, the monitoring targets and their associated parameters.

The monitoring targets and their parameters can be set manually, but the preferred option is to let the Operator generate the configuration based on declared ServiceMonitor instances.

PrometheusOperator.png

Custom Resources

Prometheus Resource

The Prometheus resource declares a "serviceMonitorSelector":

apiVersion: monitoring.coreos.com/v1
kind: Prometheus
...
spec:
  serviceMonitorSelector:
    matchLabels:
      release: prometheus

ServiceMonitor Resource

A ServiceMonitor is a custom resource that can be used to specify a monitoring target to the Prometheus server. The ServiceMonitor describes how metrics can be retrieved from a set of Services exposing the monitoring targets' pods. The Prometheus instance is associated with the ServiceMonitors by labels: the ServiceMonitor instance must match Prometheus serviceMonitorSelector. The Operator configures the Prometheus server instances to monitor all Services that match the included ServiceMonitors and keeps this configuration synchronized with any changes happening in the cluster. The Services are associated with their ServiceMonitors with labels

The current service monitor list can be obtained with:

kubectl -n <namespace> get servicemonitors

Configuring Prometheus with Prometheus Operator

Configuring Prometheus with Prometheus Operator