OhDear Integration
This module integrates your Drupal website with the Oh Dear monitoring service to enable advanced features like application health checks and cron monitoring. It provides an endpoint for Oh Dear to retrieve health check results from Drupal's monitoring module and automatically pings Oh Dear when cron jobs run. The module also includes Drush commands to manage maintenance windows, get site information, check for broken links, and retrieve uptime statistics.
Important Notice
OhDear Integration bellow 3.x are no longer compatible with the OhDear API. Update as soon as possible! See #3544574: Upgrade OhDear's PHP-SDK to v4.
Integrates your Drupal website with the Oh Dear monitoring app. While the main ohdear.app features like Uptime and Performance monitoring do not require anything, the module takes care of the necessary integration for more advanced features like Application health monitoring.
The module provides a /json/oh-dear-health-check-results endpoint for OhDear application health checks by integrating with the Monitoring module, i.e. sensor results from the monitoring module are provide to OhDear via the endpoint.
Moreover, it provides Cron-monitoring by integrating with OhDears Scheduled tasks feature.
Configuration
Application Health
- At
/admin/config/system/settingsconfigureoh-dear-health-check-secret. This is obtained on the Oh Dear service under Application health tab. - Configure monitoring sensors at
/admin/config/system/monitoring/settings. - For nicer health checks overview we've developed a sensor that provides a combined monitoring sensor for all Status-Report checks (called RequirementsRecap). We recommend using it but is currently only available as a patch: #3307528: New sensor: Requirements recap.
Cron monitoring
- When the OhDear ping URI for cron has been configured, Drupal automatically pings OhDear on cron runs.
- The ping URI is provided by OhDear under the
Scheduled taskstab.
Drush Commands
Maintenance windows
This modules provides a drush command to start a maintenance window on OhDear.
drush ohdear:maintenance allows you to see existing maintenance windows and reports status. With start and stop flag you can also start a new maintenance window or stop existing one.
Info
drush ohdear:info prints basic info about configured site.
Broken links
drush ohdear:broken-links get broken links for current site.
Uptime
drush ohdear:uptime get uptime for last week with daily uptime percentages. That's the default but with additional arguments you can adjust the start and end time and the time period (day, week, month).
Contribute
- Reach out at #drunomics-contribute @ the Drupal Slack!