Skip to content

Commit

Permalink
Add ability to override check status #169
Browse files Browse the repository at this point in the history 
Co-authored-by: Owen Herbert <owenherbert@catalyst-au.net>
  • Loading branch information
@bwalkerl @owenherbert @brendanheywood
2 people authored and brendanheywood committed Mar 12, 2024
1 parent e8db185 commit 40e0851
Show file tree
Hide file tree
Showing 12 changed files with 832 additions and 21 deletions.
35 changes: 30 additions & 5 deletions classes/checker.php
View file
Expand Up @@ -57,9 +57,7 @@ public static function get_check_messages(): array {
}

// Remove any supressed checks from the list.
$checks = array_filter($checks, function($check) {
return !in_array(get_class($check), self::supressed_checks());
});
$checks = self::remove_supressed_checks($checks);

// Execute each check and store their messages.
$messages = [];
Expand Down Expand Up @@ -132,7 +130,7 @@ private static function exception_to_message(string $prefix, Throwable $e): resu
private static function process_check_and_get_result(check $check): resultmessage {
$res = new resultmessage();

$checkresult = $check->get_result();
$checkresult = self::get_overridden_result($check);

// Map check result to nagios level.
$map = [
Expand Down Expand Up @@ -297,5 +295,32 @@ private static function supressed_checks(): array {
\tool_task\check\adhocqueue::class,
];
}
}

/**
* Removes supressed checks from an array
* @param array $checks
* @return array of checks without supressed checks
*/
public static function remove_supressed_checks(array $checks): array {
// Remove any supressed checks from the list.
return array_filter($checks, function($check) {
return !in_array(get_class($check), self::supressed_checks());
});
}

/**
* Gets a check result while applying specified overrides.
* @param check $check
* @return result with overrides
*/
public static function get_overridden_result(check $check): result {
$ref = $check->get_ref();
$result = $check->get_result();

$override = \tool_heartbeat\object\override::get_active_override($ref);
if (isset($override)) {
return new result($override->get('override'), $result->get_summary(), $result->get_details());
}
return $result;
}
}
76 changes: 76 additions & 0 deletions classes/form/override_form.php
View file
@@ -0,0 +1,76 @@
<?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/>.
/**
* Override form
*
* @package tool_heartbeat
* @copyright 2023 Owen Herbert <owenherbert@catalyst-au.net>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*
*/

namespace tool_heartbeat\form;

use core\check\result;
use core\form\persistent;

/**
* Override form
*
* @package tool_heartbeat
* @copyright 2023 Owen Herbert <owenherbert@catalyst-au.net>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class override_form extends persistent {

/** @var string Persistent class name. */
protected static $persistentclass = 'tool_heartbeat\\object\\override';

/**
* Define the form.
*/
public function definition() {
$mform = $this->_form;

// Ref.
$mform->addElement('static', 'ref', get_string('check'));
$mform->setConstant('ref', $this->_customdata['ref']);

// Override.
$mform->addElement('select', 'override', get_string('override', 'tool_heartbeat'), [
result::NA => get_string('statusna'),
result::OK => get_string('statusok'),
result::INFO => get_string('statusinfo'),
result::UNKNOWN => get_string('statusunknown'),
result::WARNING => get_string('statuswarning'),
result::CRITICAL => get_string('statuscritical'),
result::ERROR => get_string('statuserror'),
]);

// Note.
$mform->addElement('textarea', 'note', get_string('notes', 'core_notes'), ['rows' => 3]);
$mform->addRule('note', get_string('noterequired', 'tool_heartbeat'), 'required', null, 'client');

// URL.
$mform->addElement('text', 'url', get_string('url'), ['size' => 80]);
$mform->setType('url', PARAM_URL);

// Override until.
$mform->addElement('date_selector', 'expires_at', get_string('expiresat', 'tool_heartbeat'));

$this->add_action_buttons();
}
}
207 changes: 207 additions & 0 deletions classes/object/override.php
View file
@@ -0,0 +1,207 @@
<?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/>.
/**
*
* Heartbeat override
*
* @package tool_heartbeat
* @copyright 2023 Owen Herbert <owenherbert@catalyst-au.net>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*
*/

namespace tool_heartbeat\object;

use core\persistent;

