Explore the UI

About the Gloo UI link

• Gloo Gateway dashboard: Use the Gloo UI dashboard to quickly review the health of your Gloo Gateway setup, and any insights that were detected. If you use the Gloo UI in a multicluster setup, you can also review the health of the Gloo management server and agents.
• Insights: The Gloo UI comes with an insights engine that automatically analyzes your Gloo Gateway setup for health issues. These issues are shared in the UI along with recommendations to harden your Gloo Gateway setup. The insights give you a checklist to address issues that might otherwise be hard to detect across your environment. For more information, see Insights.
• Traffic resource overview: Review the Gateways, routes, policies, and destinations that are set up in your environment and the traffic management rules that you applied to them.
• Security and compliance: The Dashboard and Security Insights pages of the Gloo UI can help you review the overall security posture of your setup, including insights and recommendations regarding your certificates, encrypted traffic, FIPS compliance, and more.
• Drill into apps and services: Review what services can communicate with other services and how traffic between services is secured.
• Visualize and monitor metrics: With the built-in Prometheus integration, the Gloo UI has access to workload-specific metrics, such as the number of requests that were received for a workload. This data is visualized in the Gloo UI graph.

Before you begin link

Follow the steps to Set up the Gloo UI.

Launch the UI link

1. Port-forward the Gloo UI pod.

     kubectl port-forward deployment/gloo-mesh-ui -n gloo-system 8090
     

2. Open the Gloo UI dashboard.

     open http://localhost:8090/dashboard
     

   

Home link

View the health and performance of your Gloo Gateway components, and view recommendations to harden your setup by using the Dashboard and Insights pages.

Dashboard link

The Gloo UI dashboard provides an at-a-glance overview of your Gloo Gateway setup, including insights, request rates, failures, and latency, and the health of Gloo Gateway components.

Insights link

Gloo Gateway comes with an insights engine that automatically analyzes your Gloo Gateway setup for health issues. These issues are displayed in the UI along with recommendations to harden your Gloo Gateway setup. The insights give you a checklist to address issues that might otherwise be hard to detect across your environment.

Inventory link

The Inventory section provides an at-a-glance look at the health of registered clusters and discovered services that make up your Gloo Gateway environment.

Clusters link

On the Clusters page, review details of the cluster where Gloo Gateway is installed, such as insights, the health of the Gloo Gateway control and data planes, relay certificate information (in multicluster setups only), and applied routes, gateways, destinations, and policies.

In a multicluster setup, you can review the details of each cluster that you registered with the Gloo management plane.

On the Clusters page, review details of the cluster where Gloo Gateway is installed. In a multicluster setup, you can review the details of each cluster that you registered with the Gloo management plane.

1. To filter clusters by the cluster’s installation health, click the Healthy and Unhealthy buttons. You can also use the Sort by Name dropdown or the search bar to filter clusters by name.

2. Click More Details to see a more detailed dashboard for the cluster. This dashboard can help you find errors in your Gloo and Istio setups. Note that if you run multiple versions of Istio within the same cluster, you can click each version in the Version tab to see its details.

Traffic link

The Traffic section provides an overview of deployed Gateways, routes, policies, and destinations.

Gateways link

On the Gateways page, you can view the YAML configuration of gateway-related resources, such as GatewayClass, Gateway, and GatewayParameters.

To filter the list of resources, you can choose between the following options:

• Use the Status field to filter between healthy and unhealthy gateway resources.
• Use the Label key and value fields to filter resources by their labels.
• Use the Filter to display the resource types that you are interested in.
• Use the Search bar to find a resource by name, namespace, or other properties

Routes link

On the Routes page, you can view the HTTPRoute and TCPRoute resources (Kubernetes Gateway API) that you created in your cluster.

To filter the list of resources, you can choose between the following options:

• Use the Status field to filter between healthy and unhealthy gateway resources.
• Use the Label key and value fields to filter resources by their labels.
• Use the Filter to display the resource types that you are interested in.
• Use the Search bar to find a resource by name, namespace, or other properties

From the Details page of a route:

• To debug the route, click View YAML to view the route’s YAML configuration.
• Find the hostnames that the route matches on in the Hostnames card.
• Find the gateway that serves this route in the Gateways card.
• View the matchers that the route defines, its backing destinations, and any filters that you applied to the route in the Rule card.

Policies link

On the Policies page, you can view any policies that you applied in your environment, such as RouteOption, VirtualHostOption, ListenerOption, HttpListenerOptions, AuthConfigs, and RatelimitConfig. To view the policy configuration, you can click YAML.

To filter the list of resources, you can choose between the following options:

• Use the Status field to filter between healthy and unhealthy gateway resources.
• Use the Label key and value fields to filter resources by their labels.
• Use the Filter to display the resource types that you are interested in.
• Use the Search bar to find a resource by name, namespace, or other properties

Destinations link

