forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-47271 tool_task: Added Task API status checks
- Loading branch information
1 parent
e8e2bd2
commit 59a44a5
Showing
9 changed files
with
374 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| <?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/>. | ||
|
|
||
| /** | ||
| * Ad hoc queue checks | ||
| * | ||
| * @package tool_task | ||
| * @copyright 2020 Brendan Heywood ([email protected]) | ||
| * @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; | ||
|
|
||
| /** | ||
| * Ad hoc queue checks | ||
| * | ||
| * @package tool_task | ||
| * @copyright 2020 Brendan Heywood ([email protected]) | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class adhocqueue extends check { | ||
|
|
||
| /** | ||
| * Constructor | ||
| */ | ||
| public function __construct() { | ||
| global $CFG; | ||
| $this->id = 'adhocqueue'; | ||
| $this->name = get_string('checkadhocqueue', 'tool_task'); | ||
| } | ||
|
|
||
| /** | ||
| * 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); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| <?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 ([email protected]) | ||
| * @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 ([email protected]) | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class cronrunning extends check { | ||
|
|
||
| /** | ||
| * Constructor | ||
| */ | ||
| public function __construct() { | ||
| global $CFG; | ||
| $this->id = 'cronrunning'; | ||
| $this->name = get_string('checkcronrunning', 'tool_task'); | ||
| if (empty($CFG->cronclionly)) { | ||
| $this->actionlink = new \action_link( | ||
| new \moodle_url('/admin/cron.php'), | ||
| get_string('cron', 'admin')); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * 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); | ||
|
|
||
| $details = format_time($delta); | ||
|
|
||
| if ($delta > $expectedfrequency + MINSECS) { | ||
| $status = result::WARNING; | ||
|
|
||
| if ($delta > DAYSECS) { | ||
| $status = result::CRITICAL; | ||
| } | ||
|
|
||
| if (empty($lastcron)) { | ||
| $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); | ||
| } | ||
|
|
||
| if ($lastcroninterval > $expectedfrequency) { | ||
| $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); | ||
| } | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| <?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 ([email protected]) | ||
| * @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 ([email protected]) | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class maxfaildelay extends check { | ||
|
|
||
| /** | ||
| * Constructor | ||
| */ | ||
| public function __construct() { | ||
| global $CFG; | ||
| $this->id = 'cronfaildelay'; | ||
| $this->name = get_string('checkmaxfaildelay', 'tool_task'); | ||
| $this->actionlink = new \action_link( | ||
| new \moodle_url('/admin/tool/task/scheduledtasks.php'), | ||
| get_string('scheduledtasks', '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>"; | ||
| } | ||
| } | ||
|
|
||
| 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); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.