Alert Messages

Overview

This is a reference page for the content of Highlight Alert messages, listing:

• Some sample alerts

• An explanation of the problem text contained in alerts

• An outline of fields available to include in alerts

• A list of stability issue codes

Sample email alerts

Bearer watch (with a description) - alert cleared - additional alert fields included

Subject : Bangkok - Amber alert cleared - description ( HSC1921-VLAN3-InterRtr )
[Note - Subject is made up of LocationName - Red/Amber alert raised/cleared - Report]
Time : 13:27 on March 03 2021
Time at location - string : 20:27 on March 03 2021 (UTC+07:00)
Folder : KFV Services » Regional Offices » AsiaPac » Bangkok
Report : description ( HSC1921-VLAN3-InterRtr )
Problem : Link-Availability - Amber alert cleared
Stability Issue Code 3 Characters : #OIU
Sitelinks Up :
Name : HSC1921-VLAN3-InterRtr
Device address : 192.168.102.9
Watch Type Name : Bearer
Reference :
URL : https://kfv-services.ad.highlight.net/portal/index.html#/details/landing/
49077/52993/%7b%22selectedDate%22%3a%222021-03-03%22%2c%22selectedPeriod%22%3a%22
day%22%2c%22timeZone%22%3a%22W%22%7d

Broadband Clarity watch (with a description) - alert raised - additional alert fields included

Subject : Broadband Clarity - Amber alert raised - FTTC 80/20 ( 164.39.207.21 )
Time : 08:48 on March 04 2021
Time at location - string : 08:48 on March 04 2021 (UTC+00:00)
Folder : KFV Services » Datacentre » Broadband Clarity
Report : FTTC 80/20 ( 164.39.207.21 )
Problem : Outbound-Traffic-Volume - Amber alert raised
Stability Issue Code 3 Characters :
Sitelinks Up :
Name : 164.39.207.21
Device address : 164.39.207.21
Watch Type Name : ADSL
Reference :
URL : https://kfv-services.ad.highlight.net/portal/index.html#/details/landing/52344/
53670/%7b%22selectedDate%22%3a%222021-03-04%22%2c%22selectedPeriod%22%3a%22day%22%2
c%22timeZone%22%3a%22W%22%7d
Before contacting your service provider, check if your site experienced a power outage 
or if you have scheduled maintenance occurring.

Cellular Clarity watch - alert raised - additional alert fields included

Subject : Cellular Clarity - Amber alert raised - CELL_Tertiary Circuit
Alert action ID(s) : 55752
Alert action name(s) : Cellular alert
Time : 09:45 on April 22 2021
Folder : KFV Services » Datacentre » Cellular Clarity
Name : CELL_Tertiary Circuit
Problem : Cellular-Signal-Strength-Below-Threshold - Amber alert raised
Cellular signal strength threshold (Score) : 3.5
Cellular signal strength (Score) : 3
Before contacting your service provider, check if your site experienced a power outage
or if you have scheduled maintenance occurring.

WiFi Access Point - alert raised

Subject : Wifi - Amber alert raised - 74ACB9B0FFEA
Time : 06:35 on February 19 2021
Folder : Root » KFV Services » Datacentre » Wifi
Location : Wifi
Report : 74ACB9B0FFEA
Problem : Link-Availability - Amber alert raised
Name : WAP_58191_74ACB9B0FFEA
Reference : 12345
AP Location :
Serial Number : 74ACB9B0FFEA
Url : https://demo.highlighter.net/portal/index.html#/details/landing/57850/58197/
%7b%22selectedDate%22%3a%222021-02-19%22%2c%22selectedPeriod%22%3a%22day%22%2c%22
timeZone%22%3a%22W%22%7d

WiFi Access Point - alert cleared

Subject : Wifi - Amber alert cleared - 74ACB9B0FFEA
Time : 06:50 on February 19 2021
Folder : Root » KFV Services » Datacentre » Wifi
Location : Wifi
Report : 74ACB9B0FFEA
Problem : Link-Availability - Amber alert cleared
Name : WAP_58191_74ACB9B0FFEA
Reference : 12345
AP Location :
Serial Number : 74ACB9B0FFEA
Url : https://demo.highlighter.net/portal/index.html#/details/landing/57850/58197/
%7b%22selectedDate%22%3a%222021-02-19%22%2c%22selectedPeriod%22%3a%22day%22%2c%22
timeZone%22%3a%22W%22%7d

