Notifications¶

A notification is a destination to send an alarm; it can be a variety of different types, and will evolve over time.

For instance, with a webhook type notification, Cloud Monitoring posts JSON formatted data to a user-specified URL on an alert condition (Check goes from OK -> CRITICAL and so on).

$notification = $service->getNotification('{id}');

$params = array(
    'label' => 'My webhook #1',
    'type'  => 'webhook',
    'details' => array(
        'url' => 'http://example.com'
    )
);

// Test it
$response = $notification->testParams($params);

if ($response->status == 'Success') {
    echo $response->message;
}

$notification->create($params);

$response = $notification->testExisting(true);
echo $response->debug_info;

$notifications = $service->getNotifications();

foreach ($notifications as $notification) {
    echo $notification->getId();
}

$notification->update(array(
    'label' => 'New notification label'
));

$notification->delete();

Notification types¶

Rackspace Cloud Monitoring currently supports the following notification types:

Industry-standard web hooks, where JSON is posted to a configurable URL. It has these attributes:

Email alerts where the message is delivered to a specified address. It has these attributes:

$type = $notification->getNotificationType();

$typeId = 'pagerduty';
$type = $service->getNotificationType($typeId);

$types = $service->getNotificationTypes();

foreach ($types as $type) {
    echo sprintf('%s %s', $type->getName(), $type->getDescription());
}

Notification plans¶

A notification plan contains a set of notification actions that Rackspace Cloud Monitoring executes when triggered by an alarm. Rackspace Cloud Monitoring currently supports webhook and email notifications.

Each notification state can contain multiple notification actions. For example, you can create a notification plan that hits a webhook/email to notify your operations team if a warning occurs. However, if the warning escalates to an Error, the notification plan could be configured to hit a different webhook/email that triggers both email and SMS messages to the operations team. The notification plan supports the following states:

• Critical
• Warning
• OK

A notification plan, npTechnicalContactsEmail, is provided by default which will email all of the technical contacts on file for an account whenever there is a state change.

$plan = $service->getNotificationPlan('{planId}');

$plan->create(array(
    'label'          => 'New Notification Plan',
    'critical_state' => array('ntAAAA'),
    'ok_state'       => array('ntBBBB'),
    'warning_state'  => array('ntCCCC')
));

$plan->update(array(
    'label' => 'New label for my plan'
));

$plan->delete();

Alarm Notification History¶

The monitoring service keeps a record of notifications sent for each alarm. This history is further subdivided by the check on which the notification occurred. Every attempt to send a notification is recorded, making this history a valuable tool in diagnosing issues with unreceived notifications, in addition to offering a means of viewing the history of an alarm’s statuses.

Alarm notification history is accessible as a Time Series Collection. By default alarm notification history is stored for 30 days and the API queries the last 7 days of information.

$entity = $service->getEntity('{entityId}');

$check = $entity->getCheck('{checkId}');

$alarm = $check->getAlarm('{alarmId}');

$checks = $alarm->getRecordedChecks();

$checkHistory = $alarm->getNotificationHistoryForCheck('chAAAA');

$checkId  = 'chAAAA';
$itemUuid = '646ac7b0-0b34-11e1-a0a1-0ff89fa2fa26';

$singleItem = $history->getNotificationHistoryItem($checkId, $itemUuid);