champabpmn/camunda-health-monitor

Camunda 7 Health Monitor

Lightweight monitoring dashboard for Camunda 7 BPM Platform with real-time health checks, performance metrics, and process instance monitoring.

!https://github.com/bibacrm/camunda-health-monitor/raw/master/docs/images/dashboard-full.png

!https://github.com/bibacrm/camunda-health-monitor/raw/master/docs/images/ai_camunda_monitoring_health.jpeg

!https://github.com/bibacrm/camunda-health-monitor/raw/master/docs/images/camunda_health_monitor_incidents_intelligence.png

🎥 Demo Video

Watch the feature demonstration on ***:

▶️ Watch Demo: Champa Camunda 7 Health Monitor

![Camunda Health Monitor Demo]([***]

🚀 Quick Start

Option 1: Docker Run with .env file

1. Create .env file (see example below)
2. Run the container:

bash
docker run -d \
  -p 5000:5000 \
  --env-file .env \
  --name camunda-health-monitor \
  champabpmn/camunda-health-monitor:latest

Access dashboard at http://localhost:5000

In case you Camunda 7 based system does not share JVM metrics - follow easy setup below (JMX Exporter section).

Option 2: Docker Compose

Create docker-compose.yml:

yaml
version: '3.8'

services:
  health-monitor:
    image: champabpmn/camunda-health-monitor:latest
    container_name: camunda-health-monitor
    ports:
      - "5000:5000"
    env_file:
      - .env
    volumes:
      - ./logs:/app/logs
    restart: unless-stopped

Run:

bash
docker-compose up -d

⚙️ Configuration (.env file)

Create a .env file with your configuration (example for Camunda 2 nodes cluster):

bash
# Database Configuration (PostgreSQL)
DB_NAME=PUT_YOUR_CAMUNDA_DB_NAME_HERE
DB_USER=PUT_YOUR_CAMUNDA_DB_USERNAME_HERE
DB_PASSWORD=PUT_YOUR_CAMUNDA_DB_PASS_HERE
DB_HOST=PUT_YOUR_CAMUNDA_DB_HOSTNAME_OR_IP_ADDRESS_HERE
DB_PORT=5432

# Camunda Node 1 (Required)
CAMUNDA_NODE_1_NAME=node1
CAMUNDA_NODE_1_URL=http://PUT_YOUR_CAMUNDA_BPM_1_NODE_HOST_HERE/engine-rest

# Camunda Node 2 (Optional)
CAMUNDA_NODE_2_NAME=node2
CAMUNDA_NODE_2_URL=http://PUT_YOUR_CAMUNDA_BPM_2_NODE_HOST_HERE/engine-rest

# Camunda Node 3 (Optional)
# CAMUNDA_NODE_3_NAME=node3
# CAMUNDA_NODE_3_URL=http://PUT_YOUR_CAMUNDA_BPM_3_NODE_HOST_HERE/engine-rest

# Camunda API Authentication (if enabled)
CAMUNDA_API_USER=
CAMUNDA_API_PASSWORD=

# Optional: JMX/Micrometer Exporter Endpoints
JMX_NODE_1_URL=http://PUT_YOUR_CAMUNDA_BPM_1_NODE_JVM_METRICS_HOST_HERE/metrics
JMX_NODE_2_URL=http://PUT_YOUR_CAMUNDA_BPM_2_NODE_JVM_METRICS_HOST_HERE/metrics

# JVM Metrics Source: 'jmx' or 'micrometer'(from e.g. Quarkus based installation)
JVM_METRICS_SOURCE=jmx

# Stuck Instance Detection (in days)
STUCK_INSTANCE_DAYS=7

# Application Settings
PORT=5000
DEBUG=false
JSON_LOGGING=false
SSL_VERIFY=false

Note: When running in Docker on the same host as Camunda/PostgreSQL, it may be required to use host.docker.internal instead of localhost.

JMX Exporter

In case your Camunda 7 based system does not share JVM metrics - one of simple solutions is to add JMX exporter (https://github.com/prometheus/jmx_exporter/releases). Add it in related folder together with a small config file (e.g. prometheus-jmx.yml):

bash
---
startDelaySeconds: 0
ssl: false
lowercaseOutputName: true
lowercaseOutputLabelNames: true
rules:
# --- JVM Metrics ---
- pattern: "java.lang<type=OperatingSystem><>(\\w+)"
  name: "jvm_os_$1"
- pattern: "java.lang<type=Memory><>(\\w+)"
  name: "jvm_memory_$1"
- pattern: "java.lang<type=Threading><>(\\w+)"
  name: "jvm_threading_$1"
- pattern: "java.lang<type=GarbageCollector, name=(.+)><>(\\w+)"
  name: "jvm_gc_$2"
  labels:
    collector: "$1"

Start your Camunda 7 based system with adding arguments in JAVA_OPTS or CATALINA_OPTS as:

bash
-javaagent:/camunda/javaagent/jmx_prometheus_javaagent.jar=9404:/camunda/javaagent/prometheus-jmx.yml

Now you can get JVM metrics via <CAMUNDA_HOST>:9404/metrics endpoint.

Easier setup

Some well known Camunda 7 fork systems (e.g. Operaton, CIB Seven, eximeeBPMS) may already include JMX Exporter, so there is a need to activate it via setting related environment variable:

bash
JMX_PROMETHEUS=true

and just add configuration file in /javaagent/ folder inside project folder, there is no need to extend JAVA_OPTS or CATALINA_OPTS. The path to config file has to look like one of:

bash
/camunda/javaagent/prometheus-jmx.yml
/eximeebpms/javaagent/prometheus-jmx.yml
/operaton/javaagent/prometheus-jmx.yml

🔗 Links

• GitHub Repository: https://github.com/bibacrm/camunda-health-monitor
• Full Documentation: https://github.com/bibacrm/camunda-health-monitor#readme
• Issues & Support: https://github.com/bibacrm/camunda-health-monitor/issues

📦 What's Included

✅ Multi-node Camunda monitoring ✅ PostgreSQL database health checks
✅ Process instance statistics
✅ Stuck instance detection
✅ JVM metrics (memory, threads, GC)
✅ RESTful API endpoints
✅ Health probes for Kubernetes
✅ Advanced AI/ML Analytics

🏢 Maintainer

Champa Intelligence
Website: [***]

License: See GitHub repository for license information