2.9 KiB
Monitoring
This document will cover how you can enable observability with Prometheus-based monitoring and Grafana dashboards as well as the overall status of the monitoring integration.
Technology
openDesk includes integration with Prometheus-based monitoring.
Together with kube-prometheus-stack, you can easily leverage the full potential of the open-source cloud-native observability stack.
Before enabling the following options, you need to install the respective custom resource definitions (CRDs) from the kube-prometheus-stack repository which should at least include the Prometheus Operator.
Defaults
All configurable options and their defaults can be found in
monitoring.yaml.gotmpl.
Metrics
To deploy podMonitor and serviceMonitor custom resources, enable them by:
monitoring:
prometheus:
serviceMonitors:
enabled: true
podMonitors:
enabled: true
# Alerts
openDesk ships with a set of Prometheus alerting rules that are specific to the operation of openDesk.
Some of these are created by our partners while others are defined in [opendesk-alerts](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-alerts).
All alert rules are deployed as [PrometheusRule](https://prometheus-operator.dev/docs/api-reference/api/#monitoring.coreos.com/v1.PrometheusRule) and can be enabled like this:
```yaml
monitoring:
prometheus:
prometheusRules:
enabled: true
Dashboards for Grafana
If your Grafana instance is deployed via kube-prometheus-stack, or you have deployed the Sidecar for datasources, openDesk can make dashboards available via ConfigMap resources.
Enable the functionality with the following snippet:
monitoring:
grafana:
dashboards:
enabled: true
Please find further details in the related Helm chart.
Component overview
| Component | Metrics (pod- or serviceMonitor) | Alerts (prometheusRule) | Dashboard (Grafana) |
|---|---|---|---|
| Collabora | ✅ | ✅ | ✅ |
| Nextcloud | ✅ | ❌ | ❌ |