first commit

admin/tool/task/classes/check/adhocqueue.php

@@ -0,0 +1,88 @@
+<?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/>.
+
+namespace tool_task\check;
+
+use action_link;
+use core\check\check;
+use core\check\result;
+use moodle_url;
+
+/**
+ * Ad hoc queue checks
+ *
+ * @package    tool_task
+ * @copyright  2020 Brendan Heywood (brendan@catalyst-au.net)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class adhocqueue extends check {
+
+    /**
+     * Return result
+     * @return result
+     */
+    public function get_result(): result {
+        global $DB, $CFG;
+
+        $stats = $DB->get_record_sql('
+            SELECT count(*) cnt,
+                   MAX(? - nextruntime) age
+              FROM {task_adhoc}', [time()]);
+
+        $status = result::OK;
+        $summary = get_string('adhocempty', 'tool_task');
+        $details = '';
+
+        if ($stats->cnt > 0) {
+            // A large queue size by itself is not an issue, only when tasks
+            // are not being processed in a timely fashion is it an issue.
+            $status = result::INFO;
+            $summary = get_string('adhocqueuesize', 'tool_task', $stats->cnt);
+        }
+
+        $max = $CFG->adhoctaskagewarn ?? 10 * MINSECS;
+        if ($stats->age > $max) {
+            $status = result::WARNING;
+            $summary = get_string('adhocqueueold', 'tool_task', [
+                'age' => format_time($stats->age),
+                'max' => format_time($max),
+            ]);
+        }
+
+        $max = $CFG->adhoctaskageerror ?? 4 * HOURSECS;
+        if ($stats->age > $max) {
+            $status = result::ERROR;
+            $summary = get_string('adhocqueueold', 'tool_task', [
+                'age' => format_time($stats->age),
+                'max' => format_time($max),
+            ]);
+        }
+
+        return new result($status, $summary, $details);
+    }
+
+    /**
+     * Link to the Ad hoc tasks report
+     *
+     * @return action_link|null
+     */
+    public function get_action_link(): ?action_link {
+        return new action_link(
+            new moodle_url('/admin/tool/task/adhoctasks.php'),
+            get_string('adhoctasks', 'tool_task'),
+        );
+    }
+}

admin/tool/task/classes/check/cronrunning.php

@@ -0,0 +1,125 @@
+<?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 running check
+ *
+ * @package    tool_task
+ * @copyright  2020 Brendan Heywood (brendan@catalyst-au.net)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace tool_task\check;
+
+defined('MOODLE_INTERNAL') || die();
+
+use core\check\check;
+use core\check\result;
+/**
+ * Cron running check
+ *
+ * @package    tool_task
+ * @copyright  2020 Brendan Heywood (brendan@catalyst-au.net)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class cronrunning extends check {
+
+    /**
+     * A link the running tasks report
+     *
+     * @return action_link|null
+     */
+    public function get_action_link(): ?\action_link {
+        return new \action_link(
+            new \moodle_url('/admin/tool/task/runningtasks.php'),
+            get_string('runningtasks', 'tool_task'));
+    }
+
+    /**
+     * Return result
+     * @return result
+     */
+    public function get_result(): result {
+        global $CFG;
+
+        // Eventually this should replace cron_overdue_warning and
+        // cron_infrequent_warning.
+        $lastcron = get_config('tool_task', 'lastcronstart');
+        $expectedfrequency = $CFG->expectedcronfrequency ?? MINSECS;
+
+        $delta = time() - $lastcron;
+
+        $lastcroninterval = get_config('tool_task', 'lastcroninterval');
+
+        $formatdelta    = format_time($delta);
+        $formatexpected = format_time($expectedfrequency);
+        $formatinterval = format_time($lastcroninterval);
+
+        // Inform user the time since last cron start.
+        $details = get_string('lastcronstart', 'tool_task', $formatdelta);
+
+        if ($delta > $expectedfrequency + MINSECS) {
+            $status = result::WARNING;
+
+            if ($delta > DAYSECS) {
+                $status = result::CRITICAL;
+            }
+
+            if (empty($lastcron)) {
+                if (empty($CFG->cronclionly)) {
+                    $url = new \moodle_url('/admin/cron.php');
+                    $summary = get_string('cronwarningneverweb', 'admin', [
+                        'url' => $url->out(),
+                        'expected' => $formatexpected,
+                    ]);
+                } else {
+                    $summary = get_string('cronwarningnever', 'admin', [
+                        'expected' => $formatexpected,
+                    ]);
+                }
+            } else if (empty($CFG->cronclionly)) {
+                $url = new \moodle_url('/admin/cron.php');
+                $summary = get_string('cronwarning', 'admin', [
+                    'url' => $url->out(),
+                    'actual'   => $formatdelta,
+                    'expected' => $formatexpected,
+                ]);
+            } else {
+                $summary = get_string('cronwarningcli', 'admin', [
+                    'actual'   => $formatdelta,
+                    'expected' => $formatexpected,
+                ]);
+            }
+            return new result($status, $summary, $details);
+        }
+
+        // Add MINSECS to avoid spurious warning if cron is only a few seconds overdue.
+        if ($lastcroninterval > $expectedfrequency + MINSECS) {
+            $status = result::WARNING;
+            $summary = get_string('croninfrequent', 'admin', [
+                'actual'   => $formatinterval,
+                'expected' => $formatexpected,
+            ]);
+            return new result($status, $summary, $details);
+        }
+
+        $status = result::OK;
+        $summary = get_string('cronok', 'tool_task');
+
+        return new result($status, $summary, $details);
+    }
+}
+

