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 or 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 it by:

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.

All alert rules are deployed as PrometheusRule and can be enabled like this:

prometheus:
  prometheusRules:
    enabled: true

Dashboards for Grafana

To deploy optional Grafana dashboards with ConfigMaps, enable the functionality with:

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	:white_check_mark:	:white_check_mark:	:white_check_mark:
Nextcloud	:white_check_mark:	:x:	:x: