Name: cluster-monitoring-operator
Owner: OpenShift
Description: Manage the OpenShift monitoring stack
Created: 2018-04-11 20:36:53.0
Updated: 2018-05-24 12:20:32.0
Pushed: 2018-05-24 12:20:30.0
Homepage: null
Size: 10895
Language: Go
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
The Cluster Monitoring Operator manages and updates the Prometheus-based monitoring stack deployed on top of OpenShift.
It contains the following components:
The deployed Prometheus Operator is meant to be leveraged by users to easily deploy new Prometheus setup for their application monitoring.
The Prometheus instance (prometheus-k8s
) is responsible for monitoring and alerting on cluster and OpenShift components. It should not be extended to monitor user applications.
Alertmanager is a cluster-global component for handling alerts generated by all Prometheus instances deployed in that cluster.
Metrics are collected from the following components
prometheus-k8s
for now)Important: The Prometheus Operator managed by the Cluster Monitoring Operator will by default only look for ServiceMonitor
resources in namespaces containing an openshift.io/cluster-monitoring
label (with any value).
The Cluster Monitoring Operator has many builtin ServiceMonitor
resources which enable discovering the metrics endpoints of a variety of well-known components.
To register a new builtin component, make the following changes:
ServiceMonitor
manifest file to assets/prometheus-k8s following the existing prometheus-k8s-service-monitor-$COMPONENT.yaml
naming convention.Factory
method in pkg/manifests/manifests.go which loads the manifest using the new constant.PrometheusTask
in pkg/tasks/prometheus.go which creates the ServiceMonitor
using the Factory
new method.To add a new builtin alerting rule:
Run make generate
after you modify the files and make sure to add the modified files to the commit.
Run e2e-tests with make e2e-test
.
Clean up after e2e-tests with make e2e-clean