Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Alarms and Notifications

 

Generate Alarm Notifications

HealthBot generates alarms that indicate when specific KPI events occur on your devices. To receive HealthBot notifications for these KPI events, you must first configure a notification profile. Once configured, you can enable alarm notifications for specific device groups and network groups.

HealthBot supports the following notification delivery methods:

  • Web Hook

  • Slack

  • Kafka Publish

  • Microsoft Teams (HealthBot 2.1.0 and later)

  • Email (HealthBot 2.1.0 and later)

This section includes the following procedures:

Configure a Notification Profile

A notification profile defines the delivery method to use for sending notifications.

  1. Click the Settings > System option in the left-nav bar.
  2. Click the Notification tab on the left of the window. click the add notification button (+ Notification).
  3. Click the + Notification button
  4. In the Add Notification window that appears, configure the notification profile:

    Attributes

    Description

    Name

    Enter a name.

    Description

    (Optional) Enter a description.

    Notification Type

    Select a notification type:

    • Web Hook

    • Slack

    • Kafka Publish

    • Microsoft Teams (HeathBot 2.1.0 and later)

    • EMails (HeathBot 2.1.0 and later)

    Notification type attributes vary based on notification type selected. See below for details.

  5. Click Save and Deploy.

NOTIFICATION TYPE DETAILS

Web Hook

  • URLURL at which the Web Hook notification should be posted.
  • Username(Optional) Username for basic HTTP authentication.

  • Password(Optional) Password for basic HTTP authentication.

Slack

  • URLURL at which the Slack notification should be posted. Different from your Slack workspace URL. Go to https://slack.com/services/new/incoming-webhook and sign in to your Slack workspace to create a Slack API endpoint URL.

  • ChannelChannel on which the notification should be posted.

Kafka Publish

  • Bootstrap ServersAdd Kafka host:port pairs from the drop-down list to establish the initial connection to the Kafka cluster.
  • Topic(Optional) Name of the Kafka topic to which data will be published. By default, the Kafka topic naming convention for device group alarm notifications is device-group.device-id.topic.rule.trigger.

Depending on the authentication protocols being used, the required authentication parameters are as follows:

Protocol

Required Parameters

SASL/SSL

Username, password and certificate

SASL/Plaintext

Username and password

SSL

Certificate

Plaintext

None

  • UsernameUsername for SASL/SSL or SASL/plaintext authentication.
  • PasswordPassword for SASL/SSL or SASL/plaintext authentication.
  • CertificateKafka server’s CA certificate. Choose file from the drop-down list.
  • Upload CertificateLocation from where the Kafka server’s CA certificate will be uploaded. Click Choose files and navigate to the file location. File should be in Privacy Enhanced Mail (PEM) format.

Microsoft Teams

As of HealthBot 2.1.0, you can send HealthBot notifications to Microsoft Teams. Teams can provide a connector which you can add to HealthBot to enable the connection.

Configuration workflow:

  • In Teams, create a new connector set as an incoming webhook.

  • Copy the URL provided by Teams.

  • In HealthBot, configure a notification profile that sends to Microsoft Teams.

  • Apply the notification profile to a device group.

To configure MS Teams notifications:

  1. In Teams, select the desired channel and click the ellipsis (...).
  2. In the menu that appears, click Connectors.
  3. Use the Incoming Webhook option and click Configure.
  4. On the next page, click Create.
  5. Once the web hook is successfully created, copy the provided URL.
  6. In HealthBot, go to the Settings > System page select the Notification tab.
  7. Click the + Notification button.
  8. Configure the notification profile as follows:
    • Name - Enter a profile name.

    • Notification Type - select Microsoft Teams.

    • Channel - Paste the URL provided by the Teams UI above.

  9. Click Save and Deploy.
  10. Apply the notification profile to a device group or network group as shown in Enable Alarm Notifications for a Device Group or Network Group

EMails

As of HealthBot 2.1.0, you can send HealthBot notifications by email. By default, email notifications cover all running playbooks and rules for the device group or network group to which they are applied, however you can narrow the focus by selecting specific rules.

Note

HealthBot includes its own mail transfer agent (MTA), so no other mail server is required.

Configuration workflow:

  • In HealthBot, configure a notification profile that sends to email.

  • Apply the notification profile to a device group.

