Articles in this section

How do I add a user defined threshold?

Avatar
Stuart Hill
  • Updated
Follow

Applicable to Entuity v22.0 upwards

 

 

To add a user defined threshold

To modify threshold details for a stream attribute

To edit an individual threshold

To delete a threshold

Note regarding user defined thresholds in configuration sets

 

 

To add a user defined threshold:

  1. From the Main Menu, click Administration.
  2. Click User Defined Thresholds.

    u 1.png

  3. The User Defined Thresholds page will open. Select the server or config set on which you wish to create the UD threshold from the dropdown in the top left.

    u 9.png

  4. Click New Thresholds at the top of the Summary table.

    u 10.png

  5. The Thresholds form will open on the right of the window.

    u 11.png

  6. Object Type - click the field to specify the type of object on which your preferred stream is found, e.g. 'Switch Device' or 'Processor'.
  7. Stream Attributes - once you have specified an Object Type above, you can then choose from the stream attributes available on that object type. Click the field to open the list of available stream attributes and select the one you wish to use, e.g. '5s Util% (CPU utilization for this processor)'. Note, virtual streams are inapplicable.
  8. Configure Threshold - once you have specified a Stream Attribute above, you can then configure your threshold by clicking Configure Threshold.

    u 12.png

    This will open the Configure Threshold form. The threshold consists of two parts - the Threshold Source and the Threshold itself.

    u 13.png

    1. Set a Threshold Source - click through to the Set a Threshold Source form, and click Add New Threshold Source.  Specify a Name (e.g. '5s Util%') and the Mode (either Numeric or Status) and click Done.

      u 14.png

      There can be more than one user defined threshold source for a given stream attribute. If you wish to use the same stream attribute as a trigger for both 'Numeric' and 'Status' events, you can define user defined threshold sources for each type.

    2. Return to the Configure Threshold form. Depending on whether you specified 'Numeric' or 'Status' for the mode of your threshold source, you can click 'Add Numeric Threshold or Add Status Threshold. This will open the Add Threshold form.

      • If adding a numeric threshold:

        u 17.png

        1. Threshold Level - select the threshold level to be specified, choosing from Critical, High, Warn, or Low.
        2. Choose from all existing thresholds - if switched on, you can specify an existing system or user defined threshold. If switched off, you can specify the details of a new threshold below.
          • If switched on, you can select an existing system or user defined threshold in the Select from All Thresholds field and reuse it. Use the filter to find the threshold that you wish to use. If you have selected an existing threshold, you will then need to change the Name and Display Name below so as to make a copy of it.
        3. Name and Display Name - specify the name for this threshold. The Name cannot have spaces.
        4. Minimum Value, Default Value, Maximum Value - specify the trigger value of the threshold via the Default Value. Note that the Minimum Value and Maximum Value represent the data minimum and maximum data values, whilst the Default Value is the value the threshold must meet in order to be activated. Note, the values that appear in this form are based on what kind of data this stream attribute will be.
        5. Enabled - specify if the threshold is enabled by default.
        6. Threshold Event - specify from the list which event you wish to be raised when the threshold is met or exceeded. This list can also contain any custom events that you have deployed to your current event project. By extension, if you wish to create a specific event for your user defined threshold, you will need to create a custom event via Event Administration.

      • If adding a status threshold:

        u 15.png

        1. Threshold Level - select the threshold level to be specified, choosing from Up, Down, Disabled, or Other.
        2. Choose from all existing thresholds - if switched on, you can specify an existing system or user defined threshold. If switched off, you can specify the details of a new threshold below.
          • If switched on, you can select an existing system or user defined threshold in the Select from All Thresholds field and reuse it. Use the filter to find the threshold that you wish to use. If you have selected an existing threshold, you will then need to change the Name and Display Name below so as to make a copy of it.
        3. Name - specify the name for this threshold.
        4. Status Value - specify the threshold value.
        5. Enabled - specify if the threshold is enabled by default.
        6. Threshold Event - specify from the list which event you wish to be raised when the threshold is met or exceeded. This list can also contain any custom events that you have deployed to your current event project. By extension, if you wish to create a specific event for your user defined threshold, you will need to create a custom event via Event Administration.

      • Click Done to return to the Configure Threshold form. You can add multiple thresholds if you like, e.g. so as to cater for all values (Critical, High, Warn, Low) of a numeric threshold.

  9. Click Done to save your threshold. It will then appear in the Summary table of the User Defined Thresholds page.

 

To modify threshold details for a stream attribute:

  1. Select a stream attribute from the Summary table of the User Defined Thresholds page.
  2. Click Modify Thresholds at the top of the table (or via the Overflow Menu or right-click Context Menu).

    u 18.png

  3. The same form will open as when you create a new threshold (see above), populated with a list of the current threshold information configured for the selected stream attribute.  Make your desired edits and click Done to save changes, otherwise click Cancel.

    u 19.png

 

 

To edit an individual threshold

  1. Select a stream attribute from the Summary table of the User Defined Thresholds page.
  2. Select an individual threshold from the Details table, and click Edit at the top of that table (or via the Overflow Menu or right-click Context Menu).

    u 20.png

  3. The Edit Threshold form will open on the right of the form. This form is the same as the Add Threshold form (see above). Make your desired changes to the threshold and click Done, otherwise click Cancel.

    u 21.png

 

 

To delete a threshold

Note, once you have deleted the last threshold (in the Details table) on a stream attribute, the entry for that stream attribute will be removed from the Summary table above.

  1. Select a user defined threshold from the Summary table of the User Defined Thresholds page.
  2. Select an individual threshold from the Details table, and click Delete Threshold at the top of that table (or via the Overflow Menu or right-click Context Menu).

    u 7.png

  3. A deletion confirmation dialog will open. Click Yes.

    u 22.png

 

 

Note regarding user defined thresholds in configuration sets:

If a user defined threshold utilizes a custom event, then that custom event will need to be created on all servers in a configuration set in order for the user defined threshold to successfully sync across those servers.

Related articles

Comments

0 comments

Please sign in to leave a comment.