feat: Add a Dashboard for Monitoring the Operator Metrics (#1860)

* add a dashboard for monitoring the operator metrics * Apply suggestions from code review Co-authored-by: Igor Beliakov <[email protected]> * skipp EOF lint on json files * Update deploy/helm/grafana-operator/values.yaml Co-authored-by: Igor Beliakov <[email protected]> * Update docs/docs/installation/ops-and-monitoring.md Co-authored-by: Igor Beliakov <[email protected]> * more changes * more changes * fix(helm): dashboard labels * fix(docs): remove references to additionalLabels in the context of dashboard --------- Co-authored-by: Igor Beliakov <[email protected]> Co-authored-by: Igor Beliakov <[email protected]>
grafana · Mar 7, 2025 · 22ad664 · 22ad664
1 parent 47f993d
commit 22ad664
Show file tree

Hide file tree

Showing 5 changed files with 1,579 additions and 0 deletions.
diff --git a/deploy/helm/grafana-operator/README.md b/deploy/helm/grafana-operator/README.md
@@ -65,6 +65,9 @@ It's easier to just manage this configuration outside of the operator.
 | additionalLabels | object | `{}` | additional labels to add to all resources |
 | affinity | object | `{}` | pod affinity |
 | clusterDomain | string | `""` | Sets the `CLUSTER_DOMAIN` environment variable, it defines how internal Kubernetes services managed by the operator are addressed. By default, this is empty, and internal services are addressed without a cluster domain specified, i.e., a relative domain name that will resolve regardless of if a custom domain is configured for the cluster. If you wish to have services addressed using their FQDNs, you can specify the cluster domain explicitly, e.g., "cluster.local" for the default Kubernetes configuration. |
+| dashboard.annotations | object | `{}` | Annotations to add to the Grafana dashboard ConfigMap |
+| dashboard.enabled | bool | `false` | Whether to create a ConfigMap containing a dashboard monitoring the operator metrics. Consider enabling this if you are enabling the ServiceMonitor. Optionally, a GrafanaDashboard CR can be manually created pointing to the Grafana.com dashboard ID 22785 https://grafana.com/grafana/dashboards/22785-grafana-operator/ The Grafana.com dashboard is maintained by the community and does not necessarily match the JSON definition in this repository. |
+| dashboard.labels | object | `{}` | Labels to add to the Grafana dashboard ConfigMap |
 | env | list | `[]` | Additional environment variables |
 | extraObjects | list | `[]` | Array of extra K8s objects to deploy |
 | fullnameOverride | string | `""` | Overrides the fully qualified app name. |