New to KubeDB? Please start here.

Monitoring PerconaXtraDB with KubeDB

KubeDB has native support for monitoring via Prometheus. You can use builtin Prometheus scraper or Prometheus operator to monitor KubeDB managed databases. This tutorial will show you how database monitoring works with KubeDB and how to configure Database crd to enable monitoring.

Overview

KubeDB uses Prometheus exporter images to export Prometheus metrics for respective databases. Following diagram shows the logical flow of database monitoring with KubeDB.

When a user creates a database crd with spec.monitor section configured, KubeDB operator provisions the respective database and injects an exporter image as sidecar to the database pod. It also creates a dedicated stats service with name {database-crd-name}-stats for monitoring. Prometheus server can scrape metrics using this stats service.

Configure Monitoring

In order to enable monitoring for a database, you have to configure spec.monitor section. KubeDB provides following options to configure spec.monitor section:

Sample Configuration

A sample YAML for Redis crd with spec.monitor section configured to enable monitoring with Prometheus operator is shown below.

apiVersion: kubedb.com/v1
kind: Redis
metadata:
  name: sample-redis
  namespace: databases
spec:
  version: 6.0.20
  deletionPolicy: WipeOut
  configSecret: # configure Redis to use password for authentication
    name: redis-config
  storageType: Durable
  storage:
    storageClassName: default
    accessModes:
    - ReadWriteOnce
    resources:
      requests:
        storage: 5Gi
  monitor:
    agent: prometheus.io/operator
    prometheus:
      serviceMonitor:
        labels:
          release: prometheus
      exporter:
        args:
        - --redis.password=$(REDIS_PASSWORD)
        env:
        - name: REDIS_PASSWORD
          valueFrom:
            secretKeyRef:
              name: _name_of_secret_with_redis_password
              key: password # key with the password
        resources:
          requests:
            memory: 512Mi
            cpu: 200m
          limits:
            memory: 512Mi
            cpu: 250m
        securityContext:
          runAsUser: 2000
          allowPrivilegeEscalation: false

Assume that above Redis is configured to use basic authentication. So, exporter image also need to provide password to collect metrics. We have provided it through spec.monitor.args field.

Here, we have specified that we are going to monitor this server using Prometheus operator through spec.monitor.agent: prometheus.io/operator. KubeDB will create a ServiceMonitor crd in monitoring namespace and this ServiceMonitor will have release: prometheus label.

Next Steps

• Learn how to monitor PerconaXtraDB database with KubeDB using builtin-Prometheus and using Prometheus operator.
• Learn how to monitor PerconaXtraDB database with KubeDB using builtin-Prometheus and using Prometheus operator.
• Learn how to monitor PostgreSQL database with KubeDB using builtin-Prometheus and using Prometheus operator.
• Learn how to monitor MySQL database with KubeDB using builtin-Prometheus and using Prometheus operator.
• Learn how to monitor MongoDB database with KubeDB using builtin-Prometheus and using Prometheus operator.
• Learn how to monitor Redis server with KubeDB using builtin-Prometheus and using Prometheus operator.
• Learn how to monitor Memcached server with KubeDB using builtin-Prometheus and using Prometheus operator.