croncheck.php

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * CRON health check
 *
 * @package    tool_heartbeat
 * @copyright  2015 Brendan Heywood <brendan@catalyst-au.net>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 *
 * This can be run either as a web api, or on the CLI. When run on the
 * CLI it conforms to the Nagios plugin standard.
 *
 * See also:
 *  - http://nagios.sourceforge.net/docs/3_0/pluginapi.html
 *  - https://nagios-plugins.org/doc/guidelines.html#PLUGOUTPUT
 *
 */

define('NO_UPGRADE_CHECK', true);

$cronthreshold   = 6;   // Hours.
$cronwarn        = 2;   // Hours.
$delaythreshold  = 600; // Minutes.
$delaywarn       = 60;  // Minutes.
$legacythreshold = 60 * 6; // Minute.
$legacywarn      = 60 * 2; // Minutes.

$dirroot = '../../../';

if (isset($argv)) {
    // If run from the CLI.
    define('CLI_SCRIPT', true);

    $last = $argv[count($argv) - 1];
    if (preg_match("/(.*):(.+)/", $last, $matches)) {
        $last = $matches[1];
    }
    if ($last && is_dir($last) ) {
        $dirroot = $last . '/';
        array_pop($_SERVER['argv']);
    }

    require($dirroot.'config.php');
    require_once($CFG->libdir.'/clilib.php');

    list($options, $unrecognized) = cli_get_params(
        array(
            'help' => false,
            'cronwarn'    => $cronwarn,
            'cronerror'   => $cronthreshold,
            'delaywarn'   => $delaywarn,
            'delayerror'  => $delaythreshold,
            'legacywarn'  => $legacywarn,
            'legacyerror' => $legacythreshold,
        ),
        array(
            'h'   => 'help'
        )
    );

    if ($unrecognized) {
        $unrecognized = implode("\n  ", $unrecognized);
        cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
    }

    if ($options['help']) {
        print "Check the moodle cron system for when it last ran and any task fail delays

croncheck.php [options] [moodle path]

Options:
-h, --help          Print out this help
    --cronwarn=n    Threshold for no cron run error in hours (default $cronwarn)
    --cronerror=n   Threshold for no cron run warn in hours (default $cronthreshold)
    --delaywarn=n   Threshold for fail delay cron error in minutes (default $delaywarn)
    --delayerror=n  Threshold for fail delay cron warn in minutes (default $delaythreshold)
    --legacywarn=n  Threshold for legacy cron warn in minutes (default $legacywarn)
    --legacyerror=n Threshold for legacy cron error in minutes (default $legacythreshold)

Example:
\$sudo -u www-data /usr/bin/php admin/tool/heartbeat/croncheck.php
";
        die;
    }

} else {
    // If run from the web.
    define('NO_MOODLE_COOKIES', true);
    require($dirroot.'config.php');
    $options = array(
        'cronerror'   => optional_param('cronerror',   $cronthreshold,   PARAM_NUMBER),
        'cronwarn'    => optional_param('cronwarn',    $cronwarn,        PARAM_NUMBER),
        'delayerror'  => optional_param('delayerror',  $delaythreshold,  PARAM_NUMBER),
        'delaywarn'   => optional_param('delaywarn',   $delaywarn,       PARAM_NUMBER),
        'legacyerror' => optional_param('legacyerror', $legacythreshold, PARAM_NUMBER),
        'legacywarn'  => optional_param('legacywarn',  $legacywarn,      PARAM_NUMBER),
    );
    header("Content-Type: text/plain");

    // Make sure varnish doesn't cache this. But it still might so go check it!
    header('Pragma: no-cache');
    header('Cache-Control: private, no-cache, no-store, max-age=0, must-revalidate, proxy-revalidate');
    header('Expires: Tue, 04 Sep 2012 05:32:29 GMT');
}

$format = '%b %d %H:%M:%S';

