istio
/
istio.io
mirror of https://github.com/istio/istio.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
istio.io/content/en/docs/tasks/observability/metrics/using-istio-dashboard/index.md

5.6 KiB
Raw Blame History

title description weight keywords aliases owner test
Visualizing Metrics with Grafana This task shows you how to setup and use the Istio Dashboard to monitor mesh traffic. 40
telemetry
visualization
/docs/tasks/telemetry/using-istio-dashboard/
/docs/tasks/telemetry/metrics/using-istio-dashboard/
istio/wg-policies-and-telemetry-maintainers yes

This task shows you how to setup and use the Istio Dashboard to monitor mesh traffic. As part of this task, you will use the Grafana Istio addon and the web-based interface for viewing service mesh traffic data.

The Bookinfo sample application is used as the example application throughout this task.

Before you begin

Viewing the Istio dashboard

  1. Verify that the prometheus service is running in your cluster.

    In Kubernetes environments, execute the following command:

    {{< text bash >}} $ kubectl -n istio-system get svc prometheus NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE prometheus ClusterIP 10.100.250.202 9090/TCP 103s {{< /text >}}

  2. Verify that the Grafana service is running in your cluster.

    In Kubernetes environments, execute the following command:

    {{< text bash >}} $ kubectl -n istio-system get svc grafana NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE grafana ClusterIP 10.103.244.103 3000/TCP 2m25s {{< /text >}}

  3. Open the Istio Dashboard via the Grafana UI.

    In Kubernetes environments, execute the following command:

    {{< text bash >}} $ istioctl dashboard grafana {{< /text >}}

    Visit http://localhost:3000/d/G8wLrJIZk/istio-mesh-dashboard in your web browser.

    The Istio Dashboard will look similar to:

    {{< image link="./grafana-istio-dashboard.png" caption="Istio Dashboard" >}}

  4. Send traffic to the mesh.

    For the Bookinfo sample, visit http://$GATEWAY_URL/productpage in your web browser or issue the following command:

    {{< boilerplate trace-generation >}}

    {{< tip >}} $GATEWAY_URL is the value set in the Bookinfo example. {{< /tip >}}

    Refresh the page a few times (or send the command a few times) to generate a small amount of traffic.

    Look at the Istio Dashboard again. It should reflect the traffic that was generated. It will look similar to:

    {{< image link="./dashboard-with-traffic.png" caption="Istio Dashboard With Traffic" >}}

    This gives the global view of the Mesh along with services and workloads in the mesh. You can get more details about services and workloads by navigating to their specific dashboards as explained below.

  5. Visualize Service Dashboards.

    From the Grafana dashboard's left hand corner navigation menu, you can navigate to Istio Service Dashboard or visit http://localhost:3000/d/LJ_uJAvmk/istio-service-dashboard in your web browser.

    {{< tip >}} You may need to select a service in the Service dropdown. {{< /tip >}}

    The Istio Service Dashboard will look similar to:

    {{< image link="./istio-service-dashboard.png" caption="Istio Service Dashboard" >}}

    This gives details about metrics for the service and then client workloads (workloads that are calling this service) and service workloads (workloads that are providing this service) for that service.

  6. Visualize Workload Dashboards.

    From the Grafana dashboard's left hand corner navigation menu, you can navigate to Istio Workload Dashboard or visit http://localhost:3000/d/UbsSZTDik/istio-workload-dashboard in your web browser.

    The Istio Workload Dashboard will look similar to:

    {{< image link="./istio-workload-dashboard.png" caption="Istio Workload Dashboard" >}}

    This gives details about metrics for each workload and then inbound workloads (workloads that are sending request to this workload) and outbound services (services to which this workload send requests) for that workload.

About the Grafana dashboards

The Istio Dashboard consists of three main sections:

  1. A Mesh Summary View. This section provides Global Summary view of the Mesh and shows HTTP/gRPC and TCP workloads in the Mesh.

  2. Individual Services View. This section provides metrics about requests and responses for each individual service within the mesh (HTTP/gRPC and TCP). This also provides metrics about client and service workloads for this service.

  3. Individual Workloads View: This section provides metrics about requests and responses for each individual workload within the mesh (HTTP/gRPC and TCP). This also provides metrics about inbound workloads and outbound services for this workload.

For more on how to create, configure, and edit dashboards, please see the Grafana documentation.

Cleanup

  • Remove any kubectl port-forward processes that may be running:

    {{< text bash >}} $ killall kubectl {{< /text >}}

  • If you are not planning to explore any follow-on tasks, refer to the Bookinfo cleanup instructions to shutdown the application.