opendesk/docs/monitoring.md

Monitoring

This document will cover how you can enable observability with Prometheus based monitoring and Grafana dashboards, as well as the overall status of monitoring integration.

• Technology
• Defaults
• Metrics
• Alerts
• Dashboards for Grafana
• Components

Technology

We provide integration into the Prometheus based monitoring. Together with kube-prometheus-stack you easily leverage the full potential of open-source cloud-native observability stack.

Before enabling the following options, you need to install the respective CRDs from the kube-prometheus-stack repository or prometheus operator.

Defaults

All configurable options and their defaults can be found in monitoring.yaml.

Metrics

To deploy podMonitor and serviceMonitor custom resources, enable it by:

prometheus:
  serviceMonitors:
    enabled: true
  podMonitors:
    enabled: true

Alerts

Some helm-charts provide a default set of prometheusRules for alerting, enable it by:

prometheus:
  prometheusRules:
    enabled: true

Dashboards for Grafana

To deploy optional ConfigMaps with Grafana dashboards, enable it by:

grafana:
  dashboards:
    enabled: true

Components

Component	Metrics (pod- or serviceMonitor)	Alerts (prometheusRule)	Dashboard (Grafana)
Collabora	✅	✅	✅