diff --git a/README.txt b/README.txt index 34224b7..ccd0d37 100644 --- a/README.txt +++ b/README.txt @@ -20,7 +20,7 @@ * * Watchdog * * Cron execution * * Content and User activity - * Sensor interface that can be easily implemented to provide custom sensors. + * SensorPlugin interface that can be easily implemented to provide custom sensors. * Integration with Munin. * Integration with Icinga/Nagios @@ -50,6 +50,6 @@ variable, for example in settings.php. This allows to enforce environment specific settings, like disabling a certain sensor. - $conf['monitoring_sensor_info']['name_of_the_sensor']['settings']['enabled'] = FALSE; + $conf['monitoring_sensor']['name_of_the_sensor']['settings']['enabled'] = FALSE; Anything defined through the hook can be overridden. diff --git a/config/install/views.view.monitoring_sensor_results.yml b/config/install/views.view.monitoring_sensor_results.yml index 77c8253..55f0c6e 100644 --- a/config/install/views.view.monitoring_sensor_results.yml +++ b/config/install/views.view.monitoring_sensor_results.yml @@ -87,7 +87,7 @@ display: relationship: none group_type: group admin_label: '' - label: 'Sensor name' + label: 'SensorPlugin name' exclude: false alter: alter_text: false diff --git a/config/schema/monitoring.schema.yml b/config/schema/monitoring.schema.yml index f6910fa..9068250 100644 --- a/config/schema/monitoring.schema.yml +++ b/config/schema/monitoring.schema.yml @@ -2,7 +2,7 @@ monitoring.sensor_config.*: type: config_entity - label: 'Monitoring Sensor' + label: 'Monitoring SensorPlugin' mapping: id: type: string @@ -18,7 +18,7 @@ monitoring.sensor_config.*: label: 'Category' sensor_id: type: string - label: 'Sensor ID' + label: 'SensorPlugin ID' result_class: type: string label: 'Result Class' @@ -40,7 +40,7 @@ monitoring.sensor_config.*: monitoring.settings.monitoring_git_dirty_tree: type: mapping - label: 'Sensor settings' + label: 'SensorPlugin settings' mapping: repo_path: type: string diff --git a/config/schema/monitoring.views.schema.yml b/config/schema/monitoring.views.schema.yml index fdd708a..77869af 100644 --- a/config/schema/monitoring.views.schema.yml +++ b/config/schema/monitoring.views.schema.yml @@ -2,4 +2,4 @@ views.field.monitoring_sensor_name: type: views_field - label: 'Sensor name' + label: 'SensorPlugin name' diff --git a/modules/demo/monitoring_demo.install b/modules/demo/monitoring_demo.install index 5b088a1..a0ee536 100644 --- a/modules/demo/monitoring_demo.install +++ b/modules/demo/monitoring_demo.install @@ -19,7 +19,7 @@ function monitoring_demo_install() { // Enable REST API for monitoring resources. $settings = array( - 'monitoring-sensor-info' => array( + 'monitoring-sensor' => array( 'GET' => array( 'supported_formats' => array('hal_json'), 'supported_auth' => array('cookie'), diff --git a/modules/demo/src/Controller/FrontPage.php b/modules/demo/src/Controller/FrontPage.php index 430e341..25e5e02 100644 --- a/modules/demo/src/Controller/FrontPage.php +++ b/modules/demo/src/Controller/FrontPage.php @@ -61,8 +61,8 @@ class FrontPage extends ControllerBase { 'list' => array( '#theme' => 'item_list', '#items' => array( - t('Drush integration - open up your console and type in # drush monitoring-info or # drush monitoring-run. See the drush help for more info and commands.'), - t('REST resource for both the info about sensors and running the sensors via the service. Open up your REST client and visit /monitoring-sensor-info/{sensor_name} and /monitoring-sensor-result/{sensor_name}'), + t('Drush integration - open up your console and type in # drush monitoring-sensor or # drush monitoring-run. See the drush help for more info and commands.'), + t('REST resource for both the info about sensors and running the sensors via the service. Open up your REST client and visit /monitoring-sensor/{sensor_name} and /monitoring-sensor-result/{sensor_name}'), ) ), ), diff --git a/modules/monitoring_icinga/monitoring_icinga.module b/modules/monitoring_icinga/monitoring_icinga.module index 7b93da3..a1082e9 100644 --- a/modules/monitoring_icinga/monitoring_icinga.module +++ b/modules/monitoring_icinga/monitoring_icinga.module @@ -44,7 +44,7 @@ function monitoring_icinga_menu() { * submitting passive check. * * @param SensorConfig $sensor_config - * Sensor config object. + * SensorPlugin config object. * * @return string * Icinga service description. diff --git a/modules/multigraph/src/Form/MultigraphForm.php b/modules/multigraph/src/Form/MultigraphForm.php index 72f0301..2af899a 100644 --- a/modules/multigraph/src/Form/MultigraphForm.php +++ b/modules/multigraph/src/Form/MultigraphForm.php @@ -220,7 +220,7 @@ class MultigraphForm extends EntityForm { if ($sensor_name = $form_state->getValue(array('sensor_add', 'sensor_add_select'))) { $sensor_label = \Drupal::entityManager()->getStorage('monitoring_sensor_config')->load($sensor_name)->getLabel(); $multigraph->addSensor($sensor_name); - drupal_set_message($this->t('Sensor "@sensor_label" added. You have unsaved changes.', array('@sensor_label' => $sensor_label)), 'warning'); + drupal_set_message($this->t('SensorPlugin "@sensor_label" added. You have unsaved changes.', array('@sensor_label' => $sensor_label)), 'warning'); } } diff --git a/modules/multigraph/src/Tests/MultigraphServicesTest.php b/modules/multigraph/src/Tests/MultigraphServicesTest.php index 7cc2ac8..9452124 100644 --- a/modules/multigraph/src/Tests/MultigraphServicesTest.php +++ b/modules/multigraph/src/Tests/MultigraphServicesTest.php @@ -87,7 +87,7 @@ class MultigraphServicesTest extends RESTTestBase { // Test response for non-existing multigraph. $name = 'multigraph_that_does_not_exist'; - $this->doRequest('monitoring-sensor-info/' . $name); + $this->doRequest('monitoring-sensor/' . $name); $this->assertResponse(404); // Test the predefined multigraph. diff --git a/modules/test/config/install/monitoring.sensor_config.test_sensor_info.yml b/modules/test/config/install/monitoring.sensor_config.test_sensor_info.yml index 62c7f63..c85868d 100644 --- a/modules/test/config/install/monitoring.sensor_config.test_sensor_info.yml +++ b/modules/test/config/install/monitoring.sensor_config.test_sensor_info.yml @@ -5,4 +5,3 @@ sensor_id: test_sensor value_type: 'number' value_label: 'Test label' settings: - diff --git a/modules/test/src/Plugin/monitoring/Sensor/TestSensor.php b/modules/test/src/Plugin/monitoring/SensorPlugin/TestSensorPlugin.php similarity index 85% rename from modules/test/src/Plugin/monitoring/Sensor/TestSensor.php rename to modules/test/src/Plugin/monitoring/SensorPlugin/TestSensorPlugin.php index 00b3a97..a6106c3 100644 --- a/modules/test/src/Plugin/monitoring/Sensor/TestSensor.php +++ b/modules/test/src/Plugin/monitoring/SensorPlugin/TestSensorPlugin.php @@ -1,28 +1,28 @@ 'Display verbose information.', 'force' => 'If the sensor execution should be forced in case cached result is available.', 'output' => 'The output format. Currently "table" and "json" available. Defaults to "table".', - 'expand' => 'Relevant only for the json output. Currently "sensor_info" value supported.', + 'expand' => 'Relevant only for the json output. Currently "sensor" value supported.', 'show-exec-time' => 'Relevant for the table output listing all results. Will expand the table with execution time info.' ), 'examples' => array( @@ -259,9 +259,10 @@ 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(); - if ($expand == 'sensor_info') { - $json_output[$result->getSensorName()]['sensor_info'] = $result->getSensorConfig()->toArray(); + $sensor_name = $result->getSensorName(); + $json_output[$sensor_name] = $result->toArray(); + if ($expand == 'sensor') { + $json_output[$sensor_name]['sensor'] = $result->getSensorConfig()->toArray(); } } drush_print(Json::encode($json_output)); diff --git a/monitoring.monitoring_sensors.inc b/monitoring.monitoring_sensors.inc index 59bd055..3be8bb4 100644 --- a/monitoring.monitoring_sensors.inc +++ b/monitoring.monitoring_sensors.inc @@ -4,23 +4,23 @@ * Define default sensors for core and contrib modules. * * Default sensors provide sensors for core and contrib modules with - * monitoring_MODULE_monitoring_sensor_info() + * monitoring_MODULE_monitoring_sensor() * * The default integration for MODULE is omitted if a module implements * hook_monitoring_sensor_info() on its own. * - * @see hook_monitoring_sensor_info() + * @see hook_monitoring_sensor() */ use Drupal\Component\Utility\String; /** - * Implements monitoring_MODULE_monitoring_sensor_info(). + * Implements monitoring_MODULE_monitoring_sensor(). * * @todo-Convert below sensors to config entities after these modules are ported in 8.x * Module: past_db */ -function monitoring_past_db_monitoring_sensor_info() { +function monitoring_past_db_monitoring_sensor() { $info = array(); $severities = monitoring_event_severities(); @@ -55,11 +55,11 @@ function monitoring_past_db_monitoring_sensor_info() { } /** - * Implements monitoring_MODULE_monitoring_sensor_info(). + * Implements monitoring_MODULE_monitoring_sensor(). * * Module: elysia_cron */ -function monitoring_elysia_cron_monitoring_sensor_info() { +function monitoring_elysia_cron_monitoring_sensor() { $info = array(); $result = db_select('elysia_cron', 'e')->fields('e', array('name'))->execute()->fetchAll(); @@ -97,11 +97,11 @@ function monitoring_elysia_cron_monitoring_sensor_info() { } /** - * Implements monitoring_MODULE_monitoring_sensor_info(). + * Implements monitoring_MODULE_monitoring_sensor(). * * Module: commerce_order */ -function monitoring_commerce_order_monitoring_sensor_info() { +function monitoring_commerce_order_monitoring_sensor() { $info = array(); // Expose a sensor for each order status, disabled by default. diff --git a/monitoring.routing.yml b/monitoring.routing.yml index ecc9e14..81ab879 100644 --- a/monitoring.routing.yml +++ b/monitoring.routing.yml @@ -25,14 +25,14 @@ monitoring.detail_form: monitoring.force_run_all: path: 'monitoring/sensors/force' defaults: - _controller: '\Drupal\monitoring\Controller\ForceRunController::forceRunAll' + _controller: '\Drupal\monitoring\Controller\SensorForceRunController::forceRunAll' requirements: _permission: 'monitoring force run' monitoring.force_run_sensor: path: 'monitoring/sensors/force/{monitoring_sensor_config}' defaults: - _controller: '\Drupal\monitoring\Controller\ForceRunController::forceRunSensor' + _controller: '\Drupal\monitoring\Controller\SensorForceRunController::forceRunSensor' requirements: _permission: 'monitoring force run' @@ -63,6 +63,6 @@ monitoring.sensor_add: monitoring.config_autocomplete: path: '/monitoring-config/autocomplete' defaults: - _controller: '\Drupal\monitoring\Controller\ConfigAutocompleteController::autocomplete' + _controller: '\Drupal\monitoring\Controller\SensorConfigAutocompleteController::autocomplete' requirements: _permission: 'administer monitoring' diff --git a/review.txt b/review.txt index 23c4918..916ece9 100644 --- a/review.txt +++ b/review.txt @@ -1,2 +1,2 @@ - Wondering if we should add a SensorConfig::getSensor() (factory to create a sensor based on getSensorClass()), to a) solve the type hint problem and b), support container service injection like plugins with the create() method. See ContainerFactory, you would just inline that logic. Advantage: Easier to convert to plugins later. -- the status message in CronLastRunAgeSensor is now almost duplicated due to the value type formatting, but that's an existing problem in 7.x. +- the status message in CronLastRunAgeSensorPlugin is now almost duplicated due to the value type formatting, but that's an existing problem in 7.x. diff --git a/src/Annotation/Sensor.php b/src/Annotation/SensorPlugin.php similarity index 79% rename from src/Annotation/Sensor.php rename to src/Annotation/SensorPlugin.php index 19e8660..f09637d 100644 --- a/src/Annotation/Sensor.php +++ b/src/Annotation/SensorPlugin.php @@ -2,7 +2,7 @@ /** * @file - * Contains \Drupal\monitoring\Annotation\Sensor. + * Contains \Drupal\monitoring\Annotation\SensorPlugin. */ namespace Drupal\monitoring\Annotation; @@ -10,11 +10,11 @@ namespace Drupal\monitoring\Annotation; use Drupal\Component\Annotation\Plugin; /** - * Defines Sensor annotation object for reference by Sensor Plugins. + * Defines SensorPlugin annotation object for reference by SensorPlugin Plugins. * * @Annotation */ -class Sensor extends Plugin { +class SensorPlugin extends Plugin { /** * The plugin ID. diff --git a/src/Controller/ConfigAutocompleteController.php b/src/Controller/SensorConfigAutocompleteController.php similarity index 80% rename from src/Controller/ConfigAutocompleteController.php rename to src/Controller/SensorConfigAutocompleteController.php index 4b87343..0a3cfc0 100644 --- a/src/Controller/ConfigAutocompleteController.php +++ b/src/Controller/SensorConfigAutocompleteController.php @@ -2,7 +2,7 @@ /** * @file - * Contains \Drupal\monitoring\Controller\ConfigAutocompleteController. + * Contains \Drupal\monitoring\Controller\SensorConfigAutocompleteController. */ namespace Drupal\monitoring\Controller; @@ -14,12 +14,12 @@ use Symfony\Component\HttpFoundation\JsonResponse; use Symfony\Component\HttpFoundation\Request; /** - * Returns autocomplete responses for config. + * Returns auto complete responses for config. */ -class ConfigAutocompleteController { +class SensorConfigAutocompleteController { /** - * Retrieves suggestions for config autocompletion. + * Retrieves suggestions for config auto completion. * * @param \Symfony\Component\HttpFoundation\Request $request * The current request. diff --git a/src/Controller/ForceRunController.php b/src/Controller/SensorForceRunController.php similarity index 97% rename from src/Controller/ForceRunController.php rename to src/Controller/SensorForceRunController.php index 257915a..8be792a 100644 --- a/src/Controller/ForceRunController.php +++ b/src/Controller/SensorForceRunController.php @@ -10,7 +10,7 @@ use Drupal\monitoring\SensorRunner; use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\HttpFoundation\RedirectResponse; -class ForceRunController extends ControllerBase { +class SensorForceRunController extends ControllerBase { /** * Stores the sensor manager. diff --git a/src/Controller/SensorList.php b/src/Controller/SensorList.php index 7510e49..fb4a2a0 100644 --- a/src/Controller/SensorList.php +++ b/src/Controller/SensorList.php @@ -4,6 +4,7 @@ namespace Drupal\monitoring\Controller; use Drupal\Component\Utility\Unicode; use Drupal\Core\Controller\ControllerBase; +use Drupal\monitoring\Entity\SensorConfig; use Drupal\monitoring\Result\SensorResultInterface; use Drupal\monitoring\Sensor\SensorManager; use Drupal\monitoring\SensorRunner; @@ -66,7 +67,7 @@ class SensorList extends ControllerBase { // Oldest sensor config. $oldest_sensor_config = NULL; - foreach ($this->sensorManager->getSensorConfigByCategories() as $category => $category_sensor_info) { + foreach ($this->sensorManager->getSensorConfigByCategories() as $category => $category_sensor_config) { // Category grouping row. $rows[] = array( @@ -79,7 +80,8 @@ class SensorList extends ControllerBase { ); $ok_row_count = 0; - foreach ($category_sensor_info as $sensor_name => $sensor_config) { + /** @var SensorConfig $sensor_config */ + foreach ($category_sensor_config as $sensor_name => $sensor_config) { if (!isset($results[$sensor_name])) { continue; } diff --git a/src/Entity/SensorConfig.php b/src/Entity/SensorConfig.php index 93bc990..85cd72c 100644 --- a/src/Entity/SensorConfig.php +++ b/src/Entity/SensorConfig.php @@ -14,6 +14,7 @@ use Drupal\Core\Entity\EntityStorageInterface; * Represents a sensor config entity class. * * @todo more + * * @ConfigEntityType( * id = "monitoring_sensor_config", * label = @Translation("Monitoring Sensor"), @@ -121,11 +122,11 @@ class SensorConfig extends ConfigEntityBase { public $status = TRUE; /** - * The sensor ID. + * Gets Sensor ID. * - * @var string + * @return string + * Sensor ID. */ - public function getName() { return $this->id; } @@ -155,10 +156,10 @@ class SensorConfig extends ConfigEntityBase { } /** - * Gets sensor class. + * Gets sensor plugin class. * * @return string - * Sensor class + * SensorPlugin class */ public function getSensorClass() { $definition = monitoring_sensor_manager()->getDefinition($this->sensor_id); @@ -168,11 +169,11 @@ class SensorConfig extends ConfigEntityBase { /** * Gets the sensor plugin. * - * @return \Drupal\monitoring\Sensor\SensorInterface + * @return \Drupal\monitoring\SensorPlugin\SensorPluginInterface * Instantiated sensor. */ public function getPlugin() { - $configuration = array('sensor_info' => $this); + $configuration = array('sensor_config' => $this); $sensor = monitoring_sensor_manager()->createInstance($this->sensor_id, $configuration); return $sensor; } @@ -341,7 +342,7 @@ class SensorConfig extends ConfigEntityBase { * @return bool */ public function isExtendedInfo() { - return in_array('Drupal\monitoring\Sensor\SensorExtendedInfoInterface', class_implements($this->getSensorClass())); + return in_array('Drupal\monitoring\SensorPlugin\ExtendedInfoSensorPluginInterface', class_implements($this->getSensorClass())); } /** @@ -350,7 +351,7 @@ class SensorConfig extends ConfigEntityBase { * @return bool */ public function isDefiningThresholds() { - return in_array('Drupal\monitoring\Sensor\ThresholdsSensorInterface', class_implements($this->getSensorClass())); + return in_array('Drupal\monitoring\SensorPlugin\ThresholdsSensorPluginInterface', class_implements($this->getSensorClass())); } /** @@ -383,6 +384,10 @@ class SensorConfig extends ConfigEntityBase { * {@inheritdoc} */ public static function sort(ConfigEntityInterface $a, ConfigEntityInterface $b) { + /** + * @var SensorConfig $a + * @var SensorConfig $b + */ // Checks whether both labels and categories are equal. if ($a->getLabel() == $b->getLabel() && $a->getCategory() == $b->getCategory()) { return 0; diff --git a/src/Entity/SensorResultEntity.php b/src/Entity/SensorResultEntity.php index 0e7d5fb..f206503 100644 --- a/src/Entity/SensorResultEntity.php +++ b/src/Entity/SensorResultEntity.php @@ -7,7 +7,6 @@ namespace Drupal\monitoring\Entity; use Drupal\Core\Entity\ContentEntityBase; -use Drupal\Core\Entity\EntityStorageInterface; use Drupal\Core\Entity\EntityTypeInterface; use Drupal\Core\Field\BaseFieldDefinition; diff --git a/src/Form/SensorDetailForm.php b/src/Form/SensorDetailForm.php index af6d8ef..3ae4429 100644 --- a/src/Form/SensorDetailForm.php +++ b/src/Form/SensorDetailForm.php @@ -79,7 +79,7 @@ class SensorDetailForm extends EntityForm { } if ($sensor_config->getDescription()) { - $form['sensor_info']['description'] = array( + $form['sensor_config']['description'] = array( '#type' => 'item', '#title' => $this->t('Description'), '#markup' => $sensor_config->getDescription(), @@ -87,7 +87,7 @@ class SensorDetailForm extends EntityForm { } if ($sensor_config->getCategory()) { - $form['sensor_info']['category'] = array( + $form['sensor_config']['category'] = array( '#type' => 'item', '#title' => $this->t('Category'), '#markup' => $sensor_config->getCategory(), diff --git a/src/Form/SensorForm.php b/src/Form/SensorForm.php index 28ae259..3871f46 100644 --- a/src/Form/SensorForm.php +++ b/src/Form/SensorForm.php @@ -10,8 +10,8 @@ use Drupal\Core\Entity\EntityForm; use Drupal\Core\Form\FormStateInterface; use Drupal\Core\Url; use Drupal\monitoring\Entity\SensorConfig; -use Drupal\monitoring\Sensor\SensorBase; -use Drupal\monitoring\Sensor\SensorInterface; +use Drupal\monitoring\SensorPlugin\SensorPluginBase; +use Drupal\monitoring\SensorPlugin\SensorPluginInterface; /** * Sensor settings form controller. @@ -121,6 +121,7 @@ class SensorForm extends EntityForm { ); } + $value_types = []; foreach (monitoring_value_types() as $value_type => $info) { $value_types[$value_type] = $info['label']; } @@ -142,7 +143,7 @@ class SensorForm extends EntityForm { ); if (isset($sensor_config->sensor_id) && $sensor = $sensor_config->getPlugin()) { - /** @var SensorBase $sensor */ + /** @var SensorPluginBase $sensor */ $form['settings'] = array( '#type' => 'details', '#open' => TRUE, @@ -200,10 +201,10 @@ class SensorForm extends EntityForm { /* @var SensorConfig $sensor_config */ $sensor_config = $this->entity; - /** @var SensorInterface $sensor */ + /** @var SensorPluginInterface $sensor */ if ($sensor_config->isNew()) { $plugin = $form_state->getValue('sensor_id'); - $sensor = monitoring_sensor_manager()->createInstance($plugin, array('sensor_info' => $this->entity)); + $sensor = monitoring_sensor_manager()->createInstance($plugin, array('sensor_config' => $this->entity)); } else { $sensor = $sensor_config->getPlugin(); @@ -220,7 +221,7 @@ class SensorForm extends EntityForm { /** @var SensorConfig $sensor_config */ $sensor_config = $this->entity; - /** @var SensorInterface $sensor */ + /** @var SensorPluginInterface $sensor */ $sensor = $sensor_config->getPlugin(); $sensor->submitConfigurationForm($form, $form_state); @@ -233,14 +234,14 @@ class SensorForm extends EntityForm { parent::save($form, $form_state); $form_state->setRedirectUrl(new Url('monitoring.sensors_overview_settings')); - drupal_set_message($this->t('Sensor settings saved.')); + drupal_set_message($this->t('SensorPlugin settings saved.')); } /** * Settings form page title callback. * * @param SensorConfig $monitoring_sensor_config - * The Sensor config. + * The SensorPlugin config. * * @return string */ diff --git a/src/Plugin/monitoring/Sensor/CommerceTurnoverSensor.php b/src/Plugin/monitoring/SensorPlugin/CommerceTurnoverSensorPlugin.php similarity index 93% rename from src/Plugin/monitoring/Sensor/CommerceTurnoverSensor.php rename to src/Plugin/monitoring/SensorPlugin/CommerceTurnoverSensorPlugin.php index 89d58c6..936c02c 100644 --- a/src/Plugin/monitoring/Sensor/CommerceTurnoverSensor.php +++ b/src/Plugin/monitoring/SensorPlugin/CommerceTurnoverSensorPlugin.php @@ -1,10 +1,11 @@ 'item', - '#title' => t('Sensor message'), + '#title' => t('SensorPlugin message'), '#markup' => $result->getMessage(), ); $form['clear_missing_sensors_wrapper']['clear_missing_sensor'] = array( diff --git a/src/Plugin/monitoring/Sensor/ElysiaCronSensor.php b/src/Plugin/monitoring/SensorPlugin/ElysiaCronSensorPlugin.php similarity index 80% rename from src/Plugin/monitoring/Sensor/ElysiaCronSensor.php rename to src/Plugin/monitoring/SensorPlugin/ElysiaCronSensorPlugin.php index 052fcd7..85f9643 100644 --- a/src/Plugin/monitoring/Sensor/ElysiaCronSensor.php +++ b/src/Plugin/monitoring/SensorPlugin/ElysiaCronSensorPlugin.php @@ -1,18 +1,18 @@ getEntityType(); if (!$entity_type_id) { - throw new \Exception(String::format('Sensor @id is missing the required entity_type setting.', array('@id' => $this->id()))); + throw new \Exception(String::format('SensorPlugin @id is missing the required entity_type setting.', array('@id' => $this->id()))); } $entity_type = $this->entityManager->getDefinition($entity_type_id); $this->addDependency('module', $entity_type->getProvider()); diff --git a/src/Plugin/monitoring/Sensor/GitDirtyTreeSensor.php b/src/Plugin/monitoring/SensorPlugin/GitDirtyTreeSensorPlugin.php similarity index 81% rename from src/Plugin/monitoring/Sensor/GitDirtyTreeSensor.php rename to src/Plugin/monitoring/SensorPlugin/GitDirtyTreeSensorPlugin.php index c6e0d69..09c6b04 100644 --- a/src/Plugin/monitoring/Sensor/GitDirtyTreeSensor.php +++ b/src/Plugin/monitoring/SensorPlugin/GitDirtyTreeSensorPlugin.php @@ -1,19 +1,19 @@ getMessage(), $e); } $response = $sensor_config->getDefinition(); - $response['uri'] = \Drupal::request()->getUriForPath('/monitoring-sensor-info/' . $sensor_name); + $response['uri'] = \Drupal::request()->getUriForPath('/monitoring-sensor/' . $sensor_name); return new ResourceResponse($response); } $list = array(); foreach ($this->sensorManager->getAllSensorConfig() as $sensor_name => $sensor_config) { $list[$sensor_name] = $sensor_config->getDefinition(); - $list[$sensor_name]['uri'] = \Drupal::request()->getUriForPath('/monitoring-sensor-info/' . $sensor_name); + $list[$sensor_name]['uri'] = \Drupal::request()->getUriForPath('/monitoring-sensor/' . $sensor_name); } return new ResourceResponse($list); } diff --git a/src/Plugin/rest/resource/MonitoringSensorResultResource.php b/src/Plugin/rest/resource/MonitoringSensorResultResource.php index ca069a7..9a7993c 100644 --- a/src/Plugin/rest/resource/MonitoringSensorResultResource.php +++ b/src/Plugin/rest/resource/MonitoringSensorResultResource.php @@ -112,8 +112,8 @@ class MonitoringSensorResultResource extends ResourceBase { $result = $this->sensorRunner->runSensors($sensor_config); $response = $result[$sensor_name]->toArray(); $response['uri'] = $request->getUriForPath('/monitoring-sensor-result/' . $sensor_name); - if ($request->get('expand') == 'sensor_info') { - $response['sensor_info'] = $result[$sensor_name]->getSensorConfig()->toArray(); + if ($request->get('expand') == 'sensor') { + $response['sensor'] = $result[$sensor_name]->getSensorConfig()->toArray(); } return new ResourceResponse($response); } @@ -129,8 +129,8 @@ class MonitoringSensorResultResource extends ResourceBase { foreach ($this->sensorRunner->runSensors() as $sensor_name => $result) { $list[$sensor_name] = $result->toArray(); $list[$sensor_name]['uri'] = $request->getUriForPath('/monitoring-sensor-result/' . $sensor_name); - if ($request->get('expand') == 'sensor_info') { - $list[$sensor_name]['sensor_info'] = $result->getSensorConfig()->toArray(); + if ($request->get('expand') == 'sensor') { + $list[$sensor_name]['sensor'] = $result->getSensorConfig()->toArray(); } } return new ResourceResponse($list); diff --git a/src/Result/SensorResult.php b/src/Result/SensorResult.php index 10fbbb9..3a11aad 100644 --- a/src/Result/SensorResult.php +++ b/src/Result/SensorResult.php @@ -501,5 +501,4 @@ class SensorResult implements SensorResultInterface { return $this->verboseOutput; } - } diff --git a/src/Result/SensorResultInterface.php b/src/Result/SensorResultInterface.php index 8cfb749..24f4486 100644 --- a/src/Result/SensorResultInterface.php +++ b/src/Result/SensorResultInterface.php @@ -120,7 +120,7 @@ interface SensorResultInterface { * * If the status is STATUS_UNKNOWN, this will attempt to set the status * based on expected value and threshold configurations. See - * \Drupal\monitoring\Sensor\SensorInterface::runSensor() for details. + * \Drupal\monitoring\SensorPlugin\SensorPluginInterface::runSensor() for details. * * @throws \Drupal\monitoring\Sensor\SensorCompilationException * Thrown if an error occurs during the sensor result compilation. @@ -187,7 +187,7 @@ interface SensorResultInterface { * Sets sensor execution time in ms. * * @param float $time - * Sensor execution time in ms + * Sensor execution time in ms. */ public function setExecutionTime($time); diff --git a/src/Sensor/SensorManager.php b/src/Sensor/SensorManager.php index 86008a4..957f789 100644 --- a/src/Sensor/SensorManager.php +++ b/src/Sensor/SensorManager.php @@ -6,11 +6,9 @@ namespace Drupal\monitoring\Sensor; -use Drupal\Component\Utility\NestedArray; use Drupal\Component\Utility\String; use Drupal\Core\Config\ConfigFactoryInterface; use Drupal\Core\Extension\ModuleHandlerInterface; -use Drupal\monitoring\SensorRunner; use Drupal\Core\Plugin\DefaultPluginManager; use Drupal\Core\Cache\CacheBackendInterface; use Drupal\monitoring\Entity\SensorConfig; @@ -56,7 +54,7 @@ class SensorManager extends DefaultPluginManager { * The module handler to invoke the alter hook with. */ function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, ConfigFactoryInterface $config) { - parent::__construct('Plugin/monitoring/Sensor', $namespaces, $module_handler, '\Drupal\monitoring\Sensor\SensorInterface', 'Drupal\monitoring\Annotation\Sensor'); + parent::__construct('Plugin/monitoring/SensorPlugin', $namespaces, $module_handler, '\Drupal\monitoring\SensorPlugin\SensorPluginInterface', 'Drupal\monitoring\Annotation\SensorPlugin'); $this->alterInfo('block'); $this->setCacheBackend($cache_backend, 'monitoring_sensor_plugins'); $this->config = $config; @@ -66,13 +64,14 @@ class SensorManager extends DefaultPluginManager { * {@inheritdoc} */ public function createInstance($plugin_id, array $configuration = array()) { - // Configuration contains sensor_info object. Extracting + // Configuration contains sensor_config object. Extracting // it to use for sensor object creation. - $sensor_config = $configuration['sensor_info']; + $sensor_config = $configuration['sensor_config']; $definition = $this->getDefinition($plugin_id); - // Sensor class from the sensor definition. + // SensorPlugin class from the sensor definition. + /** @var SensorPluginInterface $class */ $class = $definition['class']; - // Creating instance of the sensor. Refer Sensor.php for arguments. + // Creating instance of the sensor. Refer SensorPlugin.php for arguments. return $class::create(\Drupal::getContainer(), $sensor_config, $plugin_id, $definition); } @@ -137,7 +136,7 @@ class SensorManager extends DefaultPluginManager { * @param bool $enabled * Sensor isEnabled flag. * - * @return \Drupal\monitoring\Entity\SensorConfig[] + * @return \Drupal\monitoring\Entity\SensorConfig[][] * Sensor config. */ public function getSensorConfigByCategories($enabled = TRUE) { diff --git a/src/Sensor/ThresholdsSensorInterface.php b/src/Sensor/ThresholdsSensorInterface.php deleted file mode 100644 index ea82c48..0000000 --- a/src/Sensor/ThresholdsSensorInterface.php +++ /dev/null @@ -1,16 +0,0 @@ - 'fieldset', - '#title' => t('Sensor thresholds'), + '#title' => t('SensorPlugin thresholds'), '#description' => t('Here you can set limit values that switch the sensor to a given status.'), '#prefix' => '
', '#suffix' => '
', diff --git a/src/SensorPlugin/ThresholdsSensorPluginInterface.php b/src/SensorPlugin/ThresholdsSensorPluginInterface.php new file mode 100644 index 0000000..7a19e92 --- /dev/null +++ b/src/SensorPlugin/ThresholdsSensorPluginInterface.php @@ -0,0 +1,16 @@ +verbose && $sensor_config->isExtendedInfo()) { + /** @var ExtendedInfoSensorPluginInterface $sensor */ $result->setVerboseOutput($sensor->resultVerbose($result)); } @@ -243,7 +244,6 @@ class SensorRunner { protected function needsLogging($result, $old_status = NULL, $new_status = NULL) { $log_activity = $result->getSensorConfig()->getSetting('result_logging', FALSE); - // We log if requested or on status change. if ($this->config->get('sensor_call_logging') == 'on_request') { return $log_activity || ($old_status != $new_status); diff --git a/src/Tests/MonitoringApiTest.php b/src/Tests/MonitoringApiTest.php index f928eec..496ce21 100644 --- a/src/Tests/MonitoringApiTest.php +++ b/src/Tests/MonitoringApiTest.php @@ -1,7 +1,7 @@ value_type = 'bool'; $sensor_config->save(); - $value_types = monitoring_value_types(); $this->assertEqual($sensor_config->getValueLabel(), NULL); $this->assertFalse($sensor_config->isNumeric()); $this->assertTrue($sensor_config->isBool()); diff --git a/src/Tests/MonitoringCoreTest.php b/src/Tests/MonitoringCoreTest.php index 16dff98..6232b5f 100644 --- a/src/Tests/MonitoringCoreTest.php +++ b/src/Tests/MonitoringCoreTest.php @@ -1,9 +1,10 @@ set('system.cron_last', REQUEST_TIME - $time_shift); @@ -94,7 +95,7 @@ class MonitoringCoreTest extends MonitoringTestBase { $result = $this->runSensor('core_queue_monitoring_test'); $this->assertEqual($result->getValue(), 2); - // ======= CoreRequirementsSensor tests ======= // + // ======= CoreRequirementsSensorPlugin tests ======= // // @todo - This should not be necessary after sensor requirements are updated. $sensor_config = SensorConfig::create(array( @@ -189,7 +190,7 @@ class MonitoringCoreTest extends MonitoringTestBase { $this->assertEqual($result->getValue(), 101); $this->assertTrue($result->isCritical()); - // ======= ImageMissingStyleSensor tests ======= // + // ======= ImageMissingStyleSensorPlugin tests ======= // $file = file_save_data($this->randomMachineName()); /** @var FileUsageInterface $usage */ @@ -232,7 +233,7 @@ class MonitoringCoreTest extends MonitoringTestBase { $result = $this->runSensor('dblog_event_severity_' . $severities[RfcLogLevel::ALERT]); $this->assertEqual($result->getValue(), 1); - // ======= UserFailedLoginsSensor tests ======= // + // ======= UserFailedLoginsSensorPlugin tests ======= // \Drupal::logger('user')->notice('Login attempt failed for %user.', array('%user' => 'user1')); \Drupal::logger('user')->notice('Login attempt failed for %user.', array('%user' => 'user1')); @@ -243,7 +244,7 @@ class MonitoringCoreTest extends MonitoringTestBase { $this->assertTrue(strpos($result->getMessage(), 'user1: 2') !== FALSE); $this->assertTrue(strpos($result->getMessage(), 'user2: 1') !== FALSE); - // ======= Sensor user_session_logouts tests ======= // + // ======= SensorPlugin user_session_logouts tests ======= // \Drupal::logger('user')->notice('Session closed for %name.', array('%user' => 'user1')); \Drupal::logger('user')->notice('Session closed for %name.', array('%user' => 'user1')); @@ -253,7 +254,7 @@ class MonitoringCoreTest extends MonitoringTestBase { $this->assertEqual($result->getValue(), 3); $this->assertEqual($result->getMessage(), '3 logouts in 1 day'); - // ======= GitDirtyTreeSensor tests ======= // + // ======= GitDirtyTreeSensorPlugin tests ======= // // Enable the sensor and set cmd to output something $sensor_config = SensorConfig::load('monitoring_git_dirty_tree'); @@ -325,9 +326,9 @@ class MonitoringCoreTest extends MonitoringTestBase { } /** - * Tests for DisappearedSensorsSensor. + * Tests for DisappearedSensorsSensorPlugin. * - * We provide a separate test method for the DisappearedSensorsSensor as we + * We provide a separate test method for the DisappearedSensorsSensorPlugin as we * need to enable and disable additional modules. */ public function testSensorDisappearedSensors() { @@ -492,7 +493,7 @@ class MonitoringCoreTest extends MonitoringTestBase { } /** - * Test cases for EnabledModulesSensor sensor. + * Test cases for EnabledModulesSensorPlugin sensor. * * We use separate test method as we need to enable/disable modules. */ diff --git a/src/Tests/MonitoringServicesTest.php b/src/Tests/MonitoringServicesTest.php index 9b8040e..0215ca1 100644 --- a/src/Tests/MonitoringServicesTest.php +++ b/src/Tests/MonitoringServicesTest.php @@ -1,7 +1,7 @@ array( + 'monitoring-sensor' => array( 'GET' => array( 'supported_formats' => array($this->defaultFormat), 'supported_auth' => $this->defaultAuth, @@ -65,7 +65,7 @@ class MonitoringServicesTest extends RESTTestBase { $config->save(); $this->rebuildCache(); - $this->servicesAccount = $this->drupalCreateUser(array('restful get monitoring-sensor-info', 'restful get monitoring-sensor-result')); + $this->servicesAccount = $this->drupalCreateUser(array('restful get monitoring-sensor', 'restful get monitoring-sensor-result')); } /** @@ -74,7 +74,7 @@ class MonitoringServicesTest extends RESTTestBase { public function testSensorConfig() { $this->drupalLogin($this->servicesAccount); - $response_data = $this->doRequest('monitoring-sensor-info'); + $response_data = $this->doRequest('monitoring-sensor'); $this->assertResponse(200); foreach (monitoring_sensor_manager()->getAllSensorConfig() as $sensor_name => $sensor_config) { @@ -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/' . $sensor_config->getName(), array('absolute' => TRUE))->toString()); if ($sensor_config->isDefiningThresholds()) { $this->assertEqual($response_data[$sensor_name]['thresholds'], $sensor_config->getSetting('thresholds')); @@ -95,11 +95,11 @@ class MonitoringServicesTest extends RESTTestBase { } $sensor_name = 'sensor_that_does_not_exist'; - $this->doRequest('monitoring-sensor-info/' . $sensor_name); + $this->doRequest('monitoring-sensor/' . $sensor_name); $this->assertResponse(404); $sensor_name = 'dblog_event_severity_error'; - $response_data = $this->doRequest('monitoring-sensor-info/' . $sensor_name); + $response_data = $this->doRequest('monitoring-sensor/' . $sensor_name); $this->assertResponse(200); $sensor_config = SensorConfig::load($sensor_name); $this->assertEqual($response_data['sensor'], $sensor_config->getName()); @@ -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/' . $sensor_config->getName(), array('absolute' => TRUE))->toString()); if ($sensor_config->isDefiningThresholds()) { $this->assertEqual($response_data['thresholds'], $sensor_config->getSetting('thresholds')); @@ -125,10 +125,10 @@ class MonitoringServicesTest extends RESTTestBase { $this->drupalLogin($this->servicesAccount); // Test request for sensor results with expanded sensor config. - $response_data = $this->doRequest('monitoring-sensor-result', array('expand' => 'sensor_info')); + $response_data = $this->doRequest('monitoring-sensor-result', array('expand' => 'sensor')); $this->assertResponse(200); foreach (monitoring_sensor_manager()->getEnabledSensorConfig() as $sensor_name => $sensor_config) { - $this->assertTrue(isset($response_data[$sensor_name]['sensor_info'])); + $this->assertTrue(isset($response_data[$sensor_name]['sensor'])); $this->assertSensorResult($response_data[$sensor_name], $sensor_config); } @@ -137,7 +137,7 @@ class MonitoringServicesTest extends RESTTestBase { $response_data = $this->doRequest('monitoring-sensor-result'); $this->assertResponse(200); $sensor_result = reset($response_data); - $this->assertTrue(!isset($sensor_result['sensor_info'])); + $this->assertTrue(!isset($sensor_result['sensor'])); // Make sure the response contains expected count of results. $this->assertEqual(count($response_data), count(monitoring_sensor_manager()->getEnabledSensorConfig())); @@ -154,17 +154,17 @@ class MonitoringServicesTest extends RESTTestBase { $this->assertResponse(404); $sensor_name = 'dblog_event_severity_error'; - $response_data = $this->doRequest('monitoring-sensor-result/' . $sensor_name, array('expand' => 'sensor_info')); + $response_data = $this->doRequest('monitoring-sensor-result/' . $sensor_name, array('expand' => 'sensor')); $this->assertResponse(200); - // The response must contain the sensor_info. - $this->assertTrue(isset($response_data['sensor_info'])); + // The response must contain the sensor_config. + $this->assertTrue(isset($response_data['sensor'])); $this->assertSensorResult($response_data, SensorConfig::load($sensor_name)); // Try a request without expanding the sensor config and check that it is not // present. $response_data = $this->doRequest('monitoring-sensor-result/' . $sensor_name); $this->assertResponse(200); - $this->assertTrue(!isset($response_data['sensor_info'])); + $this->assertTrue(!isset($response_data['sensor'])); } /** @@ -173,7 +173,7 @@ class MonitoringServicesTest extends RESTTestBase { * @param array $response_result * Result received via response. * @param \Drupal\monitoring\Entity\SensorConfig $sensor_config - * Sensor config for which we have the result. + * SensorPlugin config for which we have the result. */ protected function assertSensorResult($response_result, SensorConfig $sensor_config) { $this->assertEqual($response_result['sensor_name'], $sensor_config->getName()); @@ -195,8 +195,8 @@ class MonitoringServicesTest extends RESTTestBase { $this->assertEqual($response_result['execution_time'], $result->getExecutionTime()); } - if (isset($response_result['sensor_info'])) { - $this->assertEqual($response_result['sensor_info'], $sensor_config->toArray()); + if (isset($response_result['sensor'])) { + $this->assertEqual($response_result['sensor'], $sensor_config->toArray()); } } diff --git a/src/Tests/MonitoringUITest.php b/src/Tests/MonitoringUITest.php index 33bd380..5bfecbe 100644 --- a/src/Tests/MonitoringUITest.php +++ b/src/Tests/MonitoringUITest.php @@ -1,14 +1,13 @@