Open the operations dashboard

Use the Gloo Platform operations dashboard to monitor the health of your Gloo Platform environment, such as the average translation and reconciliation time for the Gloo management server, or translation errors that occured. When you install a Gloo product, the built-in Prometheus server is configured with default alerts that are automatically populated into the operations dashboard when they occur.

The operations dashboard is built on top of Grafana, and is organized into different sections that provide an overview of the Gloo management server's and agent's health, and the overall Gloo Platform resource consumption.

Figure: Gloo Platform operations dashboard

To access the Gloo Platform operations dashboard, you must have Grafana installed in your cluster. You can easily do this by installing the Prometheus community Helm chart as shown in the steps on this page. However, if you have an existing Grafana instance that runs in your cluster already, you can add the operations dashboard to your Grafana instance. To do that, simply skip to step 6 and follow the instructions to import the operations dashboard.

  1. Install the Prometheus community Helm chart. This Helm chart automatically sets up Grafana in your cluster.

    helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
    helm repo update
    
    helm upgrade --install kube-prometheus-stack \
    prometheus-community/kube-prometheus-stack \
    --version 30.0.1 \
    --namespace monitoring \
    --create-namespace \
    --values - <<EOF
    grafana:
      additionalDataSources:
      - name: prometheus-gloo-platform
        type: prometheus
        url: http://prometheus-server.gloo-mesh:80
    EOF
    
  2. Verify that the pods are all up and running.

    kubectl get pods -n monitoring
    

    Example output:

    NAME                                                        READY   STATUS    RESTARTS   AGE
    alertmanager-kube-prometheus-stack-alertmanager-0           2/2     Running   0          5m18s
    kube-prometheus-stack-grafana-5d9f6d4ffd-gz9rn              3/3     Running   0          5m23s
    kube-prometheus-stack-kube-state-metrics-596b9c6b55-jk8s9   1/1     Running   0          5m23s
    kube-prometheus-stack-operator-7bb8679c95-bwfw5             1/1     Running   0          5m23s
    kube-prometheus-stack-prometheus-node-exporter-9qdgv        1/1     Running   0          5m24s
    kube-prometheus-stack-prometheus-node-exporter-dks8k        1/1     Running   0          5m24s
    kube-prometheus-stack-prometheus-node-exporter-z5p5z        1/1     Running   0          5m24s
    prometheus-kube-prometheus-stack-prometheus-0               2/2     Running   0          5m17s
    
  3. Set up port forwarding on your local machine to access the Grafana dashboard.

    kubectl port-forward $(kubectl get pods -n monitoring -o name | grep grafana) 8080:3000 -n monitoring
    
  4. Open the Grafana dashboard in your web browser.

  5. Log in to the Grafana dashboard with admin as the username, and prom-operator as the password. These are the default credentials that are set by the Prometheus community chart. You can change these credentials when you log in to Grafana.

  6. Import the Gloo Platform operations dashboard.

    1. Download the JSON file that holds the configuration for the Gloo Platform operations dashboard.
    2. From the Grafana menu, select + > Import.
    3. Click Upload JSON file and select the file for the Gloo Platform operations dashboard that you downloaded.
    4. Select prometheus-gloo-platform as the Grafana data source.
    5. Click Import to open the operations dashboard.
  7. Explore default Gloo Platform alerts that are set up when you installed Gloo.