Performance test - alert cleared

Subject : Sydney - Red alert cleared - ICMP Test from 62.173.68.110 to Core router
Time : 14:33 on January 19 2021
Folder : Regional Offices » AsiaPac » Sydney
Location : Sydney
Report : ICMP Test from 62.173.68.110 to Core router
Problem : Link-Availability - Red alert cleared
Name : PI_13164_13195
Reference : training
Url : https://demo.highlighter.net/portal/index.html#/details/landing/19767/19871/
%7b%22selectedDate%22%3a%222021-01-19%22%2c%22selectedPeriod%22%3a%22day%22%2c%22
timeZone%22%3a%22W%22%7d

Switch critical port monitoring - alert raised

Subject: LAN switches - Red alert raised - SPM_KFV_Cisco_2960_Core
Alert action ID(s) : 55732
Alert action name(s) : Alert on all
Time : 14:45 on June 07 2021
Folder : KFV Services » Datacentre » LAN switches
Problem : Link-Stability - Red alert raised
Stability Issue Code 3 Characters : #OIU
Name : SPM_KFV_Cisco_2960_Core
Device address : 192.168.100.4
URL : https://kfv-services.ad.highlight.net/portal/index.html#/details/landing/19739/
23300/%7b%22selectedDate%22%3a%222021-06-07%22%2c%22selectedPeriod%22%3a%22day%22%2c
%22timeZone%22%3a%22W%22%7d
Port Interface Name : GigabitEthernet1/0/12
Port Interface Description : Link to Desks
Critical Port : 12
Critical Slot : 1

Problem text in Alerts

Highlight alerts contain a Problem field which identifies which aspect of Highlight has triggered the alert.

This section contains the problem messages, and what part of Highlight triggered the alert (the "level 2" metric), and whether Stability, Load or Health is affected on the heat tile (the "level 3" metric).

Problem text	Cause	Affecting
Link-Availability	Link Health	Stability
Link-Stability	Link Health	Stability
Link-Availability	Wireless Access Point	Stability
Link-Availability	Performance Test	Stability
ApplicationFailure	Performance Test	Stability
Tunnel-Availability	SD-WAN Tunnel	Stability
Inbound-Traffic-Volume	Link Health	Load
Outbound-Traffic-Volume	Link Health	Load
Dormant-Inbound-Traffic	Link Health	Load
Dormant-Outbound-Traffic	Link Health	Load
Tunnel-Inbound-Traffic-Volume	SD-WAN Tunnel	Load
Tunnel-Outbound-Traffic-Volume	SD-WAN Tunnel	Load
Wireless Utilisation, 2.4GHz	Wireless Access Point	Load
Wireless Utilisation, 5GHz	Wireless Access Point	Load
Wireless Client Count	Wireless Access Point	Load
DeviceCPU	Link Health	Load
Received Line Errors	Link Health	Health
Outbound-Congestion	Link Health	Health
Wireless Congestion	Wireless Access Point	Health
Wireless Signal Strength	Wireless Access Point	Health
Delay-Exceeds-SLA*	Performance Test	Health
Delay-Exceeds-Threshold	Performance Test	Health
ApplicationQuality	Performance Test	Health
Link-Jitter	Performance Test	Health
Packet-Loss	Performance Test	Health
Broadband-Low-Speed	Broadband Clarity watch	Health
Cellular-Signal-Strength-Below-Threshold	Cellular Clarity watch	Health

*If the code {{ProblemTextReplacement}} is used in the customised alert, then Delay-Exceeds-SLA is replaced with Delay-Exceeds-Threshold

Alert generation

Note that each level 2 metric above can trigger an alert so for example you may get an alert when a heat tile goes red caused by Inbound Link utilisation, then another alert caused by Outbound Link utilisation even though the tile is already red. The tile colour represents the worst case of all level 2 metrics associated with it.

Fields available to include in an Alert Template