On the Destination page, review a list of discovered destinations, such as Kubernetes services and Gloo Gateway Upstreams.

To filter the list of resources, you can choose between the following options:

• Use the Status field to filter between healthy and unhealthy gateway resources.
• Use the Label key and value fields to filter resources by their labels.
• Use the Filter to display the resource types that you are interested in.
• Use the Search bar to find a resource by name, namespace, or other properties

From the Details page of a destination:

• To debug the service, click View YAML to view the destination’s YAML configuration.
• See an analysis of the service’s error rate and latency in the Service Signals card.
• View the Graph tab to visualize the network traffic that reaches your destination. For more information about how to use the graph, see Graph.

Security link

Security insights link

The Dashboard and Security Insights pages of the Gloo UI can help you review the overall security posture of your setup, including insights and recommendations regarding your certificates, encrypted traffic, FIPS compliance, and more.

Certificates link

View a list of all Istio and relay certificates in your environment. This list provides the Filter by expiration… dropdown to filter certificates by validity status, and the Filter by type… dropdown to filter certificates by type, such as Istio root or intermediate.

To view the details of a certificate, such as the issue details, total validity period, and fingerprints, click Details. On the certificate details page, you can review general information, such as the common name and organization the certificate is issued to, and check the validity period and fingerprints of the certificate.

Observability link

The Gloo UI consumes telemetry data from Prometheus and Jaeger and visualizes this data in the Observability section.

Graph link

The Gloo UI includes a Graph page to visualize the network traffic that reaches the services in your cluster.

Layout settings link

From the footer toolbar, click Layout Settings. Toggle on or off the following settings.

Click the settings icon to view the layout settings for the graph.

Layout settings:

• Animations: Change the paths between nodes from a directional animation to a solid line.
• Mutual TLS: If you use an Istio service mesh alongside your Gloo Gateway installation, toggle the lock icons along paths between node that are mTLS encrypted.
• TCP: Review TCP traffic.

Node Types displayed:
Nodes represent the application “nodes” of the graph. (Note that nodes represent your apps, not Kubernetes compute nodes.) You can toggle on and off views for the following nodes:

• Kubernetes services
• External services
• Gateways

Node states displayed:
Toggle on or off idle nodes, which are nodes that do not receive traffic.

Filters link

Default Graph:

In the Search bar, filter the services that you want to see in the graph. You can choose to include or hide those services.

From the Traffic dropdown, select the range of time that you want the graph to show, such as traffic from the last 15 minutes.

From the Refresh dropdown, select how often you want the graph to refresh the data, such as every 5 seconds. You can also refresh on demand by clicking REFRESH.

After the header toolbar, you can filter what the graph shows by namespace and cluster. Filters work like the logical operator AND, so results must meet all the criteria. For example, if you filter by bookinfo namespace and cluster1, then the graph shows services that meet all these criteria.

Toggle Errors Only to see services that experienced traffic errors during the traffic time range you selected from the header toolbar.

Within the graph views, you can navigate by clicking and dragging whitespace within the main canvas, or by using the navigation arrow buttons, as shown in the following figure.

After the header toolbar, filter, and main canvas, you can choose more viewing options in the footer toolbar.

#	Icon name	Description
1	Fullscreen	Click to expand your browser to fullscreen. Click again or enter ESC to return to the normal screen size.
2	Zoom in and out	Zoom in or out on the main view’s canvas. Depending on your mouse settings, you can also scroll to zoom in and out.
3	Reset	If you moved the position of nodes on the graph, reset the nodes to their original positions.
4	Fit to canvas	Click to center and fit the content of the current view to the canvas size. This action might be helpful if you rearranged the nodes and zoomed in.
5	Networking graph views	Click one of the networking graph views to change how the nodes are displayed in the main canvas. For more information, see Networking views.
6	View legend	Open the graph legend. For more information, see Legend.
7	Layout settings	Open the graph layout settings. For more information, see Layout settings.

In the Search bar, filter the services that you want to see in the graph. You can choose to include or hide those services.

From the Cluster and Namespace dropdown, select the cluster and namespace for which you want to visualize traffic.

• Use the + and - buttons to zoom in and out of the graph.
• Use the arrow button to center and fit the graph to the canvas size. This action might be helpful if you rearranged the nodes and zoomed in.
• Use the lock button to lock the current viewpoint. You cannot move any of the boxes or arrows if the lock is enabled.

Legend link

From the footer toolbar, click Show Legend.

Node Types describes the icons that are used for the application “nodes” of the graph. For example, a node might be a Kubernetes service, such as a gateway proxy, mesh workload, or waypoint proxy, or an external service, such as a virtual machine (VM), external workload, or Lambda function.

Node States and Edges show whether a service’s traffic behaves normally or not, as indicated by a color or icon.

From the footer toolbar, click Show Legend.

Click on the eye icon to view the Graph legend.