Skip to content

Metrics Walkthrough

Installation and Configuration of Metrics

This document will guide you in installing metrics for your application and provide directions on where to access them. Additionally, it will include dashboards set up to display these metrics.

Requirements/prerequisites

Prior to commencing the metrics installation process, it is imperative that you have successfully completed the initial getting started guide. For reference, please consult the guide available at the following link: Getting Started Guide.

Setting Up Metrics

To establish metrics, simply execute the following script in your terminal:

    curl https://raw.githubusercontent.com/kuadrant/multicluster-gateway-controller/main/hack/quickstart-metrics.sh | bash

This script will initiate the setup process for your metrics configuration. After the script finishes running, you should see something like:

Connect to Thanos Query UI
    URL: https://thanos-query.172.31.0.2.nip.io

Connect to Grafana UI
    URL: https://grafana.172.31.0.2.nip.io

You can visit the Grafana dashboard by accessing the provided URL for Grafana UI. (you may need to scroll)

Monitoring Operational Status in Grafana Dashboard

After setting up metrics, you can monitor the operational status of your system using the Grafana dashboard.

To generate traffic to the application, use curl as follows:

while true; do curl -k https://$MGC_SUB_DOMAIN && sleep 5; done

Accessing the Grafana Dashboard

To view the operational metrics and status, proceed with the following steps:

  1. Access the Grafana dashboard by clicking or entering the provided URL for the Grafana UI in your web browser.
https://grafana.172.31.0.2.nip.io

Note: The default login credentials for Grafana are admin/admin. You may need to accept the non-CA signed certificate to proceed.

  1. Navigate to the included Grafana Dashboard

Using the left sidebar in the Grafana UI, navigate to Dashboards > Browse and select either the Istio Workload Dashboard or MGC SRE Dashboard.

arch

In Istio Workload Dashboard you should be able to see the following layout, which will include data from the curl command you ran in the previous section.

arch

The MGC SRE Dashboard displays real-time insights and visualizations of resources managed by the multicluster-gateway-controller e.g. DNSPolicy, TLSPolicy, DNSRecord etc..

arch

The Grafana dashboard will provide you with real-time insights and visualizations of your gateway's performance and metrics.

By utilizing the Grafana dashboard, you can effectively monitor the health and behavior of your system, making informed decisions based on the displayed data. This monitoring capability enables you to proactively identify and address any potential issues to ensure the smooth operation of your environment.