README

Fetch health state of your pimcore installation.

Release Plan

Release	Supported Pimcore Versions	Supported Symfony Versions	Release Date	Maintained	Branch
4.x	`^11.0`	`6.4`	22.09.2023	Feature Branch	master
3.x	`^10.0`	`5.4`	06.01.2022	Unsupported	3.x
2.x	`^5.0`, `^6.0`	`3.4`, `^4.4`	31.08.2018	Unsupported	2.x
1.x	`^4.0`	--	06.02.2017	Unsupported	pimcore4

Installation

"require" : {
    "dachcom-digital/monitoring" : "~4.4.0"
}

Add Bundle to bundles.php:

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

Install Routes

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

Configuration

# config/packages/monitoring.yaml
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 pimcore.monitoring.check service and implement the CheckInterface interface.

Available Checks

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

Modules

Email Log Module

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.

monitoring:
    modules:
        heartbeat: true # disabled by default

This will also add a check hearbeat.

Upgrade Info

Before updating, please check our upgrade notes!

License

For licensing details please visit LICENSE.md

dachcom-digital / monitoring

Maintainers

Details