SensorDisappearedSensors.php in Monitoring 7

Contains \Drupal\monitoring\Sensor\Sensors\SensorDisappearedSensors.

Namespace

Drupal\monitoring\Sensor\Sensors

File

lib/Drupal/monitoring/Sensor/Sensors/SensorDisappearedSensors.php

<?php

/**
 * @file
 * Contains \Drupal\monitoring\Sensor\Sensors\SensorDisappearedSensors.
 */
namespace Drupal\monitoring\Sensor\Sensors;

use Drupal\monitoring\Result\SensorResultInterface;
use Drupal\monitoring\Sensor\SensorConfigurable;

/**
 * Monitors if sensors disappeared without prior being disabled.
 *
 * It stores the list of available sensors and their enabled/disabled status
 * and compares it to the current sensor info retrieved via
 * monitoring_sensor_info() callback.
 */
class SensorDisappearedSensors extends SensorConfigurable {

  /**
   * {@inheritdoc}
   */
  public function runSensor(SensorResultInterface $result) {
    $available_sensors = variable_get('monitoring_available_sensors', array());
    $sensor_info = monitoring_sensor_info();
    $available_sensors = $this
      ->updateAvailableSensorsList($available_sensors, $sensor_info);
    $this
      ->checkForMissingSensors($result, $available_sensors, $sensor_info);
  }

  /**
   * Adds UI to clear the missing sensor status.
   */
  public function settingsForm($form, &$form_state) {
    $result = monitoring_sensor_run($this->info
      ->getName());
    $form = parent::settingsForm($form, $form_state);
    if ($result
      ->isCritical()) {
      $form['clear_missing_sensors_wrapper'] = array(
        '#type' => 'fieldset',
        '#title' => t('Missing sensors'),
        '#description' => t('This action will clear the missing sensors and the critical sensor status will go away.'),
        '#weight' => -10,
      );
      $form['clear_missing_sensors_wrapper']['info'] = array(
        '#type' => 'item',
        '#title' => t('Sensor message'),
        '#markup' => $result
          ->getMessage(),
      );
      $form['clear_missing_sensors_wrapper']['clear_missing_sensor'] = array(
        '#type' => 'submit',
        '#submit' => array(
          'monitoring_clear_missing_sensor_submit',
        ),
        '#value' => t('Clear missing sensors'),
      );
    }
    return $form;
  }

  /**
   * Updates the available sensor list.
   *
   * @param array $available_sensors
   *   The available sensors list.
   * @param \Drupal\monitoring\Sensor\SensorInfo[] $sensor_info
   *   The current sensor info.
   *
   * @return array
   *   Updated available sensors list.
   */
  protected function updateAvailableSensorsList($available_sensors, $sensor_info) {
    $new_sensors = array();
    foreach ($sensor_info as $key => $info) {

      // Check for newly added sensors. This is needed as some sensors get
      // enabled by default and not via monitoring_sensor_enable() callback that
      // takes care of updating the available sensors list.
      if (!isset($available_sensors[$key])) {
        $new_sensors[$key] = array(
          'name' => $key,
          'enabled' => $info
            ->isEnabled(),
        );
      }
      elseif ($available_sensors[$key]['enabled'] != $info
        ->isEnabled()) {
        $available_sensors[$key]['enabled'] = $info
          ->isEnabled();
      }
    }

    // If we have new sensors add it to available list.
    if (!empty($new_sensors)) {
      variable_set('monitoring_available_sensors', $available_sensors + $new_sensors);
      watchdog('monitoring', '@count new sensor/s added: @names', array(
        '@count' => count($new_sensors),
        '@names' => implode(', ', array_keys($new_sensors)),
      ));
    }
    return $available_sensors;
  }

  /**
   * Checks for missing sensors.
   *
   * @param SensorResultInterface $result
   *   The current sensor result object.
   * @param array $available_sensors
   *   The available sensors list.
   * @param \Drupal\monitoring\Sensor\SensorInfo[] $sensor_info
   *   The current sensor info.
   */
  protected function checkForMissingSensors(SensorResultInterface $result, $available_sensors, $sensor_info) {
    $result
      ->setStatus(SensorResultInterface::STATUS_OK);
    $sensors_to_remove = array();

    // Check for missing sensors.
    foreach ($available_sensors as $available_sensor) {
      if (!in_array($available_sensor['name'], array_keys($sensor_info))) {

        // If sensor is missing and was not disabled prior to go missing do
        // escalate to critical status.
        if (!empty($available_sensor['enabled'])) {
          $result
            ->setStatus(SensorResultInterface::STATUS_CRITICAL);
          $result
            ->addStatusMessage('Missing sensor @name', array(
            '@name' => $available_sensor['name'],
          ));
        }
        else {
          $sensors_to_remove[] = $available_sensor['name'];
        }
      }
    }

    // If having sensor to remove, reset the available sensors variable.
    if (!empty($sensors_to_remove)) {
      foreach ($sensors_to_remove as $sensor_to_remove) {
        unset($available_sensors[$sensor_to_remove]);
      }
      variable_set('monitoring_available_sensors', $available_sensors);
      watchdog('monitoring', '@count new sensor/s removed: @names', array(
        '@count' => count($sensors_to_remove),
        '@names' => implode(', ', $sensors_to_remove),
      ));
    }
  }

}

Classes

Name	Description
SensorDisappearedSensors	Monitors if sensors disappeared without prior being disabled.