admin/tool/task/classes/check/longrunningtasks.php

@@ -0,0 +1,89 @@
+<?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/>.
+
+namespace tool_task\check;
+
+use core\check\check;
+use core\check\result;
+use core\task\manager;
+
+/**
+ * Long running tasks check
+ *
+ * @package    tool_task
+ * @author     Qihui Chan (qihuichan@catalyst-au.net)
+ * @copyright  2022 Catalyst IT Pty Ltd
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class longrunningtasks extends check {
+
+    /**
+     * Links to the running task list
+     *
+     * @return \action_link|null
+     * @throws \coding_exception
+     */
+    public function get_action_link(): ?\action_link {
+        $url = new \moodle_url('/admin/tool/task/runningtasks.php');
+        return new \action_link($url, get_string('runningtasks', 'tool_task'));
+    }
+
+    /**
+     * Return result
+     * @return result
+     */
+    public function get_result(): result {
+        global $CFG;
+        $status = result::OK;
+        $slowtasks = 0;
+        $details = '';
+        $maxruntime = 0;
+        $runtime = 0;
+
+        $tasks = \core\task\manager::get_running_tasks();
+        foreach ($tasks as $record) {
+            $taskmethod = "{$record->type}_task_from_record";
+            $task = manager::$taskmethod($record);
+            $taskname = $task->get_name();
+
+            $result = $task->get_runtime_result();
+            $taskstatus = $result->get_status();
+            $runtime = $task->get_runtime();
+            $runtimedetails = get_string('taskrunningtime', 'tool_task', format_time($runtime));
+            $maxruntime = ($runtime > $maxruntime) ? $runtime : $maxruntime;
+
+            if ($taskstatus == result::OK) {
+                continue;
+            }
+
+            $slowtasks++;
+            $details .= strtoupper($taskstatus) . ": {$taskname}. {$runtimedetails} <br>";
+
+            // The overall check status is the worst tasks status.
+            if ($status !== result::ERROR) {
+                $status = $taskstatus;
+            }
+        }
+
+        $summary = get_string('checklongrunningtaskcount', 'tool_task', $slowtasks);
+        $conclusion = get_string('taskdetails', 'tool_task', ['count' => $slowtasks,
+            'time' => format_time($CFG->taskruntimewarn), 'maxtime' => format_time($maxruntime)]);
+
+        $details = ($slowtasks ? $conclusion : $summary) . "<br>{$details}";
+
+        return new result($status, $summary, $details);
+    }
+}

admin/tool/task/classes/check/maxfaildelay.php

@@ -0,0 +1,107 @@
+<?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/>.
+
+/**
+ * Task fail delay check
+ *
+ * @package    tool_task
+ * @copyright  2020 Brendan Heywood (brendan@catalyst-au.net)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace tool_task\check;
+
+defined('MOODLE_INTERNAL') || die();
+
+use core\check\check;
+use core\check\result;
+
+/**
+ * Task fail delay check
+ *
+ * @package    tool_task
+ * @copyright  2020 Brendan Heywood (brendan@catalyst-au.net)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class maxfaildelay extends check {
+
+    /**
+     * Links to the task log report
+     *
+     * @return \action_link|null
+     */
+    public function get_action_link(): ?\action_link {
+        $url = new \moodle_url('/admin/tasklogs.php');
+        return new \action_link($url, get_string('tasklogs', 'tool_task'));
+    }
+
+    /**
+     * Return result
+     * @return result
+     */
+    public function get_result(): result {
+        global $CFG;
+
+        $status = result::OK;
+        $summary = get_string('tasknofailures', 'tool_task');
+        $details = '';
+        $failures = 0;
+        $maxdelay = 0;
+
+        $tasks = \core\task\manager::get_all_scheduled_tasks();
+        foreach ($tasks as $task) {
+            if ($task->get_disabled()) {
+                continue;
+            }
+            $faildelay = $task->get_fail_delay();
+            if ($faildelay > $maxdelay) {
+                $maxdelay = $faildelay;
+            }
+            if ($faildelay > 0) {
+                $failures++;
+                $details .= get_string('faildelay', 'tool_task') . ': ' . format_time($faildelay);
+                $details .= ' - ' . $task->get_name() . ' (' .get_class($task) . ")<br>";
+            }
+        }
+
+        $tasks = \core\task\manager::get_failed_adhoc_tasks();
+        foreach ($tasks as $task) {
+            $faildelay = $task->get_fail_delay();
+            if ($faildelay > $maxdelay) {
+                $maxdelay = $faildelay;
+            }
+            if ($faildelay > 0) {
+                $failures++;
+                $details .= get_string('faildelay', 'tool_task') . ': ' . format_time($faildelay);
+                $details .= ' - ' .get_class($task) . " ID = " . $task->get_id() ."<br>";
+            }
+        }
+
+        if ($failures > 0) {
+            // Intermittent failures are not yet a warning.
+            $status = result::INFO;
+            $summary = get_string('taskfailures', 'tool_task', $failures);
+        }
+        if ($maxdelay > 5 * MINSECS) {
+            $status = result::WARNING;
+        }
+        if ($maxdelay > 4 * HOURSECS) {
+            $status = result::ERROR;
+        }
+
+        return new result($status, $summary, $details);
+    }
+}