/**
* Represents a heartbeat override.
*/
class override extends Persistent {

/**
* Table name for the persistent.
*/
const TABLE = 'tool_heartbeat_overrides';

/**
* Create an instance of this class with the default expires at.
*
* @param int $id If set, this is the id of an existing record, used to load the data.
* @param \stdClass $record If set will be passed to {@link self::from_record()}.
*/

public function __construct(int $id = 0, \stdClass $record = null) {
$this->set_default_expiry();
parent::__construct($id, $record);
}

/**
* Return the definition of the properties of this model.
*
* @return array
*/
protected static function define_properties(): array {
return [
'ref' => [
'null' => NULL_NOT_ALLOWED,
'type' => PARAM_TEXT,
],
'override' => [
'null' => NULL_NOT_ALLOWED,
'type' => PARAM_TEXT,
],
'userid' => [
'null' => NULL_NOT_ALLOWED,
'type' => PARAM_INT,
'default' => 0,
],
'note' => [
'null' => NULL_NOT_ALLOWED,
'type' => PARAM_TEXT,
],
'url' => [
'null' => NULL_NOT_ALLOWED,
'type' => PARAM_TEXT,
],
'expires_at' => [
'null' => NULL_NOT_ALLOWED,
'type' => PARAM_INT,
],
'resolved_at' => [
'null' => NULL_NOT_ALLOWED,
'type' => PARAM_INT,
'default' => 0,
],
];
}

/**
* Sets the expiry time to the default value
*
* @return void
*/
private function set_default_expiry() {
$expiredate = date('Y-m-d', time() + (int) get_config('tool_heartbeat', 'mutedefault'));
$this->set('expires_at', strtotime($expiredate));
}

/**
* Resolves and unmutes a check.
*
* @param int $time optional param to set a sepcific resolved at time
* @return void
*/
public function resolve($time = 0) {
$time = $time ?: time();
$this->set('resolved_at', $time);
$this->save();
}

/**
* Gets an active override based on a ref.
*
* @param string $ref ref
* @return override|null
*/
public static function get_active_override($ref): ?override {
// This call will usually be called for every ref, so load all active overrides.
$overrides = self::get_active_overrides();
return $overrides[$ref] ?? null;
}

/**
* Returns a list of active overrides with ref as the key.
*
* @return array array of overrides, with check ref as the key
*/
protected static function get_active_overrides(): array {
static $overrides;

if (isset($overrides)) {
return $overrides;
}

// Keep resolved status up to date.
self::mark_expired_as_resolved();

// Get overrides that and unresolved and expire in the future.
$overrides = [];
$conditions = "expires_at >= ? AND resolved_at = 0";
$results = self::get_records_select($conditions, [time()]);

// Update key to be the ref, which is unique when unresolved.
foreach ($results as $result) {
$ref = $result->get('ref');
$overrides[$ref] = $result;
}

return $overrides;
}

/**
* Returns an instance of a previous override with reset values.
*
* @param string $ref
* @return override|null
*/
public static function get_restored_override(string $ref): ?override {
// Make sure there's no active override.
$active = self::get_active_override($ref);
if (!empty($active)) {
return null;
}

// Get previous override that has expired or been resolved within the last year.
$conditions = "ref = ? AND (expires_at < ? OR resolved_at != 0) AND expires_at > ?";
$params = [$ref, time(), strtotime('-1 year')];
$previous = self::get_records_select($conditions, $params, 'expires_at DESC, resolved_at DESC', '*', 0, 1);
if (empty($previous)) {
return null;
}

// Copy record and clear previous time and id data so a new record is created.
$override = reset($previous);
$override->set('id', 0);
$override->set('resolved_at', 0);
$override->set_default_expiry();
return $override;
}

/**
* Marks all expired overrides as resolved
*
* @return void
*/
protected static function mark_expired_as_resolved() {
$conditions = "expires_at < ? AND resolved_at = 0";
$overrides = self::get_records_select($conditions, [time()]);
foreach ($overrides as $override) {
$override->resolve();
}
}

/**
* Returns the human readable time until mute ends
*
* @return string
*/
public function get_time_until_mute_ends(): string {
$enddate = userdate($this->get('expires_at'), get_string('strftimedate', 'langconfig'));
$remainingtime = format_time($this->get('expires_at') - time());
return "$enddate ($remainingtime)";
}
}

0 comments on commit 40e0851

Please sign in to comment.