https://github.com/openshift/cluster-monitoring-operator
Manage the OpenShift monitoring stack
https://github.com/openshift/cluster-monitoring-operator
Last synced: 2 days ago
JSON representation
Manage the OpenShift monitoring stack
- Host: GitHub
- URL: https://github.com/openshift/cluster-monitoring-operator
- Owner: openshift
- License: apache-2.0
- Created: 2018-04-11T20:36:53.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T09:09:42.000Z (4 months ago)
- Last Synced: 2024-10-29T11:33:09.005Z (4 months ago)
- Language: Go
- Size: 79.2 MB
- Stars: 247
- Watchers: 171
- Forks: 363
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# Cluster Monitoring Operator
The Cluster Monitoring Operator manages and updates the Prometheus-based cluster monitoring stack deployed on top of OpenShift.
It contains the following components:
* [Prometheus Operator](https://github.com/coreos/prometheus-operator)
* [Prometheus](https://github.com/prometheus/prometheus)
* [Alertmanager](https://github.com/prometheus/alertmanager) cluster for cluster and application level alerting
* [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics)
* [node_exporter](https://github.com/prometheus/node_exporter)
* [kubernetes-metrics-server](https://github.com/openshift/kubernetes-metrics-server)
The deployed Prometheus instance (`prometheus-k8s`) is responsible for monitoring and alerting on cluster and OpenShift components; it should not be extended to monitor user applications. Users interested in leveraging Prometheus for application monitoring on OpenShift should consider enabling [User Workload Monitoring](https://docs.openshift.com/container-platform/latest/observability/monitoring/enabling-monitoring-for-user-defined-projects.html) to easily setup new Prometheus instances to monitor and alert on their applications.
Alertmanager is a cluster-global component for handling alerts generated by all Prometheus instances deployed in that cluster.
## Adding new metrics to be sent via telemetry
See the [Sending metrics via Telemetry](https://rhobs-handbook.netlify.app/products/openshiftmonitoring/telemetry.md/) page.
Documentation on the data sent can be found in the [data collection documentation](Documentation/data-collection.md).
## Contributing
Please refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) document for information.
## Release
Release checklist is available when creating new ["Release Checklist" issue](https://github.com/openshift/cluster-monitoring-operator/issues/new?template=release.md).