README

The TYPO3 OhDear Health Check Extension allows you to monitor the health and performance of your TYPO3 application and server using Oh Dear. With this extension, you can receive alerts and notifications for critical issues, ensuring the smooth operation of your TYPO3 application.

Features

Disk Space: Monitors the disk space usage of your server.
PHP Error Log Size: Checks the size of the PHP error log.
TYPO3 Error Log Size: Checks the size of the TYPO3 error log.
MySQL Database Size: Checks the size of the MySQL database.
Forgotten Files on the Server: Scans the document root for forgotten files.
TYPO3 Database Log: Retrieves the TYPO3 database log.
TYPO3 Version: Retrieves the installed TYPO3 version.

Requirements

TYPO3 version 11.5.0 or later.
An active Oh Dear account with the necessary API credentials.

Installation

Run the following command to require the OhDear Health Check Extension via Composer: composer require devskio/typo3_ohdear_health_check
Compare and update the database table and field definitions
Include the static TypoScript of the extension. EXT:typo3_ohdear_health_check/Configuration/TypoScript/setup.typoscript
Once installed, go to the extension configuration settings and provide your Oh Dear API credentials together with Health Report Secret. Optionally, you can enable or disable the monitoring of specific checks together with setting the alert thresholds.
[Optional] If you want to have nice Health Report URL, you can add a routeEnhancer for OhDear Health Check Extension in your site configuration yaml file.

...
routeEnhancers:
  PageTypeSuffix:
    map:
      healthcheck: 1689678601
...

Usage

After installing and configuring the extension, you can access the OhDear Health Check dashboard.
In Application Health you have to set the URL of the health check endpoint. The URL is https://yourdomain.com/?type=1689678601. In case you have added the routeEnhancer, you can use https://yourdomain.com/healthcheck.
The dashboard displays the current status of various monitored aspects, such as disk space, PHP Error Log Size, TYPO3 Error Log Size, MySQL Database Size, Forgotten Files on the Server, TYPO3 Database Log, TYPO3 Version.
Configure the desired alert thresholds and notification settings in OhDear.
When an issue is detected, you will receive alerts through your preferred communication channels (e.g., email, Slack, SMS) based on your Oh Dear configuration.

Widget

You can add the OhDear Health Check widget to your TYPO3 dashboard. Widget is using the OhDear API to fetch basic Oh Dear checks and custom Application health checks.

In order to use the widget, you need to provide the Oh Dear API Key and Oh Dear Site ID in the extension configuration settings.

Customization

Adding Custom Checks

You can add custom checks by extending the AbstractCheck and registering your custom check(s) in the ext_localconf.php file.

$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['typo3_ohdear_health_check']['checks'][] = \Vendor\MyExtension\HealthCheck\CustomCheck::class;

Customizing Check Results Array

You can customize the result array of all checks by listening to the HealthCheckAfterRunEvent event.

# EXT:my_extension/Configuration/Services.yaml
services:
  # ...
  MyVendor\MyExtension\EventListener\HealthCheckAfterRunEventListener:
    tags:
      - name: event.listener
        method: handleEvent
        identifier: 'myHealthCheckAfterRunEventListener'
        event: Devskio\Typo3OhDearHealthCheck\Events\HealthCheckAfterRunEvent

Contributing

Contributions to the TYPO3 OhDear Health Check Extension are welcome! If you encounter any bugs, have suggestions, or want to contribute new features, please submit a pull request or open an issue in the GitHub repository.

License

This TYPO3 OhDear Health Check Extension is released under the MIT License.

devskio / typo3_ohdear_health_check

Maintainers

Details