linkerd
/
linkerd2
mirror of https://github.com/linkerd/linkerd2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
linkerd2/grafana
History
Alejandro Pedraza 8e6680ba1d
Parametrized datasource in grafana dashboards, better script handling (#7603) 
Added the `DS_PROMETHEUS` parameter in all the Grafana dashboard
definitions. When importing a definition into a Grafana Cloud instance
for example, the import form will allow selecting the datasource from
  the currently available. OTOH when using an in-cluster instance such
  as one installed through the Grafana helm chart, the parameter gets
  overridden with the `values.yaml` entry
  `dashboards.default.{name}.datasource`.

Also, the javascript snippet used in the dashboard definitions for
checking for the latest linkerd version has been wrapped around a hidden
div. This avoids showing the script itself when it gets escaped when
importing the definition into Grafana Cloud.
 		2022-01-14 11:30:19 -05:00
..
dashboards Parametrized datasource in grafana dashboards, better script handling (#7603) 2022-01-14 11:30:19 -05:00
README.md Stop shipping grafana-based image (#7567) 2022-01-11 14:47:40 -05:00
values.yaml Parametrized datasource in grafana dashboards, better script handling (#7603) 2022-01-14 11:30:19 -05:00

README.md

Using Grafana with Linkerd

You can install Grafana in various ways, like using the Grafana official Helm chart, or the Grafana Operator. Hosted solutions are also available, like Grafana Cloud.

The file grafana/values.yaml provides a default Helm config for the Grafana official Helm chart, which pulls the Linkerd dashboards published at https://grafana.com/orgs/linkerd/dashboards.

You can install the chart like this:

helm repo add grafana https://grafana.github.io/helm-charts
helm install grafana -n grafana --create-namespace grafana/grafana \
  -f https://raw.githubusercontent.com/linkerd/linkerd2/main/grafana/values.yaml

Please make sure to update the entries in grafana/values.yaml before using the file; in particular:

  • auth and log settings under grafana.ini
  • datasources.datasources.yaml.datasources[0].url should point to your Prometheus service

The other installation methods can easily import those same dashboards using their IDs, as listed in grafana/values.yaml.

In order to have the Linkerd Viz Dashboard show the Grafana icon there where relevant, and have it link to the appropriate Grafana dashboard, make sure you have a proper location set up in the grafana.url setting in Linkerd Viz's values.yaml.

Note to developers

The grafana/dashboards directory contains the same dashboard definitions published under https://grafana.com/orgs/linkerd. Please keep them in sync when making any changes. After logging into grafana.com (using the linkerd account), the dashboards can be managed under Org Settings -> My Dashboards.