mirror of https://github.com/istio/istio.io.git
135 lines
4.4 KiB
Markdown
135 lines
4.4 KiB
Markdown
---
|
|
title: Visualizing Metrics with Grafana
|
|
|
|
overview: This task shows you how to setup and use the Istio Dashboard to monitor mesh traffic.
|
|
|
|
order: 40
|
|
|
|
layout: docs
|
|
type: markdown
|
|
---
|
|
{% include home.html %}
|
|
|
|
This task shows you how to setup and use the Istio Dashboard to monitor mesh
|
|
traffic. As part of this task, you will install the Grafana Istio addon and use
|
|
the web-based interface for viewing service mesh traffic data.
|
|
|
|
The [BookInfo]({{home}}/docs/guides/bookinfo.html) sample application is used as
|
|
the example application throughout this task.
|
|
|
|
## Before you begin
|
|
* [Install Istio]({{home}}/docs/setup/) in your cluster and deploy an
|
|
application.
|
|
|
|
* Install the Prometheus add-on.
|
|
|
|
```bash
|
|
kubectl apply -f install/kubernetes/addons/prometheus.yaml
|
|
```
|
|
|
|
Use of the Prometheus add-on is _required_ for the Istio Dashboard.
|
|
|
|
## Viewing the Istio Dashboard
|
|
|
|
1. To view Istio metrics in a graphical dashboard install the Grafana add-on.
|
|
|
|
In Kubernetes environments, execute the following command:
|
|
|
|
```bash
|
|
kubectl apply -f install/kubernetes/addons/grafana.yaml
|
|
```
|
|
|
|
1. Verify that the service is running in your cluster.
|
|
|
|
In Kubernetes environments, execute the following command:
|
|
|
|
```bash
|
|
kubectl -n istio-system get svc grafana
|
|
```
|
|
|
|
The output will be similar to:
|
|
|
|
```
|
|
NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE
|
|
grafana 10.59.247.103 <none> 3000/TCP 2m
|
|
```
|
|
|
|
1. Open the Istio Dashboard via the Grafana UI.
|
|
|
|
In Kubernetes environments, execute the following command:
|
|
|
|
```bash
|
|
kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=grafana -o jsonpath='{.items[0].metadata.name}') 3000:3000 &
|
|
```
|
|
|
|
Visit [http://localhost:3000/dashboard/db/istio-dashboard](http://localhost:3000/dashboard/db/istio-dashboard) in your web browser.
|
|
|
|
The Istio Dashboard will look similar to:
|
|
|
|
<figure><img style="max-width:100%" src="./img/grafana-istio-dashboard.png"
|
|
alt="Istio Dashboard" title="Istio Dashboard" /> <figcaption>Istio
|
|
Dashboard</figcaption></figure>
|
|
|
|
1. Send traffic to the mesh.
|
|
|
|
For the BookInfo sample, visit `http://$GATEWAY_URL/productpage` in your web
|
|
browser or issue the following command:
|
|
|
|
```bash
|
|
curl http://$GATEWAY_URL/productpage
|
|
```
|
|
|
|
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:
|
|
|
|
<figure><img style="max-width:100%" src="./img/dashboard-with-traffic.png"
|
|
alt="Istio Dashboard With Traffic" title="Istio Dashboard With Traffic" />
|
|
<figcaption>Istio Dashboard With Traffic</figcaption></figure>
|
|
|
|
Note: `$GATEWAY_URL` is the value set in the
|
|
[BookInfo]({{home}}/docs/guides/bookinfo.html) guide.
|
|
|
|
|
|
### About the Grafana add-on
|
|
|
|
The Grafana add-on is a pre-configured instance of Grafana. The base image
|
|
([`grafana/grafana:4.1.2`](https://hub.docker.com/r/grafana/grafana/)) has been
|
|
modified to start with both a Prometheus data source and the Istio Dashboard
|
|
installed. The base install files for Istio, and Mixer in particular, ship with
|
|
a default configuration of global (used for every service) metrics. The Istio
|
|
Dashboard is built to be used in conjunction with the default Istio metrics
|
|
configuration and a Prometheus backend.
|
|
|
|
The Istio Dashboard consists of three main sections:
|
|
1. A Global Summary View. This section provides high-level summary of HTTP
|
|
requests flowing through the service mesh.
|
|
1. A Mesh Summary View. This section provides slightly more detail than the
|
|
Global Summary View, allowing per-service filtering and selection.
|
|
1. Individual Services View. This section provides metrics about requests and
|
|
responses for each individual service within the mesh (HTTP and TCP).
|
|
|
|
For more on how to create, configure, and edit dashboards, please see the
|
|
[Grafana documentation](http://docs.grafana.org/).
|
|
|
|
## Cleanup
|
|
|
|
* In Kubernetes environments, execute the following command to remove the Grafana
|
|
add-on:
|
|
|
|
```bash
|
|
kubectl delete -f install/kubernetes/addons/grafana.yaml
|
|
```
|
|
|
|
* Remove any `kubectl port-forward` processes that may be running:
|
|
|
|
```bash
|
|
killall kubectl
|
|
```
|
|
|
|
* If you are not planning to explore any follow-on tasks, refer to the
|
|
[BookInfo cleanup]({{home}}/docs/guides/bookinfo.html#cleanup) instructions
|
|
to shutdown the application.
|