To configure email notifications:

  1. In HealthBot, go to the Settings > System page.
  2. Select the Notification tab and click the the + Notification button.
  3. Configure the notification profile as follows:
    • Name - Enter a profile name.

    • Notification Type - Select Emails.

    • Email Addresses - Enter an email address and click Add <email-address>; repeat for more email addresses.

    • (Optional) Rule filters - To narrow the scope of what triggers an email, define rule filters. Enter a filter and click Add <rule-filters>; repeat for more filters.

      • Format is topic/rule; can use regular expressions

      • Example: interface.statistics/check-interface-flaps sends notifications only for the rule check-interface-flaps.

      • Example: system.processes/.* , system.cpu/.* , and interface.statistics/.* sends notifications for all rules under the topics system.processes, system.cpu, and interface.statistics.

  4. Click Save and Deploy.
  5. Apply the notification profile to a device group or network group as shown in Enable Alarm Notifications for a Device Group or Network Group

Enable Alarm Notifications for a Device Group or Network Group

To enable alarm notifications for a device group or network group:

  1. For Device Groups, select the Configuration > Device Group page from the left-nav bar.

    For Network Groups, select the Configuration > Network page from the left-nav bar.

  2. Click the name of the device group or network group for which you want to enable alarm notifications.
  3. Click the Edit (Pencil) icon.
  4. Scroll down to the Notification section in the pop-up window and click the caret to expand that section.
  5. Select a destination for any alarm level (Major, Minor, or Normal) that you want. Notification can be sent to zero or more defined destinations for each alarm level.
  6. Click Save and Deploy.

Manage Alarms Using Alarm Manager

You can use the Alarm Manager feature to organize, track, and manage KPI event alarm notifications received from HealthBot devices. The Alarm Manager does not track alarms by default; it is populated based on which device groups or network groups are configured to send the notifications.

Viewing Alarms

To view the alarms report table, go to the Monitor > Alarms page in the left-nav bar. Note that Alarm Manager consolidates duplicate alarms into one table entry and provides a count of the number of duplicate alarms it has received.

The following table describes the alarms report table attributes.

Attributes

Description

Severity

Severity level of the alarm. Options include:

  • Major

  • Minor

  • Normal

Status

Management status of the alarm entry. Options are Open, Active, Shelved, Closed, and Ack. The statuses available in the Status pull-down menu in the top row of the table only include statuses of alarms visible in the table and those allowed by the status filter above the table.

Last Received

Time the alarm was last received.

Dupl.

Duplicate count. Number of times an alarm with the same event, resource, environment, and severity has been triggered.

Topic

Device component topic name.

Resource

Device name.

Event

Name of the rule, trigger or field, and event with which the alarm is associated.

Text

Health status message.

The following table describes the main features of the alarms report table:

Feature

Description

Sort the data by ascending or descending order based on a specific attribute.

Click on the name of the data type at the top of the column by which you want to sort.

Filter the data based on the device group.

In the drop-down list at the top left corner of the page, select a device group by which to filter.

Filter the data based on the alarm status.

Two options:

  1. In the drop-down list above the table at the top of the page, select one or more status types on which to filter. Options are open, active, shelved, closed, and ack. You can filter on multiple status types.

  2. In the drop-down list at the top of the Status column, select a status type by which to filter. Note that if there are status types shown in the filter list at the top of the report, then the status column can only show those status types.

Filter the data based on the severity, topic, or resource

In the associated drop-down list for each attribute at the top of the table, select an option by which to filter.

Filter the data based on a keyword.

In the associated text box under the Event or Text attribute name at the top of the table, enter the keyword on which to filter.

Filter the data based on date or time received.

In the Last Received field, enter a date and time in the format: <Day> <DD> <Mon> <HH:MM>

Navigate to a different page of the table.

Two options:

  1. At the bottom of the table, click the Previous or Next buttons.

  2. At the bottom of the table, select the page number using the up/down arrows (or by manually entering the number) and then press Enter.

Change the number of rows displayed.

At the bottom of the table, choose the number of rows to display in the drop-down list. The table displays 20 rows by default.

If the data in a cell is truncated, view all of the data in a cell.

Resize the column width of the cell by dragging the right side of the title cell of the column to the right.

Manage Individual Alarms

You can view detailed information about each alarm in the alarms report table. You can also assign a management status (such as open, ack, and close), and apply simple actions (such as shelve and delete) to each alarm.

To manage individual alarms:

  1. Go to the Monitor > Alarms page from the left-nav bar to open the alarms report table.

  2. Click on a single alarm entry in the table. The Alarm Details pane displays detailed information about the alarm.

The following table describes the set of buttons at the top of the Alarm Details pane:

Button

Description

Open

Changes the status of the alarm to Open.

Shelve

Removes the alarm from the table for a set amount of time. Time options are 1, 2, 4 and 8 hours. Click Unshelve to disable this feature.

Ack

Changes the status of the alarm to Ack. The Ack status removes the alarm from the table, but the alarm still remains active.

Close

Changes the status of the alarm to Closed. The Closed status indicates that the severity level of the alarm is now Normal.

