Alerts (Admin Settings)

Some of the content described in this article is available in meshIQ Manage versions 11.1.1 and later. See meshIQ platform Highlights v11.1 for an overview of feature changes.

Alerts inform individuals or groups about specific scenarios. You can associate an alert with a provider by selecting an action that has been set up for that provider.

Skip ahead to:

• Create an alert
• Edit an alert
• Clone an alert
• Delete an alert

Create an alert

To set up custom alert conditions, you can either use objectives or write a jKQL query. The choice between objectives and a query is the first step in creating the alert. Instructions for both methods are provided below.

Create an alert using objectives for alert conditions

1. Go to Main Menu > Admin Settings >Alerts.
2. Click Create.
3. (Version 11.1.1 only.) Under Select type, choose Objectives.
4. Select all objectives that you want to base this alert on. If you are selecting multiple objectives, they must be from the same set.
5. Use the Notify When list to indicate the scenarios in which you want this alert to be sent. Choose one:
   • All objectives are met
   • At least one objective is met
   • At least one objective is NOT met
   • No objectives are met
6. Click Next.
   
7. Identify the Severity of this alert. Selections are listed below.
   • None
   • Trace
   • Debug
   • Info
   • Notice
   • Warning
   • Error
   • Failure
   • Critical
   • Fatal
   • Halt
8. Choose how you want to report the alert (by instances or by time intervals), and how often (number of instances or number of seconds, minutes, hours, or days).
   
9. Click Next.
   
10. Enter the name of the new alert in the Alert Name.
11. Assign an Action to the alert by selecting one from the list. A filter field is available; the list is automatically filtered by the text that you type. Actions are categorized by provider (for example, Email or Slack).
12. Click Test to test the alert. A message is displayed to indicate that the test was successful:
    
13. Click OK.
14. Click Finish to save the alert.

Create an alert using a jKQL query for alert conditions

You can write a jKQL query to set up custom alert conditions instead of using objectives. 

1. Go to Main Menu > Admin Settings >Alerts.
2. Click Create. The Type step opens.
   
3. Select Query for the type of alert you want to create.
4. Click Next. 
5. The Query step opens. Enter your jKQL query after the prompt. You can refer to an objective in your query by including the set name and objective name:

   '<set name>.<objective name>'

   An example is provided below:

   Get Activity Fields All That Meet Any Objective 'set1.objectiveName', 'set1.objectiveST' Show As table

   
6. Click Next. The Info step opens.
   
7. Identify the Severity of this alert. Selections are listed below.
   • None
   • Trace
   • Debug
   • Info
   • Notice
   • Warning
   • Error
   • Failure
   • Critical
   • Fatal
   • Halt
8. Choose how you want to report the alert (by instances or by time intervals), and how often (number of instances or number of seconds, minutes, hours, or days).
9. Click Next.
10. Enter the name of the new alert in the Alert Name.
11. Assign an Action to the alert by selecting one from the list. A filter field is available; the list is automatically filtered by the text that you type. Actions are categorized by provider (for example, Email or Slack).
12. Click Test to test the alert. A message is displayed to indicate that the test was successful:
    
13. Click OK.
14. Click Finish to save the alert.

Edit an alert

1. Go to Main Menu > Admin Settings >Alerts.
2. Choose the alert from the list that you want to edit and click its Edit button . 
3. Follow the instructions above under Create an alert, making changes as needed.

Clone an alert

The functionality described below is available in XRay versions 1.6 and greater. 

1. Go to Main Menu > Admin Settings >Alerts.
2. Choose the alert you want to copy and click the Clone icon . The alert wizard opens. 
3. Follow the instructions above under Create an alert, making changes as needed.
4. In the Actions step, note that the Alert Name of the new alert is the name of the cloned alert followed by "Copy." You can change it as needed.
5. Complete the new alert by clicking Finish, as you would for new alerts.

Delete an alert

1. Go to Main Menu > Admin Settings >Alerts.
2. Choose the alert you want to delete and click the Delete icon . A confirmation message is displayed.
3. Click Yes to delete the alert.