$now = userdate(time(), $format);

function send_good($msg) {
    global $now;
    printf ("OK: $msg (Checked $now)\n");
    exit(0);
}

function send_warning($msg) {
    global $now;
    printf ("WARNING: $msg (Checked $now)\n");
    exit(1);
}

function send_critical($msg) {
    global $now;
    printf ("CRITICAL: $msg (Checked $now)\n");
    exit(2);
}

if (moodle_needs_upgrading()) {
    send_critical("Moodle upgrade pending, cron execution suspended");
}

if ($CFG->branch < 27) {

    $lastcron = $DB->get_field_sql('SELECT MAX(lastcron) FROM {modules}');
    $currenttime = time();
    $difference = $currenttime - $lastcron;

    if ( $difference > $options['cronerror'] * 60 * 60 ) {
        send_critical("Moodle cron ran > {$options['cronerror']} hours ago\nLast run at $when");
    }

    if ( $difference > $options['cronwarn'] * 60 * 60 ) {
        send_warning("Moodle cron ran > {$options['cronwarn']} hours ago\nLast run at $when");
    }

    send_good("MOODLE CRON RUNNING\n");
}

$lastcron = $DB->get_field_sql('SELECT MAX(lastruntime) FROM {task_scheduled}');
$currenttime = time();
$difference = $currenttime - $lastcron;

$testing = get_config('tool_heartbeat', 'testing');
if ($testing == 'error') {
    send_critical("Moodle this is a test $CFG->wwwroot/admin/settings.php?section=tool_heartbeat\n");
} else if ($testing == 'warn') {
    send_warning("Moodle this is a test $CFG->wwwroot/admin/settings.php?section=tool_heartbeat\n");
}

$when = userdate($lastcron, $format);

if ( $difference > $options['cronerror'] * 60 * 60 ) {
    send_critical("Moodle cron ran > {$options['cronerror']} hours ago\nLast run at $when");
}

if ( $difference > $options['cronwarn'] * 60 * 60 ) {
    send_warning("Moodle cron ran > {$options['cronwarn']} hours ago\nLast run at $when");
}

$delay = '';
$maxdelay = 0;
$tasks = core\task\manager::get_all_scheduled_tasks();
$legacylastrun = null;
foreach ($tasks as $task) {
    if ($task->get_disabled()) {
        continue;
    }
    $faildelay = $task->get_fail_delay();
    if (get_class($task) == 'core\task\legacy_plugin_cron_task') {
        $legacylastrun = $task->get_last_run_time();
    }
    if ($faildelay == 0) {
        continue;
    }
    if ($faildelay > $maxdelay) {
        $maxdelay = $faildelay;
    }
    $delay .= "TASK: " . $task->get_name() . ' (' .get_class($task) . ") Delay: $faildelay\n";
}

if ( empty($legacylastrun) ) {
    send_warning("Moodle legacy task isn't running (ie disabled)\n");
}
$minsincelegacylastrun = floor((time() - $legacylastrun) / 60); // In minutes.
$when = userdate($legacylastrun, $format);

if ( $minsincelegacylastrun > $options['legacyerror']) {
    send_critical("Moodle legacy task last run $minsincelegacylastrun mins ago > {$options['legacyerror']} mins\nLast run at $when");
}
if ( $minsincelegacylastrun > $options['legacywarn']) {
    send_warning("Moodle legacy task last run $minsincelegacylastrun mins ago > {$options['legacywarn']} mins\nLast run at $when");
}

$maxminsdelay = $maxdelay / 60;
if ( $maxminsdelay > $options['delayerror'] ) {
    send_critical("Moodle task faildelay > {$options['delayerror']} mins\n$delay");

} else if ( $maxminsdelay > $options['delaywarn'] ) {
    send_warning("Moodle task faildelay > {$options['delaywarn']} mins\n$delay");
}

send_good("MOODLE CRON RUNNING\n");