Explore the UI

Use the Gloo UI to get an at-a-glance view of the configuration, health, and compliance status of your Gloo Gateway setup and the workloads in your cluster.

About the Gloo UI

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

Follow the steps to Set up the Gloo UI.

Launch the UI

Port-forward the Gloo UI pod.

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

Open the Gloo UI dashboard.
```
open http://localhost:8090/dashboard
```

Dashboard

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

When you install the Gloo UI, it 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 and improve your setups’ efficiency, security, and configuration. The insights give you a checklist to address issues that might otherwise be hard to detect across your environment. For an overview of available insights, see Insights.

Clusters

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.

Single cluster: In a single-cluster setup, you can review the details of the cluster where you deployed Gloo Gateway.

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

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.
Figure: Clusters page
Figure: Clusters page
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.
Figure: Cluster details page
Figure: Cluster details page

Global services

If you have a multicluster ambient or sidecar mesh setup, and made services available across clusters, the Global Services page lists the global service hostnames that are available for those services. For example, the following image shows the productpage.bookinfo.mesh.internal global hostname for the productpage service, which has services instances in two clusters of the multicluster setup.

Gateways

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 Search bar to find a resource by name, namespace, or other properties
Use the Filter menu to filter by:
- Status: Filter between healthy and unhealthy resources.
- Type: Display the resource types that you are interested in.
- Label: Filter resources by label key and value.

Routes

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 Search bar to find a resource by name, namespace, or other properties
Use the Filter menu to filter by:
- Status: Filter between healthy and unhealthy resources.
- Type: Display the resource types that you are interested in.
- Label: Filter resources by label key and value.

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.

Destinations

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 Search bar to find a resource by name, namespace, or other properties
Use the Filter menu to filter by:
- Status: Filter between healthy and unhealthy resources.
- Type: Display the resource types that you are interested in.
- Label: Filter resources by label key and value.

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.

Policies

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 Search bar to find a resource by name, namespace, or other properties
Use the Filter menu to filter by:
- Status: Filter between healthy and unhealthy resources.
- Type: Display the resource types that you are interested in.
- Label: Filter resources by label key and value.

Certificates

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.

The Certificates sections is used in multicluster setups only. In single cluster setups, this section remains empty.

To view the details of a certificate, such as the issue details, total validity period, and fingerprints, click the certificate name. 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.

Graph

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

Filters

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.
Use the expanded arrows button to open a full-screen view of the graph. You can press escape to exit the full-screen view.
Use the grid button to reset the layout.

Layout settings

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

Legend

Click on the eye icon to view the Graph legend.

Kubernetes Services and External Services describe 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, L7 Edges, and L4 Edges show whether a service’s traffic behaves normally or not, as indicated by a color or icon.

Node States:

Node color	State	Description
Blue	Healthy	The node is operative, and sends and responds to traffic as expected.
Orange	Warning	The node has some sort of degraded status or operation.
Gray	Idle	The node does not yet accept or send traffic. For example, the deployment might be pending.
Red	Error	The node has some sort of failure.

L7 Edges:

Dashed line color or icon	State	Description
Green	Healthy	Traffic is flowing between the nodes as expected, in the direction indicated.
Yellow	Warning	Traffic is degraded in some way. For example, a policy might be applied to a route that rate limits traffic to a service. Most of the requests are successful, but some are not.
Gray	Idle	The traffic connection is established, but requests are not yet sent or received along the connection.
Red	Error	Traffic is failing. For example, a policy might be applied to a route that blocks traffic to a service.
Black lock icon	mTLS applied	Service isolation is enabled for the traffic, with communication secured via mTLS.

L4 Edges:

Solid line color or icon	State	Description
Blue	Active	Traffic is flowing between the nodes as expected, in the direction indicated.
Gray	Idle	The traffic connection is established, but requests are not yet sent or received along the connection.
Black lock icon	mTLS applied	Service isolation is enabled for the traffic, with communication secured via mTLS.

Set up the UI Review insights