From b8ff60a0f30b43bcc33fe1a3fba6a09de0c818c0 Mon Sep 17 00:00:00 2001 From: Evan Hearne <156197717+ehearneRedHat@users.noreply.github.com> Date: Mon, 27 May 2024 09:48:44 +0100 Subject: [PATCH] added dashboard id's and linked to Grafana Docs for more info. (#663) --- doc/observability/examples.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/doc/observability/examples.md b/doc/observability/examples.md index 61dc0dd49..9261c794c 100644 --- a/doc/observability/examples.md +++ b/doc/observability/examples.md @@ -2,11 +2,23 @@ Explore a variety of starting points for monitoring your Kuadrant installation with our [examples](https://github.com/Kuadrant/kuadrant-operator/tree/main/examples) folder. These dashboards and alerts are ready-to-use and easily customizable to fit your environment. +There are some example dashboards uploaded to [Grafana.com](https://grafana.com/grafana/dashboards/) . You can use the ID's listed below to import these dashboards into Grafana: + +| Name | ID | +| ----------- | ----------- | +| [App Developer Dashboard](https://grafana.com/grafana/dashboards/20970) | `20970` | +| [Business User Dashboard](https://grafana.com/grafana/dashboards/20981) | `20981` | +| [Platform Engineer Dashboard](https://grafana.com/grafana/dashboards/20982) | `20982` | + ## Dashboards ### Importing Dashboards into Grafana -- **UI Method:** Use the 'Import' feature in the Grafana UI to upload dashboard JSON files directly. +For more details on how to import dashboards into Grafana, visit the [import dashboards](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/import-dashboards/) page. + +- **UI Method:** + - **JSON** - Use the 'Import' feature in the Grafana UI to upload dashboard JSON files directly. + - **ID** - Use the 'Import' feature in the Grafana UI to import via [Grafana.com](https://grafana.com/grafana/dashboards/) using a Dashboard ID. - **ConfigMap Method:** Automate dashboard provisioning by adding files to a ConfigMap, which should be mounted at `/etc/grafana/provisioning/dashboards`. Datasources are configured as template variables, automatically integrating with your existing data sources. Metrics for these dashboards are sourced from [Prometheus](https://github.com/prometheus/prometheus). For more details on the metrics used, visit the [metrics](https://docs.kuadrant.io/kuadrant-operator/doc/observability/metrics/) documentation page.