The text in Highlight email alerts is based on fields contained in an alert template, which is defined on a folder and inherited by its subfolders.

This section describes the available fields, and also notes if that field is included in our standard SNMP trap or webhook alert. Note: fields in webhooks may have a different name to those used in email alerts and webhook fields begin with a lower case, so the email field {{TimeStampUtc}} is equivalent to webhook field "timeStampUtc". Refer to a full list of webhook fields.

The text in alerts can be changed and additional text can be added. Contact us to alter your email alerts.

Field name	Description	Code	In email?	In trap?	In webhook?
Subject	The subject of the email: location - alert description - report	{{Subject}}	Yes		Yes - as "alertSummary"
Alert action IDs	The unique ID(s) for the alert action(s) which generated the alert, found on Status > Alerting and Reporting > Audit log	{{AlertIds}}	Yes		Yes
Alert Names	The name(s) for the alert action(s) which generated the alert, found on Status > Alerting	{{AlertNames}}	Yes		Yes
Alert Link	A shortcut to the alert action in Status > Alerting	{{AlertLinkUrl}}	Yes		Yes
Time - Highlight formatted	The UTC time the alert occurred formatted "HH:mm on Month Day Year"	{{TimeStampStringUtc}}	Yes
Time - machine formatted	The UTC time the alert occurred, uses local date format	{{TimeStampUtc}}	Yes	Yes (UTC and local)	Yes
Time - in the UK	The UK time the alert occurred, available in three codes	{{TimeStampUk}} {{TimeStampStringUk}} {{TimeStampStringUkWithOffset}}	Yes
Folder	The path to the parent folder of the location with the alert	{{Folder}}	Yes	Yes	Yes
Location	The name of the location where the watch exists	{{LocationName}}	Yes	Yes	Yes
Location Alert Time - Highlight formatted	The time the alert occurred in the watch location time formatted "HH:mm ''on'' MMMM dd yyyy (''UTC''zzzz)"	{{TimeStampStringLocation}}	Yes
Location Alert Time - machine formatted	The time the alert occurred in the watch location time, uses local date format	{{TimeStampAtWatchLocation}}	Yes		Yes
Report	The name of the watch If watch has a description, that is shown followed by watch name in brackets *See notes on classes, VLANs and performance tests	{{Report}}	Yes		Yes
Problem	What was affected (Stability/Load/Health), see previous section - Problem text in alerts - Amber/Red alert raised/cleared	{{Problem}}	Yes	Yes	Yes
Problem	Additional fields which provide details on the problem are listed below
Problem: Stability issue code	The issue code associated with Stability transitions (see next section - Stability issue codes)	{{StabilityIssueCode}}	Yes		Yes
Problem: Stability Issue Description	Webhook only	{{StabilityIssueDescription}}			Yes
Problem: Has Stability Issue	Webhook only - True/False	{{HasStabilityIssue}}			Yes
Problem: Level 3 metric	Stability, Load or Health	{{Level3Metric}}	Yes	Yes	Yes
Problem: Level 2 metric	See previous section - Problem text in alerts	{{Level2Metric}}	Yes	Yes	Yes
Problem: Colour	Red, Amber or Green	{{Colour}}	Yes		Yes
Problem: Direction	Up or down	{{Direction}}	Yes		Yes
Problem: Metric Value	Current value of the level 2 metric, as a percentage of the threshold	{{MetricValue}}	Yes	Yes	Yes
Problem: Fuel Gauge Value	Current value of the fuel-gauge which triggered the event	{{FuelGaugeValue}}	Yes	Yes	Yes
Problem: Metric Description	See previous section - Problem text in alerts	{{MetricDescription}}	Yes	Yes	Yes
Name	Name of the watch that caused the alert, a unique identifier	{{Name}}	Yes	Yes	Yes - as "watchName"
Watch type	Type of watch that caused the alert e.g. bearer, ICMP test etc.	{{WatchTypeName}}	Yes		Yes
Device address	IP address for the device of the watch that caused the alert	{{DeviceAddress}}	Yes	Yes	Yes
Reference	Note this can be set individually for bearers and their subwatches (classes and VLANs) which may assist parsing of alerts	{{Reference}}	Yes		Yes - as "referenceText"
Watch ID	Internal reference number (Trap only)	N/A		Yes
URL	Is URL available? Use code before and after	{{#LinkUrl}} {{/LinkUrl}}	Yes		Yes
URL	A shortcut to the Details page of the affected watch	{{LinkUrl}}	Yes		Yes

Notes on Report field

Notes on Report field for classes, VLANs and performance tests

VLANs	If the watch is a VLAN then Report is set to VLAN "Vlan interface”
Class	If the watch is a traffic class then Report is set to Traffic Class "Class Tag” (as found in the Edit Watch dialog)
Performance test	If the watch is a performance test then Report is set to “test type from source address to target address (IP or URL).” If descriptions are available for the source, target or both, descriptions overwrite addresses.

Watch specific fields

The fields here would typically be used with the before and after code. The fields will then only appear in an email alert if the alerting watch is of that type. All fields appear in email alerts and in webhooks with some name variation. None are included in SNMP traps.

Field name	Description	Code	In email?	In webhook?
Broadband watch	Is this a broadband watch? Use code before and after	{{#IsBroadbandSpeedAlert}} {{/IsBroadbandSpeedAlert}}	Yes	Yes
	Broadband downstream speed Kb	{{BroadbandSampleSpeedKbps}}	Yes	Yes - as "broadbandDownstream SpeedKbps"
	Broadband threshold speed Kb	{{BroadbandSpeedThresholdKbps}}	Yes	Yes - as "broadbandAlert ThresholdKbps"
Cellular watch	Is this a cellular watch? Use code before and after	{{#IsCellular}} {{/IsCellular}}	Yes	Yes
	Cellular signal strength (Score)	{{CellularSignalStrength}}	Yes	Yes
	Cellular signal strength threshold (Score)	{{CellularSignalThreshold}}	Yes	Yes
Critical port watch	Is this a critical port on a switch? Use code before and after	{{#HasCriticalPortInfo}} {{/HasCriticalPortInfo}}	Yes	Yes
	Critical port	{{CriticalPort}}	Yes	Yes
	Critical slot	{{CriticalSlot}}	Yes	Yes
	Port interface name	{{PortInterfaceName}}	Yes	Yes
	Port interface alias	{{PortInterfaceAlias}}	Yes	Yes
Performance test watch	Is this a performance test? Use code before and after	{{#IsPerfTest}} {{/IsPerfTest}}	Yes	Yes
	Test Name (API Name)	{{ApiName}}	Yes	Yes
	URL Link to External system	{{ExternalLinkUrl}}	Yes	Yes
Site link	Is watch a site link? Use code before and after	{{#IsSiteLink}} {{/IsSiteLink}}	Yes	Yes
	Total linked sites at location	{{TotalLinkedSites}}	Yes	Yes
	Active linked sites (based on stability) at location (aka Site links Up)	{{SiteLinksUp}} {{ActiveLinkedSites}}	Yes	Yes
	Down linked sites at location - true/false	{{DownLinkedSites}}	Yes	Yes
Tunnel (SD-WAN)	Is watch a tunnel? Use code before and after	{{#IsTunnel}} {{/IsTunnel}}	Yes	Yes
	Tunnel load threshold (82% fixed)	{{TunnelTrafficLoadThresholdPercent}}	Yes	Yes
	Tunnel traffic load	{{TunnelTrafficLoadPercent}}	Yes	Yes
Wireless Access Point	Is watch a WAP? Use code before and after	{{#IsWirelessAccessPoint}} {{/IsWirelessAccessPoint}}	Yes	Yes
	AP Serial number	{{WapSerialNumber}}	Yes	Yes
	AP Location	{{WapLocation}}	Yes	Yes

Stability issue codes

Highlight alerts have the option of containing a field representing the bearer issue which caused the alert to be triggered.

This section contains the issue codes and the text explanation.

Issue code	Issue description
#CNA	Issue Code Not Available
#OIU	Ongoing issue cause unknown or monitoring an unknown interface
#TBO	Transients or brief outages
#DRP	Device restarted powered off/on
#RAD	Circuit reported as Down
#OOS	Circuit taken out of service
#UOT	Unknown event type