Application Monitoring for your Website

• how many active users you have right now?
• how much content has been created today?
• how much money you made in your shop today?
• how many users are currently in the payment checkout step?
• how much of your content is not yet indexed?

• Manages a set of sensors
• Provides an API for running them
• Display the results ...
• in the UI
• as a service
• with drush
• in your monitoring product
• Sensor configuration
• Logging

• Status (OK, Warning, Critical, ...)
• Value
• Message
• Expected value
• Execution time
• Caching information

1. A class that implements SensorInterface
   
2. A definition in hook_monitoring_sensor_info()

SensorInterface::run(SensorResultInterface $result)

The sensor manager is responsible for collecting information about sensors from hook implementations and manage their settings.

monitoring_sensor_manager()->getSensorInfo()monitoring_sensor_manager()->enableSensor($sensor_name)
monitoring_sensor_manager()->disableSensor($sensor_name)

• Caching
• Execution time
• Exception handling

monitoring_sensor_run($sensor_name)monitoring_sensor_run_multiple(array $sensor_names = array())

1. Explicitly set by the Sensor class
2. Does not match the expected value
3. Violates the configured threshold
1. Exceeds value
2. Falls below value
3. Outside of interval
4. Inside of interval

• Value
• Value label
• Value type
• Time interval
• Expected value
• Thresholds
• Message parts

[Value] [Label] in [Time Frame], expected [ExpectedValue], exceeds [Interval], [Message]

54 watchdog events in 1 Tag, exceeds 50, apple-touch-icon-precomposed.png

CHF 1337.50 in 1 Tag, falls below CHF 1500.00

• Recent new nodes (per node type)
• New comments

• Active sessions
  
• New users
• Logins and Logouts (dblog)
• Failed logins (dblog)

• Watchdog records per severity (dblog)
• Past records per severity
• 404 Not Found errors (dblog)
• Missing image styles (dblog)

• Turnover per enabled currency and overall
• Orders in a specific state

• Queue size per queue
  
• Module requirements
• Update status
• Last cron run
• Enabled modules
• Disappeared sensors
• Git dirty tree
• ...

• Search API index status
• Simplenews mail spool
• Elysia cron

/**
 * Implements hook_monitoring_sensor_info()
 */
function maillog_monitoring_sensor_info() {
  $info['maillog_records_count'] = array(
    'label' => 'Maillog records count',
    'sensor_class' => 'Drupal\...\Sensors\SensorDatabaseAggregator',
    'value_label' => 'Mail records',
    'settings' => array(      'category' => 'Mail',
      'table' => 'maillog',
      'time_interval_field' => 'sent_date',
      'time_interval_value' => 60 * 60 * 24,
    ),
  );

  return $info;
} 

  $info['core_maintenance_mode'] = array(
    'label' => 'Maintenance mode',
    'description' => 'Site maintenance mode',
    'sensor_class' => 'Drupal\...\Sensors\SensorVariable',
    'numeric' => FALSE,
    'value_type' => 'bool',
    'settings' => array(
      'variable_name' => 'maintenance_mode',
      'variable_value' => FALSE,
      'variable_default_value' => FALSE,
    ),
  ); 

• enabled
  Any sensor can be disabled, set to FALSE, to
  have a sensor disabled by default.
• caching_time
  Specifies how long a sensor result can be
  cached/is valid.
• time_interval_value
  The time interval the sensor is checking for.
  Used for the default sensor message, the
  database aggregator sensor also exposes
  it in the UI
• thresholds
  Specify the default threshold type and intervals

class SensorUserFailedLogins extends SensorDatabaseAggregator {

  /**
   * {@inheritdoc}
   */
  public function buildQuery() {
    $query = parent::buildQuery();
    $query->addField('watchdog', 'variables');
    $query->groupBy('watchdog.variables');
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  public function runSensor(SensorResultInterface $result) {
    $records_count = 0;

    foreach ($this->getQueryResult()->fetchAll() as $row) {
      $records_count += $row->records_count;
      $variables = unserialize($row->variables);
      $result->addStatusMessage('@user: @count', array('@user' => $variables['%user'], '@count' => $row->records_count));
    }

    $result->setValue($records_count);
  } 

class SensorQueue extends SensorThresholds {

  public function runSensor(SensorResultInterface $result) {
    $queue = \DrupalQueue::get($this->info->getSetting('queue'));
    $result->setValue($queue->numberOfItems());
  }
} 

class SensorSearchApi extends SensorThresholds {

  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']);
  }
}
        

• Integration with Icinga/Nagios
• Integration with Munin
• Services
• Drush

GET /monitoring/sensor-info/dblog_event_severity_error
GET /monitoring/sensor-result 

drush monitoring-run cron_core_last_run_agedrush monitoring-run --output=jsondrush monitoring-infodrush monitoring-enable <sensor>drush monitoring-disable <sensor>

foreach (monitoring_sensor_run_multiple() as $result) {
 print $result->getSensorName() . ": " . $result->getStatus();}