systopia / de.systopia.dbmonitor
Will try to spot conspicuous or 'stuck' database queries.
Package info
github.com/systopia/de.systopia.dbmonitor
Type:civicrm-ext
pkg:composer/systopia/de.systopia.dbmonitor
Requires
- php: ^8.1
- civicrm/civicrm-core: >=5.76
- civicrm/civicrm-packages: >=5.76
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
- pear/mail_mime: <1.10.2
- pear/pear-core-minimal: <1.10.16
- symfony/polyfill-php82: <1.28
Replaces
None
This package is auto-updated.
Last update: 2026-09-02 12:23:51 UTC
README
- checks the system for stuck database queries and sends an email alert if there are any.
- The extension is licensed under AGPL-3.0.
Requirements
- PHP v7.4+
- CiviCRM (FIXME: Version number)
Installation (Web UI)
This extension has not yet been published for installation via the web UI.
Installation (CLI, Zip)
Sysadmins and developers may download the .zip file for this extension and
install it with the command-line tool cv.
cd <extension-dir> cv dl de.systopia.dbmonitor@https://github.com/FIXME/de.systopia.dbmonitor/archive/master.zip
Installation (CLI, Git)
Sysadmins and developers may clone the Git repo for this extension and install it with the command-line tool cv.
git clone https://github.com/systopia/de.systopia.dbmonitor.git cv en dbmonitor
Usage
This extensions will give admins a notification bubble if any of CiviCRM's database queries is taking a very long time, and gives you the options to stop (i.e. "kill") it. Use this with caution.
Settings
are available at:
- your_domain/civicrm/admin/setting/dbmonitor
- admin_console -> system-settings -> DB Monitor Settings
here you have to adjust:
- permission (to be added as an email-recipient)
- threshold in seconds (the duration after which a database-query is supposed to be stuck)
here you may
- enable/disable Monitoring at all
APIv3
this extension is adding the entity DBmonitor to APIv3. yet there is only one action implemented: probe
DBmonitor.probe
check the system for stuck queries and send an email if there are any.
- as a parameter you may add a comma-separated list of email-recipients. if empty, the current user is addressed.
- the email's 'from address' is the 'from Email Address Option' with the value: 1
- the email's subject is 'DB Monitoring: Conspicuous queries spotted on host path database'
continuous monitoring via cron-job
This extension adds a new cron-job: Check for conspicuous database queries.
- the cron-job is executing the APIv3-action
DBmonitor.probe - as a parameter you may add: email_recipients= followed by a comma-separated list of email-addresses