Monitoring Bundle

Fetch health state of your opendxp installation.

Release Plan

Release	Supported OpenDXP Versions	Supported Symfony Versions	Release Date	Maintained	Branch
1.x	^1.0	7.3	2025	Feature Branch	1.x

Installation

"require": {
    "open-dxp/monitoring-bundle" : "~1.0.0"
}

Add Bundle to bundles.php:

return [
    OpenDxp\Bundle\MonitoringBundle\OpenDxpMonitoringBundle::class => ['all' => true],
];

Install Routes

# config/routes.yaml
monitoring:
    resource: '@OpenDxpMonitoringBundle/config/routing.yaml'

Configuration

# config/packages/opendxp_monitoring.yaml
opendxp_monitoring:
    api_code: 'YOUR_API_CODE'

Fetch Data

curl --data "apiCode=YOUR_API_CODE" https://www.your-domain.tld/monitoring/fetch

Fetch Data By Check

curl --data "apiCode=YOUR_API_CODE" https://www.your-domain.tld/monitoring/fetch?filter=core,heartbeat

Create Custom Check

Create a tagged opendxp.monitoring.check service and implement the CheckInterface interface.

Available Checks

• OpenDXP version and revision
• PHP (version, memory_limit and more)
• Kernel (environment, debug)
• Installed Bundles
• Installed AreaBricks
• Available Users

---

Modules

Email Log Module

opendxp_monitoring:
    modules:
        email_log: true # disabled by default

curl --data "apiCode=YOUR_API_CODE" https://www.your-domain.tld/monitoring/fetch-email-log

Params

• onlyErrors: only fetch logs with errors (Default false)
• startingFrom: only fetch logs newer than Y-m-d H:i:s (Default null)
• limit: limit log response (Default 100)

Heartbeat Module

This module provides a lightweight "heartbeat" mechanism to monitor the execution of periodic maintenance tasks. It helps verify that both the system cronjob and the Symfony Messenger queue are functioning correctly.

This heartbeat check:

• Confirms that the cronjob is triggering as expected.
• Confirms that the Messenger worker is actively processing jobs.
• Optionally indicates the duration or load of the maintenance task by analyzing time deltas between executions.

opendxp_monitoring:
    modules:
        heartbeat: true # disabled by default

This will also add a check hearbeat.

---

Upgrade Info

Before updating, please check our upgrade notes!

License

DACHCOM.DIGITAL AG, Löwenhofstrasse 15, 9424 Rheineck, Schweiz
dachcom.com, [email protected]
Copyright © 2025 DACHCOM.DIGITAL. All rights reserved.

For licensing details please visit LICENSE.md