Introduction

Create an alert definition to define monitoring, management, and automation rules for your resources. Creating a definition allows administrators to standardize actions, enforce configurations, and ensure consistent management across devices.

Alert definitions can be configured with specific rules, and scopes to meet organizational requirements.

This functionality enables you to assign monitoring templates, apply availability rules, and assign resources using filter criteria.

Additionally, you receive timely alert notifications about resource performance and availability. For example, the alerts will notify you immediately when certain conditions are met, such as a resource becoming unavailable or exceeding a predefined threshold limit. Receiving these alerts will allow you to take quick action to these issues, before problems escalate. This enhances your ability to effectively manage your resources, ensuring their optimal health and efficiency.

Create alert definition

The following video guides you through the process of creating a Template-based alert definition in OpsRamp.



Follow these steps to create a alert definition:

  1. To select your client, navigate to All Clients, and click the Client/Partner dropdown menu.
    Note: You may either type your client’s name in the search bar or select your client from the list.
  2. Navigate to Setup → Account. The Account Details page is displayed.
  3. Click Monitoring tile. The TEMPLATE BASED tab displays all the alert definitions created with Global and Non Global scopes.
  4. Click +ADD.


  5. Enter the following information in the screen:
    Mandatory fields

    Field NameField TypeDescription
    NameStringEnter a name for the alert definition.
    ScopeDropdownNote: This field is displayed if you are a Partner user.
    Select one of the following:
    • All Clients: Applies the alert definition to all the clients.
    • Include Clients: Applies the alert definition to the clients you select from Clients dropdown.
    • Exclude Clients: Applies the alert definition to all, excluding the clients you select from Clients dropdown. So the clients you select from Clients dropdown will be exempt from the alert definition.
    RESOURCE FILTER CRITERIAStringUse the filter criteria option to filter the resources according to your requirements.
    1. Click anywhere in the Filter Criteria box and click +QUERY in the RESOURCE FILTER window.
    2. Build a query using OpsQL. The matching results are displayed. The list has Name, IP Address, Operating System, and Resource Type columns.
    3. Click APPLY. The resources are added.
      To view the list of resources, click VIEW RESOURCES.
    AVAILABILITY RULECheckboxSelect this option, if you want to set availability rule.
    ALL: This option is selected by default.
    If there are critical alerts on all the availability metrics, then the resources are considered as DOWN. Otherwise, they are considered as UP.
    ANY: If there are critical alerts on any of the availability metrics, then the resources are considered as DOWN. Otherwise, they are considered as UP.
    MONITORING TEMPLATESCheckboxSelect this option to assign monitoring templates to the resources.
    Note: Templates compatible with the resource type should be assigned.
    1. Click +ADD.
    2. Use Search option to search for templates.
      You can use the Filter option to filter templates based on Collector Type.
    3. Select the templates.
    4. Click +ASSIGN TEMPLATE. The template(s) are added and listed in the MONITORING TEMPLATES section.
      • Click down arrow against the template to view template details.
    • Overwrite resource-level parameters: Overwrites user actions and performs alert definition-driven actions on filtered resources.
      If you select this option, all the configuration parameter values that you define at the resource level will be overwritten by the configuration parameter values that you specify in the alert definition.
      If you do not select this option, the configuration parameter values that you define at the resource level will be protected, and not be overwritten by the configuration parameter values that you specify in the alert definition.
    • Overwrite resource level template assignments. If resources are not part of the filter criteria, the templates will be unassigned: If a resource does not meet the specified filter criteria, the templates currently assigned to that resource will be removed or unassigned.
      If you do not select the option, then the existing template assignments at the resource level will remain unchanged. Resources that do not meet the filter criteria will retain their current template assignments, and no un-assignment will occur.
    1. Click SAVE AND RUN. The alert definition is created and a confirmation message appears.
    • To find the alert definition you created, use the Search option.

    Edit parameters

    During the alert definition creation process, after adding a template, you can edit the parameters of the metrics within that template.

    Below are examples of templates and how you can edit them:

    • Example 1:


    1. Select the desired frequency from the Frequency dropdown.
    2. Click the Edit icon. The metric window is displayed.


    3. Edit the parameters: WARNING EXPRESSION, CRITICAL EXPRESSION, Alert, Apply Availability Metrics as per your requirements.
    4. Click APPLY. The metric details are updated.
    5. Follow the same steps to make changes to other metrics as needed.
    6. Click SAVE AND RUN to save the changes.

    • Example 2:

      • Editing a template:


      1. Select the desired frequency from the Frequency dropdown.
      2. Click PARAMETERS. The template window is displayed.


      3. Edit the parameters: Collector.Application.Type, Connection.Timeout.Ms, remote.server.operatingsystem, remote.server.scripttype, custom.script.arguments as per your requirements.
      4. Click SAVE. The details are updated.
      5. Click SAVE AND RUN to save the changes.

      • Editing a metric:

      1. Click the Edit icon. The metric window is displayed.


      2. Edit the parameters: WARNING EXPRESSION, CRITICAL EXPRESSION, Alert, Apply Availability Metrics as per your requirements.
      3. Click APPLY. The metric details are updated.
      4. Follow the same steps to make changes to other metrics as needed.
      5. Click SAVE AND RUN to save the changes.

    Reset changes

    Follow these steps to reset configuration changes:

    The system allows you to reset the changes made to the template or a metric.

    Note: The Reset option appears only after you make changes to a metric or template, save the alert definition, and then reopen the alert definition.

    1. Search for the alert definition you modified.
    2. Click the alert definition name. The Alert definition page is displayed.
    3. In the MONITORING TEMPLATES section, click the Actions (three dots) icon and select Reset.


    4. The template and the metric changes are reset. All the configuration changes are reverted.