Skip to content

Commit

Permalink
doc on using example dashboards and alerts (#562)
Browse files Browse the repository at this point in the history
  • Loading branch information
david-martin committed Apr 25, 2024
1 parent 0285586 commit 9654134
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions doc/observability/examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Example Dashboards and Alerts

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.

## Dashboards

### Importing Dashboards into Grafana

- **UI Method:** Use the 'Import' feature in the Grafana UI to upload dashboard JSON files directly.
- **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.

## Alerts

### Setting Up Alerts in Prometheus

Integrate alerts into Prometheus using a `PrometheusRule` resource. Adjust alert thresholds to meet your specific operational needs.

Further information on the metrics used for these alerts can be found on the [metrics](https://docs.kuadrant.io/kuadrant-operator/doc/observability/metrics/) page.

0 comments on commit 9654134

Please sign in to comment.