Overview | Index | Help
| Sonic Management API

## Notifications Overview

This documentation describes the notifications exposed by components managed within the Sonic Management environment.

- Introduction - introduction to notifications and the information they contain.
- Threshold Alert Notifications - description of threshold alert notifications.

The following components expose notifications:

- SonicMQ Broker
- Agent
- Agent Manager
- Activation Daemon
- Collections Monitor
- Directory Service

See Also:
  Metrics

Introduction

A notification encapsulates information about a significant event that has occured during the execution of a container or a component. The notification includes:

- The notification type
- The source of the notification
- The time the notification was generated
- Attributes that describe details about the event that generated the notification

Notifications are received by management clients once they have subscribed to them on a particular component. Notification subscription and viewing can be performed through:

- The Sonic Management Console described in the SonicMQ Configuration and Management Guide.
- The Sonic Management Application API and the Sonic Administrative Programming Guide.

Notifications are classified into trees of related types. Each notification's path in the tree is represented using a list of strings, where each token describes a branch or leaf. The canonical form of the path is displayed as a period '.' delimited list, e.g. "system.state.Online".

Threshold Alert Notifications

Certain metrics allow thresholds to be defined for the purpose of asynchronous notification when those thresholds are exceeded. Which metrics allow thresholds to be specified is documented in a particular component type's documentation, e.g. the SonicMQ broker allows thresholds to be specified for the messages delivered to a particular connection identity.

The term used for the notification generated as a result of a threshold having been exceeded is an alert notification. Alert notifications are named based on their source metric (e.g. application.alert.connection.messages.ReceivedPerSecond for the example above) and encapsulate the actual value of the metric and the time the threshold was exceeded.

Where thresholds are allowed, multiple threshold values may be specified. Additionally some metrics allow for both high and low thresholds to be defined.

Overview | Index | Help
| Sonic Management API

Copyright © 2002-2013 Aurea, Inc. All Rights Reserved.