Alarms

With “Alarms” ServisBOT provides live monitoring of Bot experiences with real time bot metrics & business goals. Metrics can be evaluated as frequently at 15 minutes or 1 hour intervals. A schedule can be set to cover each hour and day of the week. And when an alarm triggered, users subscribed to the alarm will be notified.

Alarms can be used for many use cases i.e.

  1. alarm when bot is being under used
  2. alarm when there is an anomaly in understanding (high level of missed input)
  3. alarm when a specific intent is trending abnormally high for the day of the week

Alarm Commands

It is possible to perform actions associated with alarms in the cli by using sb-cli alarm <command>. The possible commands are listed below.

sb-cli alarm create <json>                Creates an alarm from inline JSON or a file
                                          [aliases: c]

sb-cli alarm delete <alarm_id>            Deletes an alarm with the given alarm ID
                                          [aliases: d]

sb-cli alarm describe <alarm_id>          Describes an alarm with the given alarm ID
                                          [aliases: desc]

sb-cli alarm list [type]                  Lists all alarm ids, display names, and descriptions
                                          [aliases: l]

sb-cli alarm trigger-subscriptions        Triggers all the subscriptions for
<alarm_id>                                an alarm with the given alarm id, as if it had alarmed
                                          [aliases: trigger]
                                          
sb-cli alarm update <json>                Updates an alarm from inline JSON or a file 
                                          [aliases: u]

Examples

To create an alarm using the CLI command sb-cli alarm create <json> you must either create the alarm from an inline JSON, or enter the relevant file path. The JSON should be formatted as follows:

{
   "displayName": "exampleAlarm",                
   "enabled": true,                              
   "description": "my example alarm",            
   "projects": [{"name": "someProject"}],         
   "frequency": "15mins",                        
   "query": {
    "responsePath": "Conversation.Lifecycle.Engaged.Count",
    "resource": "BorrowerReceptionBot",
    "metricType": "BotMetrics"
  },                                  
   "scheduleConfig": {
        "timezone": "Europe/Dublin",
        "schedule": {
            "wednesday": {
                "9": {
                    "min": 0,
                    "max": 0
                },
                "10": {
                    "min": 0,
                    "max": 0
                }
            }
        }
    },                        
}

The table below describes which fields are required.

Field Required or Optional
displayName Required Human readable name, accepts spaces.
enabled Optional (default true) True or false
description Optional Internal values
projects Required A reference to a project in the same org that will be checked
frequency Required How often the alarm should run. hourly or 15mins. Make sure the schedule’s min and max data are appropriate for the data expected for your total period.
query Required Query run to check the alarm, only Conversation Engage calcutions are supported right now.
scheduleConfiq Required Schedule - an object containing the alarm schedule configuration.

ScheduleConfig

Each key in this object can be a day of the week in long form. Possible values are

  • ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’, ‘Saturday’, ‘Sunday’
  • Within each day of the week object you can define the hours for which you want the alarm to be processed.Possible values for hours are 0-23 where ‘0’ is midnight, and ‘23’ is 11pm.
  • You should not specify leading zeroes on hours below 10. For example, if you want to run an alarm at 3am you should specify ‘3’ and not ‘03’.
  • Within each hour object you can define statistic functions that should be run for this period. The possible statistic functions are as follows:
    • ‘Max’ - A number, which is checked against the metric value. If the metric value is greater than the defined max value the alarm will alert the subscribers.
    • ‘Min’ - A number, which is checked against the metric value. If the metric value is less than the defined min value the alarm will alert the subscribers.