Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 2.83 KB

README.md

File metadata and controls

70 lines (45 loc) · 2.83 KB

Monitoring

Steward provides some metrics to be collected by Prometheus or compatible monitoring software. See Metrics Reference.md for details.

There is also an example dashboard for Grafana available to display the metrics.

Example Installation with Prometheus Operator

Prerequisites

  • Environment variable $KUBECONFIG set
  • Helm 3 installed locally and initialized
  • You have cloned this repo and and your current directory is docs/monitoring

Install Prometheus Operator

Prometheus Operator is a common way to get Prometheus on a Kubernetes cluster.

There is a Helm chart for Prometheus Operator that can be installed like this:

helm install monitoring stable/prometheus-operator \
    --namespace monitoring

See the chart documentation for installation details.

Install Steward service monitor resources for Prometheus Operator

The Steward Helm chart can create service monitor resources for Prometheus Operator. By default this is disabled and can be enabled by parameter metrics.serviceMonitors.enabled=true. See the documentation of chart parameters metrics.serviceMonitors.* for details.

Service monitors can be enabled both for new installations and upgrades. An upgrade can also be used if the installed Steward version should be kept. In such case specify the same chart version that is installed, and just change the chart parameters.

Install Grafana Dashboards for Steward

File docs/monitoring/grafana_dashboard in this repository contains the definition of a Grafana dashboard for Steward.

It can be added to the Grafana instance installed with Prometheus Operator:

kubectl -n monitoring create configmap monitoring-prometheus-oper-steward --from-file ./grafana_dashboard.json \
&& kubectl -n monitoring label configmap monitoring-prometheus-oper-steward grafana_dashboard=1

Access the Grafana UI

To access Grafana with your local browser, establish a port-forwarding to the Grafana service on your cluster. The following example forwards your local port 7900 to Grafana's service port:

kubectl -n monitoring port-forward $(kubectl -n monitoring --selector=app=grafana get pod -o name) 7900:3000

You can then access Grafana using this URL:

http://localhost:7900/

You may choose another local port number according to your needs.