class SensorSearchApi in Monitoring 7

Monitors unindexed items for a search api index.

Every instance represents a single index.

Once all items are processed, the value should be 0.

Hierarchy

• class \Drupal\monitoring\Sensor\Sensor implements SensorInterface
  • class \Drupal\monitoring\Sensor\SensorConfigurable implements SensorConfigurableInterface
    • class \Drupal\monitoring\Sensor\SensorThresholds implements SensorThresholdsInterface
      • class \Drupal\monitoring\Sensor\Sensors\SensorSearchApi

See also

search_api_index_status()

File

lib/Drupal/monitoring/Sensor/Sensors/SensorSearchApi.php, line 21

Contains \Drupal\monitoring\Sensor\Sensors\SensorSearchApi.

Namespace

Drupal\monitoring\Sensor\Sensors

class SensorSearchApi extends SensorThresholds {

  /**
   * {@inheritdoc}
   */
  public function runSensor(SensorResultInterface $result) {
    $indexes = search_api_index_load_multiple(array(
      $this->info
        ->getSetting('index_id'),
    ));
    $index = reset($indexes);
    $status = search_api_index_status($index);

    // Set amount of unindexed items.
    $result
      ->setValue($status['total'] - $status['indexed']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Sensor::$info	protected	property	Current sensor info object.
Sensor::getSensorName	public	function	Gets sensor name (not the label). Overrides SensorInterface::getSensorName
Sensor::isEnabled	public	function	Determines if sensor is enabled. Overrides SensorInterface::isEnabled
Sensor::__construct		function	Instantiates a sensor object.	1
SensorSearchApi::runSensor	public	function	Runs the sensor, updating $sensor_result. Overrides SensorInterface::runSensor
SensorThresholds::setFormError	protected	function	Sets a form error for the given threshold key.
SensorThresholds::settingsForm	public	function	Gets settings form for a specific sensor. Overrides SensorConfigurable::settingsForm	1
SensorThresholds::settingsFormValidate	public	function	Form validator for a sensor settings form. Overrides SensorConfigurable::settingsFormValidate