Available as of v2.2.0

Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with Prometheus, a leading open-source monitoring solution.

This section covers the following topics:

About Prometheus

Prometheus provides a time series of your data, which is, according to Prometheus documentation:

You can configure these services to collect logs at either the cluster level or the project level. This page describes how to enable monitoring for a cluster. For details on enabling monitoring for a project, refer to the project administration section.

A stream of timestamped values belonging to the same metric and the same set of labeled dimensions, along with comprehensive statistics and metrics of the monitored cluster.

In other words, Prometheus lets you view metrics from your different Rancher and Kubernetes objects. Using timestamps, Prometheus lets you query and view these metrics in easy-to-read graphs and visuals, either through the Rancher UI or Grafana, which is an analytics viewing platform deployed along with Prometheus.

By viewing data that Prometheus scrapes from your cluster control plane, nodes, and deployments, you can stay on top of everything happening in your cluster. You can then use these analytics to better run your organization: stop system emergencies before they start, develop maintenance strategies, restore crashed servers, etc.

Multi-tenancy support in terms of cluster-only and project-only Prometheus instances are also supported.

Monitoring Scope

Using Prometheus, you can monitor Rancher at both the cluster level and project level. For each cluster and project that is enabled for monitoring, Rancher deploys a Prometheus server.

  • Cluster monitoring allows you to view the health of your Kubernetes cluster. Prometheus collects metrics from the cluster components below, which you can view in graphs and charts.

    • Kubernetes control plane
    • etcd database
    • All nodes (including workers)
  • Project monitoring allows you to view the state of pods running in a given project. Prometheus collects metrics from the project’s deployed HTTP and TCP/UDP workloads.

Enabling Cluster Monitoring

As an administrator or cluster owner, you can configure Rancher to deploy Prometheus to monitor your Kubernetes cluster.

Prerequisites: The following TCP ports need to be opened for metrics scraping:

Port Node type Component
9796 Worker Node exporter
10254 Worker Nginx Ingress Controller
10250 Worker/Controlplane Kubelet
10251 Controlplane Kube scheduler
10252 Controlplane Kube controller manager
2379 Etcd Etcd server

Monitoring V1 requires a Kubernetes verison less than or equal to v1.20.x. To install monitoring on Kubernetes v1.21+, you will need to migrate to Monitoring V2.

  1. From the Global view, navigate to the cluster that you want to configure cluster monitoring.

  2. Select Tools > Monitoring in the navigation bar.

  3. Select Enable to show the Prometheus configuration options. Review the resource consumption recommendations to ensure you have enough resources for Prometheus and on your worker nodes to enable monitoring. Enter in your desired configuration options.

  4. Click Save.

Result: The Prometheus server will be deployed as well as two monitoring applications. The two monitoring applications, cluster-monitoring and monitoring-operator, are added as an application to the cluster’s system project. After the applications are active, you can start viewing cluster metrics through the Rancher dashboard or directly from Grafana.

The default username and password for the Grafana instance will be admin/admin. However, Grafana dashboards are served via the Rancher authentication proxy, so only users who are currently authenticated into the Rancher server have access to the Grafana dashboard.

Resource Consumption

When enabling cluster monitoring, you need to ensure your worker nodes and Prometheus pod have enough resources. The tables below provides a guide of how much resource consumption will be used. In larger deployments, it is strongly advised that the monitoring infrastructure be placed on dedicated nodes in the cluster.

Resource Consumption of Prometheus Pods

This table is the resource consumption of the Prometheus pod, which is based on the number of all the nodes in the cluster. The count of nodes includes the worker, control plane and etcd nodes. Total disk space allocation should be approximated by the rate * retention period set at the cluster level. When enabling cluster level monitoring, you should adjust the CPU and Memory limits and reservation.

Number of Cluster Nodes CPU (milli CPU) Memory Disk
5 500 650 MB ~1 GB/Day
50 2000 2 GB ~5 GB/Day
256 4000 6 GB ~18 GB/Day

Additional pod resource requirements for cluster level monitoring.

Workload Container CPU - Request Mem - Request CPU - Limit Mem - Limit Configurable
Prometheus prometheus 750m 750Mi 1000m 1000Mi Y
prometheus-proxy 50m 50Mi 100m 100Mi Y
prometheus-auth 100m 100Mi 500m 200Mi Y
prometheus-config-reloader - - 50m 50Mi N
rules-configmap-reloader - - 100m 25Mi N
Grafana grafana-init-plugin-json-copy 50m 50Mi 50m 50Mi Y
grafana-init-plugin-json-modify 50m 50Mi 50m 50Mi Y
grafana 100m 100Mi 200m 200Mi Y
grafana-proxy 50m 50Mi 100m 100Mi Y
Kube-State Exporter kube-state 100m 130Mi 100m 200Mi Y
Node Exporter exporter-node 200m 200Mi 200m 200Mi Y
Operator prometheus-operator 100m 50Mi 200m 100Mi Y

Resource Consumption of Other Pods

Besides the Prometheus pod, there are components that are deployed that require additional resources on the worker nodes.

Pod CPU (milli CPU) Memory (MB)
Node Exporter (Per Node) 100 30
Kube State Cluster Monitor 100 130
Grafana 100 150
Prometheus Cluster Monitoring Nginx 50 50