Available as of v2.2.4

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.

For more information about how Prometheus works, refer to the cluster administration section.

This section covers the following topics:

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.

  • 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.

Permissions to Configure Project Monitoring

Only administrators, cluster owners or members, or project owners can configure project level monitoring. Project members can only view monitoring metrics.

Configuring Project Monitoring

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

  2. Select Tools > Monitoring in the navigation bar.

  3. Select Enable to show the Prometheus configuration options. Enter in your desired configuration options.

  4. Click Save.

Project-Level Monitoring Resource Requirements

Container CPU - Request Mem - Request CPU - Limit Mem - Limit Configurable
Prometheus 750m 750Mi 1000m 1000Mi Yes
Grafana 100m 100Mi 200m 200Mi No

Result: A single application,project-monitoring, is added as an application to the project. After the application is active, you can start viewing project metrics through the Rancher dashboard or directly from Grafana.

Project Metrics

If cluster monitoring is also enabled for the project, workload metrics are available for the project.

You can monitor custom metrics from any exporters as long as project monitoring is enabled. You can also expose some custom endpoints on deployments without needing to configure Prometheus for your project.

Example: A Redis application is deployed in the namespace redis-app in the project Datacenter. It is monitored via Redis exporter. After enabling project monitoring, you can edit the application to configure the Advanced Options -> Custom Metrics section. Enter the Container Port and Path and select the Protocol.