Skip to content

Monitoring with Prometheus and Grafana

For application monitoring, the Spotfire Helm charts are validated with Prometheus ⧉ and Grafana ⧉.

This page provides an overview of the steps to get Spotfire application metrics in Prometheus and visualize them with Grafana.

Note: This a quick start guide. For more information, see the official documentation of each vendor.

Prerequisites

  • You have deployed Spotfire using the provided Spotfire Helm charts.

Components

Prometheus

Installing

  1. Add the Prometheus Community Helm charts ⧉ repo: 

    helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
helm repo update

  2. Install Prometheus: 

    helm install prometheus prometheus-community/prometheus --create-namespace --namespace monitor --set nodeExporter.hostRootfs=false

  3. Set up port-forwarding to access the Prometheus server pod: 

    export POD_NAME=$(kubectl get pods --namespace monitor -l "app=prometheus,component=server" -o jsonpath="{.items[0].metadata.name}")
kubectl --namespace monitor port-forward $POD_NAME 9090 --address 0.0.0.0 > /dev/null &

For more information, see the Prometheus Community Helm charts documentation ⧉ and the Prometheus documentation ⧉.

Grafana

Installing

  1. Add the Grafana Helm chart ⧉ repo: 

    helm repo add grafana https://grafana.github.io/helm-charts
helm repo update

  2. Install Grafana: 

    helm install grafana grafana/grafana -n monitor

  3. After Grafana is deployed, get the Grafana UI admin user password: 

    kubectl get secret --namespace monitor grafana -o jsonpath="{.data.admin-password}" | base64 --decode ; echo

  4. Set port-forwarding to access the Grafana pod: 

    export POD_NAME=$(kubectl get pods --namespace monitor -l "app.kubernetes.io/name=grafana,app.kubernetes.io/instance=grafana" -o jsonpath="{.items[0].metadata.name}")
kubectl --namespace monitor port-forward $POD_NAME 3000 --address 0.0.0.0 > /dev/null &

  5. Log in to the Grafana web interface http://localhost:3000 with the user admin and the password from the previous step.

For more information, see the Grafana Helm chart documentation ⧉ and the Grafana documentation ⧉.

Configuring

  1. Add a metrics datasource ⧉ pointing to your Prometheus server. For example, set the Prometheus Data Source HTTP URL to "http://prometheus-server.monitor.svc.cluster.local:80" (the address to access the Prometheus server within your cluster that was shown when you deployed the Prometheus Helm chart) and select "Save & test".
  2. Import a dashboard ⧉ using a previously exported dashboard as a JSON file, or by dashboard ID.