Delete

Deletes the alarm from the table.

Configure Alarm Blackouts

You can configure blackout periods to suppress or mute alarms during, for example, scheduled downtimes.

To configure blackouts:

  1. Click the Settings > System page from the left-nav bar.

  2. Select the Alarm tab on the left side of the page.

  3. In Alarm Blackout Settings, click the + Alarm Blackout button.

  4. Enter the necessary values in the text boxes for the blackout configuration.

    The following table describes the attributes in the Add an Alarm Blackout pane:

    Attributes

    Description

    Duration

    Select a start and end date and time for the blackout.

    Device Group

    Select a device group from the drop-down list to which to apply the blackout configuration.

    Attribute

    (Optional) Specify an attribute from the drop-down list to which to apply the blackout configuration.

    Value

    (Optional) If a blackout attribute is specified, provide an associated value (as shown in the alarms report table). Only the alarms that match this attribute value exactly will be suppressed from the alarms report table.

    Note: For the Resource-Event attribute, you must specify a resource from the drop-down list, as well as specify an Event value. Only the alarms generated by the specified resource that match this Event value exactly will be suppressed from the alarms report table.

  5. Click Save to save the configuration.

  6. (Optional) Click the Delete button to delete a blackout configuration.

Stream Sensor and Field Data from HealthBot

You can configure HealthBot to publish HealthBot sensor and field data for a specific device group or network group. You must first configure the notification type for publishing and then specify the fields and sensors that you want published.

Configure the Notification Type for Publishing

HealthBot supports Apache Kafka for publishing sensor and field data. You must first configure a Kafka publishing profile before you can start publishing sensor and field data for a specific device group or network group.

To configure a Kafka publishing profile:

  1. Select the Settings > System page from the left-nav bar.
  2. Click the Notification tab on the left part of the page.
  3. In Notification Settings, click the + Notification button.
  4. Enter the necessary values in the text boxes and select the appropriate options for the Kafka publishing profile.

    The following table describes the relevant attributes in the Add a Notification Setting and Edit Notification Configuration panes:

    Attributes

    Description

    Name

    Name of the notification.

    Description

    (Optional) Description of the notification.

    Notification Type

    Click the Kafka publish radio button.

    Kafka Publish

    • Bootstrap ServersAdd Kafka host:port pairs from the drop-down list to establish the initial connection to the Kafka cluster.
    • Topic(Optional) Name of the Kafka topic to which data will be published. By default, the Kafka topic naming conventions are:
      • For device group field data, device-group.device-id.topic.rule.fields

      • For network group field data, network-group.topic.rule.fields

      • o For device group sensor data, device-group.device-id.sensors

    Depending on the authentication protocols being used, the required authentication parameters are as follows:

    Protocol

    Required Parameters

    SASL/SSL

    Username, password and certificate

    SASL/Plaintext

    Username and password

    SSL

    Certificate

    Plaintext

    None

    • UsernameUsername for SASL/SSL or SASL/plaintext authentication.
    • PasswordPassword for SASL/SSL or SASL/plaintext authentication.
    • CertificateKafka server’s CA certificate. Choose file from the drop-down list.
    • Upload CertificateLocation from where the Kafka server’s CA certificate will be uploaded. Click Choose files and navigate to the file location. File should be in Privacy Enhanced Mail (PEM) format.
  5. Click Save to save the configuration or click Save and Deploy to save and deploy the configuration.
  6. Apply the Kafka publishing profile to a device group or network group. For more details, see the Publish Data for a Device Group or Network Group section.

Publish Data for a Device Group or Network Group

To publish HealthBot sensor or field data for a device group or network group:

  1. Select the Configuration > Device Group page from the left-nav bar.
  2. Click the name of the device group to which you want to publish data.
  3. Click the Edit Device Group (Pencil) icon.
  4. Under Publish, select the appropriate Destinations, Field, or Sensor from the drop-down lists for the data you want to publish. To publish field or sensor data, you must configure a destination.

    Parameter

    Description

    Destinations

    Select the publishing profiles that define the notification type requirements (such as authentication parameters) for publishing the data.

    To edit or view details about saved publishing profiles, go to the System page under the Settings menu option in the left-nav bar. The publishing profiles are listed under Notification Settings.

    Note: Only Kafka publishing is currently supported.

    Field

    Select the HealthBot rule topic and rule name pairs that contain the field data you want to publish.

    Sensor

    (Device group only) Select the sensor paths or YAML tables that contain the sensor data you want to publish. No sensor data is published by default.

  5. Click Save to save the configuration or click Save and Deploy to save and deploy the configuration.
Release History Table
Release
Description
As of HealthBot 2.1.0, you can send HealthBot notifications by email.