diff --git a/modules/monitoring_icinga/monitoring_icinga.module b/modules/monitoring_icinga/monitoring_icinga.module index 7b93da3..dcdae63 100644 --- a/modules/monitoring_icinga/monitoring_icinga.module +++ b/modules/monitoring_icinga/monitoring_icinga.module @@ -50,7 +50,7 @@ function monitoring_icinga_menu() { * Icinga service description. */ function monitoring_icinga_service_description(SensorConfig $sensor_config) { - return $sensor_config->getCategory() . ' - ' . $sensor_config->getLabel() . ' - ' . $sensor_config->getName(); + return $sensor_config->getCategory() . ' - ' . $sensor_config->getLabel() . ' - ' . $sensor_config->id(); } /** diff --git a/modules/monitoring_munin/monitoring_munin.module b/modules/monitoring_munin/monitoring_munin.module index d4c7821..52fb19a 100644 --- a/modules/monitoring_munin/monitoring_munin.module +++ b/modules/monitoring_munin/monitoring_munin.module @@ -106,9 +106,9 @@ function monitoring_munin_multigraph_delete($title) { unset($munin_settings['multigraphs'][$i]); } } - $settings = monitoring_sensor_settings_get($info->getName()); + $settings = monitoring_sensor_settings_get($info->id()); $settings['munin'] = $munin_settings; - monitoring_sensor_settings_save($info->getName(), $settings); + monitoring_sensor_settings_save($info->id(), $settings); } } } diff --git a/modules/multigraph/src/Form/MultigraphForm.php b/modules/multigraph/src/Form/MultigraphForm.php index 72f0301..bd80771 100644 --- a/modules/multigraph/src/Form/MultigraphForm.php +++ b/modules/multigraph/src/Form/MultigraphForm.php @@ -75,7 +75,7 @@ class MultigraphForm extends EntityForm { $sensors_options = array(); foreach ($sensors as $sensor) { if ($sensor->isNumeric()) { - $sensors_options[$sensor->getName()] = $sensor->getLabel(); + $sensors_options[$sensor->id()] = $sensor->getLabel(); } } diff --git a/monitoring.drush.inc b/monitoring.drush.inc index 153da80..e820cfb 100644 --- a/monitoring.drush.inc +++ b/monitoring.drush.inc @@ -169,7 +169,7 @@ function monitoring_drush_info_single($sensor_name) { return drush_set_error('MONITORING_SENSOR_INVALID_NAME', dt('Sensor "@name" does not exist.', array('@name' => $sensor_name))); } - $rows[] = array(String::format("@label (@name)", array('@label' => $sensor_config->getLabel(), '@name' => $sensor_config->getName())), '===================='); + $rows[] = array(String::format("@label (@name)", array('@label' => $sensor_config->getLabel(), '@name' => $sensor_config->id())), '===================='); $rows[] = array(dt('Category'), $sensor_config->getCategory()); $rows[] = array(dt('Description'), $sensor_config->getDescription()); $rows[] = array(dt('Value info'), String::format('type: @type, label: @label, numeric: @numeric', array( @@ -259,9 +259,9 @@ function monitoring_drush_run($sensor_name = NULL) { function monitoring_drush_result_output_json(array $results, $expand = NULL) { $json_output = array(); foreach ($results as $result) { - $json_output[$result->getSensorName()] = $result->toArray(); + $json_output[$result->getSensorId()] = $result->toArray(); if ($expand == 'sensor_info') { - $json_output[$result->getSensorName()]['sensor_info'] = $result->getSensorConfig()->toArray(); + $json_output[$result->getSensorId()]['sensor_info'] = $result->getSensorConfig()->toArray(); } } drush_print(Json::encode($json_output)); @@ -291,7 +291,7 @@ function monitoring_drush_result_output_table(array $results, $show_exec_time = * Sensor result object. */ function monitoring_drush_result_output_table_single(SensorResultInterface $result) { - $rows[] = array(dt('Name'), $result->getSensorConfig()->getName()); + $rows[] = array(dt('ID'), $result->getSensorConfig()->id()); $rows[] = array(dt('Label'), $result->getSensorConfig()->getLabel()); $rows[] = array(dt('Status'), $result->getStatusLabel()); $rows[] = array(dt('Message'), $result->getMessage()); @@ -321,15 +321,15 @@ function monitoring_drush_result_output_table_multiple(array $results, $show_exe } foreach ($results as $result) { - $rows[$result->getSensorName()] = array( - String::format("@label\n(@name)", array('@label' => Unicode::truncate($result->getSensorConfig()->getLabel(), 40, TRUE, TRUE), '@name' => $result->getSensorName())), + $rows[$result->getSensorId()] = array( + String::format("@label\n(@id)", array('@label' => Unicode::truncate($result->getSensorConfig()->getLabel(), 40, TRUE, TRUE), '@id' => $result->getSensorId())), $result->getStatusLabel(), Unicode::truncate($result->getMessage(), 40, TRUE, TRUE), \Drupal::service('date.formatter')->formatInterval(time() - $result->getTimestamp()), ); if ($show_exec_time) { - $rows[$result->getSensorName()][] = $result->getExecutionTime() . 'ms'; + $rows[$result->getSensorId()][] = $result->getExecutionTime() . 'ms'; } } diff --git a/monitoring.module b/monitoring.module index fcdf498..f0dc68c 100644 --- a/monitoring.module +++ b/monitoring.module @@ -209,7 +209,7 @@ function monitoring_sensor_settings_get($sensor_name) { */ function monitoring_sensor_result_save(SensorResultInterface $result) { $values = array( - 'sensor_name' => $result->getSensorName(), + 'sensor_name' => $result->getSensorId(), 'sensor_status' => $result->getStatus(), 'sensor_message' => $result->getMessage(), 'sensor_value' => $result->getValue(), diff --git a/src/Controller/ForceRunController.php b/src/Controller/ForceRunController.php index 257915a..d59dea4 100644 --- a/src/Controller/ForceRunController.php +++ b/src/Controller/ForceRunController.php @@ -67,7 +67,7 @@ class ForceRunController extends ControllerBase { */ public function forceRunSensor(SensorConfig $monitoring_sensor_config) { - $this->sensorRunner->resetCache(array($monitoring_sensor_config->getName())); + $this->sensorRunner->resetCache(array($monitoring_sensor_config->id())); drupal_set_message($this->t('Force run of the sensor @name executed.', array('@name' => $monitoring_sensor_config->getLabel()))); return $this->redirect('monitoring.sensor_list'); } diff --git a/src/Entity/SensorConfig.php b/src/Entity/SensorConfig.php index 3f175b6..2ff49bb 100644 --- a/src/Entity/SensorConfig.php +++ b/src/Entity/SensorConfig.php @@ -122,16 +122,6 @@ class SensorConfig extends ConfigEntityBase { public $status = TRUE; /** - * Gets Sensor ID. - * - * @return string - * Sensor ID. - */ - public function getName() { - return $this->id; - } - - /** * Gets sensor label. * * The sensor label might not be self-explaining enough or unique without @@ -362,7 +352,7 @@ class SensorConfig extends ConfigEntityBase { */ public function getDefinition() { $config = array( - 'sensor' => $this->getName(), + 'sensor' => $this->id(), 'label' => $this->getLabel(), 'category' => $this->getCategory(), 'description' => $this->getDescription(), diff --git a/src/Form/SensorDetailForm.php b/src/Form/SensorDetailForm.php index af6d8ef..ead8569 100644 --- a/src/Form/SensorDetailForm.php +++ b/src/Form/SensorDetailForm.php @@ -188,7 +188,7 @@ class SensorDetailForm extends EntityForm { $view = Views::getView('monitoring_sensor_results'); if (!empty($view)) { $view->initDisplay(); - $output = $view->preview('detail_page_log', array($sensor_config->getName())); + $output = $view->preview('detail_page_log', array($sensor_config->id())); if (!empty($view->result)) { $form['sensor_log'] = array( '#type' => 'details', diff --git a/src/Plugin/monitoring/SensorPlugin/DisappearedSensorsSensorPlugin.php b/src/Plugin/monitoring/SensorPlugin/DisappearedSensorsSensorPlugin.php index 9831ec7..5b94964 100644 --- a/src/Plugin/monitoring/SensorPlugin/DisappearedSensorsSensorPlugin.php +++ b/src/Plugin/monitoring/SensorPlugin/DisappearedSensorsSensorPlugin.php @@ -42,7 +42,7 @@ class DisappearedSensorsSensorPlugin extends SensorPluginBase { */ public function buildConfigurationForm(array $form, FormStateInterface $form_state) { try { - $result = monitoring_sensor_run($this->sensorConfig->getName()); + $result = monitoring_sensor_run($this->sensorConfig->id()); } catch (\Exception $e) { // @todo: Figure out why this happens. drupal_set_message($e->getMessage(), 'error'); diff --git a/src/Result/SensorResult.php b/src/Result/SensorResult.php index 3a11aad..9c36af6 100644 --- a/src/Result/SensorResult.php +++ b/src/Result/SensorResult.php @@ -205,7 +205,7 @@ class SensorResult implements SensorResultInterface { // Set the default message variables. $default_variables = array( - '@sensor' => $this->getSensorName(), + '@sensor' => $this->getSensorId(), '!formatted_value' => $this->getFormattedValue($this->getValue()), '@time' => $this->getTimestamp(), '!expected' => $msg_expected, @@ -448,7 +448,7 @@ class SensorResult implements SensorResultInterface { */ public function toArray() { return array( - 'sensor_name' => $this->getSensorName(), + 'sensor_name' => $this->getSensorId(), 'value' => $this->getValue(), 'expected_value' => $this->getExpectedValue(), 'numeric_value' => $this->toNumber(), @@ -476,8 +476,8 @@ class SensorResult implements SensorResultInterface { /** * {@inheritdoc} */ - public function getSensorName() { - return $this->sensorConfig->getName(); + public function getSensorId() { + return $this->sensorConfig->id(); } /** diff --git a/src/Result/SensorResultInterface.php b/src/Result/SensorResultInterface.php index 24f4486..cd22753 100644 --- a/src/Result/SensorResultInterface.php +++ b/src/Result/SensorResultInterface.php @@ -228,7 +228,7 @@ interface SensorResultInterface { * * @return string */ - public function getSensorName(); + public function getSensorId(); /** * Gets sensor config. diff --git a/src/Sensor/SensorManager.php b/src/Sensor/SensorManager.php index cb52d44..6b9aa3c 100644 --- a/src/Sensor/SensorManager.php +++ b/src/Sensor/SensorManager.php @@ -101,7 +101,7 @@ class SensorManager extends DefaultPluginManager { $enabled_sensors = array(); foreach ($this->getAllSensorConfig() as $sensor_config) { if ($sensor_config->isEnabled()) { - $enabled_sensors[$sensor_config->getName()] = $sensor_config; + $enabled_sensors[$sensor_config->id()] = $sensor_config; } } return $enabled_sensors; diff --git a/src/SensorPlugin/SensorPluginBase.php b/src/SensorPlugin/SensorPluginBase.php index 5a283f7..9213502 100644 --- a/src/SensorPlugin/SensorPluginBase.php +++ b/src/SensorPlugin/SensorPluginBase.php @@ -75,8 +75,8 @@ abstract class SensorPluginBase implements SensorPluginInterface { /** * {@inheritdoc} */ - public function getSensorName() { - return $this->sensorConfig->getName(); + public function getSensorId() { + return $this->sensorConfig->id(); } /** diff --git a/src/SensorPlugin/SensorPluginInterface.php b/src/SensorPlugin/SensorPluginInterface.php index d763726..15ef98a 100644 --- a/src/SensorPlugin/SensorPluginInterface.php +++ b/src/SensorPlugin/SensorPluginInterface.php @@ -45,7 +45,7 @@ interface SensorPluginInterface extends PluginInspectionInterface, PluginFormInt * @return string * Sensor name. */ - public function getSensorName(); + public function getSensorId(); /** * Runs the sensor, updating $sensor_result. @@ -165,4 +165,4 @@ interface SensorPluginInterface extends PluginInspectionInterface, PluginFormInt */ public static function create(ContainerInterface $container, SensorConfig $sensor_config, $plugin_id, $plugin_definition); -} \ No newline at end of file +} diff --git a/src/SensorPlugin/ThresholdsSensorPluginBase.php b/src/SensorPlugin/ThresholdsSensorPluginBase.php index 1a76e46..86ee5b2 100644 --- a/src/SensorPlugin/ThresholdsSensorPluginBase.php +++ b/src/SensorPlugin/ThresholdsSensorPluginBase.php @@ -145,7 +145,7 @@ abstract class ThresholdsSensorPluginBase extends SensorPluginBase implements Th * The validation message. */ protected function setFormError($threshold_key, FormStateInterface $form_state, $message) { - $form_state->setErrorByName($this->sensorConfig->getName() . '][thresholds][' . $threshold_key, $message); + $form_state->setErrorByName($this->sensorConfig->id() . '][thresholds][' . $threshold_key, $message); } /** diff --git a/src/SensorRunner.php b/src/SensorRunner.php index 7aa0c80..ef9198e 100644 --- a/src/SensorRunner.php +++ b/src/SensorRunner.php @@ -92,7 +92,7 @@ class SensorRunner { // Only load sensor caches if they define caching. foreach ($sensors_config as $sensor_config) { if ($sensor_config->getCachingTime()) { - $cids[] = $this->getSensorCid($sensor_config->getName()); + $cids[] = $this->getSensorCid($sensor_config->id()); } } if ($cids) { @@ -159,14 +159,14 @@ class SensorRunner { $plugin = $sensor_config->getPlugin(); // Check if sensor is enabled. if (!$plugin->isEnabled()) { - throw new DisabledSensorException(String::format('Sensor @sensor_name is not enabled and must not be run.', array('@sensor_name' => $sensor_config->getName()))); + throw new DisabledSensorException(String::format('Sensor @sensor_name is not enabled and must not be run.', array('@sensor_name' => $sensor_config->id()))); } $result = $this->getResultObject($sensor_config); // In case result is not yet cached run sensor. if (!$result->isCached()) { - Timer::start($sensor_config->getName()); + Timer::start($sensor_config->id()); try { $plugin->runSensor($result); } catch (\Exception $e) { @@ -180,7 +180,7 @@ class SensorRunner { // backtrace as part of the sensor verbose output. } - $timer = Timer::stop($sensor_config->getName()); + $timer = Timer::stop($sensor_config->id()); $result->setExecutionTime($timer['time']); // Capture verbose output if requested and if we are able to do so. @@ -216,7 +216,7 @@ class SensorRunner { $old_status = NULL; // Try to load the previous log result for this sensor. - if ($last_result = monitoring_sensor_result_last($result->getSensorName())) { + if ($last_result = monitoring_sensor_result_last($result->getSensorId())) { $old_status = $last_result->sensor_status->value; } @@ -267,7 +267,7 @@ class SensorRunner { $definition = $result->getSensorConfig(); if ($definition->getCachingTime() && !$result->isCached()) { $data = array( - 'name' => $result->getSensorName(), + 'name' => $result->getSensorId(), 'sensor_status' => $result->getStatus(), 'sensor_message' => $result->getMessage(), 'sensor_expected_value' => $result->getExpectedValue(), @@ -276,7 +276,7 @@ class SensorRunner { 'timestamp' => $result->getTimestamp(), ); $this->cache->set( - $this->getSensorCid($result->getSensorName()), + $this->getSensorCid($result->getSensorId()), $data, REQUEST_TIME + $definition->getCachingTime(), array('monitoring_sensor_result') @@ -297,8 +297,8 @@ class SensorRunner { protected function getResultObject(SensorConfig $sensor_config) { $result_class = '\Drupal\monitoring\Result\SensorResult'; - if (!$this->forceRun && isset($this->sensorResultCache[$sensor_config->getName()])) { - $result = new $result_class($sensor_config, $this->sensorResultCache[$sensor_config->getName()]); + if (!$this->forceRun && isset($this->sensorResultCache[$sensor_config->id()])) { + $result = new $result_class($sensor_config, $this->sensorResultCache[$sensor_config->id()]); } else { $result = new $result_class($sensor_config); diff --git a/src/Tests/MonitoringServicesTest.php b/src/Tests/MonitoringServicesTest.php index 57b8de8..fc8f3f0 100644 --- a/src/Tests/MonitoringServicesTest.php +++ b/src/Tests/MonitoringServicesTest.php @@ -78,7 +78,7 @@ class MonitoringServicesTest extends RESTTestBase { $this->assertResponse(200); foreach (monitoring_sensor_manager()->getAllSensorConfig() as $sensor_name => $sensor_config) { - $this->assertEqual($response_data[$sensor_name]['sensor'], $sensor_config->getName()); + $this->assertEqual($response_data[$sensor_name]['sensor'], $sensor_config->id()); $this->assertEqual($response_data[$sensor_name]['label'], $sensor_config->getLabel()); $this->assertEqual($response_data[$sensor_name]['category'], $sensor_config->getCategory()); $this->assertEqual($response_data[$sensor_name]['description'], $sensor_config->getDescription()); @@ -87,7 +87,7 @@ class MonitoringServicesTest extends RESTTestBase { $this->assertEqual($response_data[$sensor_name]['caching_time'], $sensor_config->getCachingTime()); $this->assertEqual($response_data[$sensor_name]['time_interval'], $sensor_config->getTimeIntervalValue()); $this->assertEqual($response_data[$sensor_name]['enabled'], $sensor_config->isEnabled()); - $this->assertEqual($response_data[$sensor_name]['uri'], Url::fromUri('base://monitoring-sensor-info/' . $sensor_config->getName(), array('absolute' => TRUE))->toString()); + $this->assertEqual($response_data[$sensor_name]['uri'], Url::fromUri('base://monitoring-sensor-info/' . $sensor_config->id(), array('absolute' => TRUE))->toString()); if ($sensor_config->isDefiningThresholds()) { $this->assertEqual($response_data[$sensor_name]['thresholds'], $sensor_config->getSetting('thresholds')); @@ -102,7 +102,7 @@ class MonitoringServicesTest extends RESTTestBase { $response_data = $this->doRequest('monitoring-sensor-info/' . $sensor_name); $this->assertResponse(200); $sensor_config = SensorConfig::load($sensor_name); - $this->assertEqual($response_data['sensor'], $sensor_config->getName()); + $this->assertEqual($response_data['sensor'], $sensor_config->id()); $this->assertEqual($response_data['label'], $sensor_config->getLabel()); $this->assertEqual($response_data['category'], $sensor_config->getCategory()); $this->assertEqual($response_data['description'], $sensor_config->getDescription()); @@ -111,7 +111,7 @@ class MonitoringServicesTest extends RESTTestBase { $this->assertEqual($response_data['caching_time'], $sensor_config->getCachingTime()); $this->assertEqual($response_data['time_interval'], $sensor_config->getTimeIntervalValue()); $this->assertEqual($response_data['enabled'], $sensor_config->isEnabled()); - $this->assertEqual($response_data['uri'], Url::fromUri('base://monitoring-sensor-info/' . $sensor_config->getName(), array('absolute' => TRUE))->toString()); + $this->assertEqual($response_data['uri'], Url::fromUri('base://monitoring-sensor-info/' . $sensor_config->id(), array('absolute' => TRUE))->toString()); if ($sensor_config->isDefiningThresholds()) { $this->assertEqual($response_data['thresholds'], $sensor_config->getSetting('thresholds')); @@ -176,16 +176,16 @@ class MonitoringServicesTest extends RESTTestBase { * Sensor config for which we have the result. */ protected function assertSensorResult($response_result, SensorConfig $sensor_config) { - $this->assertEqual($response_result['sensor_name'], $sensor_config->getName()); + $this->assertEqual($response_result['sensor_name'], $sensor_config->id()); // Test the uri - the hardcoded endpoint is defined in the // monitoring_test.default_services.inc. - $this->assertEqual($response_result['uri'], Url::fromUri('base://monitoring-sensor-result/' . $sensor_config->getName(), array('absolute' => TRUE))->toString()); + $this->assertEqual($response_result['uri'], Url::fromUri('base://monitoring-sensor-result/' . $sensor_config->id(), array('absolute' => TRUE))->toString()); // If the result is cached test also for the result values. In case of // result which is not cached we might not get the same values. if ($sensor_config->getCachingTime()) { // Cannot use $this->runSensor() as the cache needs to remain. - $result = monitoring_sensor_run($sensor_config->getName()); + $result = monitoring_sensor_run($sensor_config->id()); $this->assertEqual($response_result['status'], $result->getStatus()); $this->assertEqual($response_result['value'], $result->getValue()); $this->assertEqual($response_result['expected_value'], $result->getExpectedValue()); diff --git a/src/Tests/MonitoringUITest.php b/src/Tests/MonitoringUITest.php index 5bfecbe..32d910d 100644 --- a/src/Tests/MonitoringUITest.php +++ b/src/Tests/MonitoringUITest.php @@ -415,7 +415,7 @@ class MonitoringUITest extends MonitoringTestBase { $form_field_name = 'settings' . '[thresholds][' . $key . ']'; $data[$form_field_name] = $value; } - $this->drupalPostForm('admin/config/system/monitoring/sensors/' . $sensor_config->getName(), $data, t('Save')); + $this->drupalPostForm('admin/config/system/monitoring/sensors/' . $sensor_config->id(), $data, t('Save')); } /**