Operations dashboard

About link

Use the Gloo operations dashboard to monitor the health of your Gloo Mesh Enterprise environment, such as the average translation and reconciliation time for the Gloo management server, or translation errors that occurred. 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 lets you monitor the health of your Gloo Mesh Gateway environment, such as the average translation and reconciliation time for the Gloo management server, or translation errors that occurred. Built on top of Grafana, the dashboard is configured to visualize critical Gloo Mesh Gateway metrics and alerts for you so that you can quickly see errors and the performance of Gloo Mesh Gateway components.

With the operations dashboard, you have access to the following key features:

• Gloo Mesh Gateway metrics and alerts: Quickly view critical Gloo Mesh Gateway metrics and alerts to determine the health of your Gloo Mesh Gateway environment. The dashboard is organized into different sections that provide an overview of the Gloo management server’s and agent’s status, and the overall Gloo Mesh Gateway resource consumption. Populated metrics and alerts are retrieved from the built-in Prometheus server.

  For an overview of available metrics, see Gloo management server metrics. To find a detailed overview of the alerts that are automatically configured for Gloo Mesh Gateway components, see Alerts.

• Resource consumption: Monitor the CPU and memory usage of Gloo components, such as the Gloo agents and management server pods.

Install and access the operations dashboard link

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 \
   --kube-context=${MGMT_CONTEXT} \
   --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 --context $MGMT_CONTEXT
     

   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 --context $MGMT_CONTEXT -o name | grep grafana) 8080:3000 -n monitoring --context $MGMT_CONTEXT
     

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.