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/ops/integrations/grafana/index.md

4.0 KiB
Raw Permalink Blame History

title description weight keywords
Grafana Information on how to integrate with Grafana to set up Istio dashboards. 20
integration
grafana

Grafana is an open source monitoring solution that can be used to configure dashboards for Istio. You can use Grafana to monitor the health of Istio and of applications within the service mesh.

Configuration

While you can build your own dashboards, Istio offers a set of preconfigured dashboards for all of the most important metrics for the mesh and for the control plane.

There are a few ways to configure Grafana to use these dashboards:

Use the built-in Grafana deployment

The built-in deployment of Grafana is bundled with all of the Istio dashboards already installed. To deploy the built-in Grafana instance, follow the steps in Customizable Install with Istioctl to install Istio and pass --set values.grafana.enabled=true during installation.

This built-in deployment of Grafana is intended for new users quickly getting started. However, it does not offer advanced customization, like persistence or authentication.

Import from grafana.com

To quickly import the Istio dashboards to an existing Grafana instance, you can use the Import button in the Grafana UI to add the dashboard links above. When you import the dashboards, note that you must select a Prometheus data source.

You can also use a script to import all dashboards at once. For example:

{{< text plain >}}

Address of Grafana

GRAFANA_HOST="http://localhost:3000"

Login credentials, if authentication is used

GRAFANA_CRED="USER:PASSWORD"

The name of the Prometheus data source to use

GRAFANA_DATASOURCE="Prometheus"

The version of Istio to deploy

VERSION={{< istio_version >}}

Import all Istio dashboards

for DASHBOARD in 7639 11829 7636 7630 7642 7645; do REVISION="(curl -s https://grafana.com/api/dashboards/{DASHBOARD}/revisions -s | jq ".items[] | select(.description | contains("${VERSION}")) | .revision")" curl -s https://grafana.com/api/dashboards/{DASHBOARD}/revisions/{REVISION}/download > /tmp/dashboard.json echo "Importing (cat /tmp/dashboard.json | jq -r '.title') (revision {REVISION}, id ${DASHBOARD})..." curl -s -k -u "$GRAFANA_CRED" -XPOST
-H "Accept: application/json"
-H "Content-Type: application/json"
-d "{"dashboard":$(cat /tmp/dashboard.json),"overwrite":true,
"inputs":[{"name":"DS_PROMETHEUS","type":"datasource",
"pluginId":"prometheus","value":"$GRAFANA_DATASOURCE"}]}"
$GRAFANA_HOST/api/dashboards/import echo -e "\nDone\n" done {{< /text >}}

{{< tip >}} A new revision of the dashboards is created for each version of Istio. To ensure compatibility, it is recommended that you select the appropriate revision for the Istio version you are deploying. {{< /tip >}}

Implementation-specific methods

Grafana can be installed and configured through other methods. To import Istio dashboards, refer to the documentation for the installation method. For example: