Difference between revisions of "Adding a rule"

From Senfi Docs
Jump to: navigation, search
Line 10: Line 10:
 
* Be able to send records to input measurement & metric.
 
* Be able to send records to input measurement & metric.
 
* (Optional) Be able to send simulated records to input measurement & metric (to simulate occurrence of event or situation)
 
* (Optional) Be able to send simulated records to input measurement & metric (to simulate occurrence of event or situation)
 +
 +
=== Adding a New Computed Measurement ===
 +
 +
# Login to the [https://ems.senfi.io/cms CMS]
 +
# Go to the '''Rule''' tab
 +
# Click the '''+''' button to add a new rule.
 +
# Give the rule a descriptive name. This will be shown to users of the dashboard.
 +
# Select the Severity of the rule.
 +
# Select Evaluate Type of the rule. Read [[Rule#Rule_execution_options|this section]] if you require a refresher
 +
# (Optional) Select the Access Group that would be able to view and modify the rule. Defaults to all users in your organization.
 +
# Give the rule a descriptive Description. The Description would be the default Content for any Action
 +
# Construct the Conditions using the editor. [[#Constructing_Condition|Constructing the Condition]] for more details.
 +
# Save when done
 +
# (Optional) Send records to simulate event to test the rule.

Revision as of 12:26, 19 September 2019

Pre-requisites

A rule requires design and logical programing in order for it to work correctly. If this is your first time creating a rule, please read this guide first.

You should also be similar with the basic measurements and its concepts. Please read this section if you require a refresher.

You should

  • Know what event or situation the Rule should detect.
  • Know what you would like Senfi to do (Action) when event or situation is detected
  • Have already created the input measurement & metrics.
  • Be able to send records to input measurement & metric.
  • (Optional) Be able to send simulated records to input measurement & metric (to simulate occurrence of event or situation)

Adding a New Computed Measurement

  1. Login to the CMS
  2. Go to the Rule tab
  3. Click the + button to add a new rule.
  4. Give the rule a descriptive name. This will be shown to users of the dashboard.
  5. Select the Severity of the rule.
  6. Select Evaluate Type of the rule. Read this section if you require a refresher
  7. (Optional) Select the Access Group that would be able to view and modify the rule. Defaults to all users in your organization.
  8. Give the rule a descriptive Description. The Description would be the default Content for any Action
  9. Construct the Conditions using the editor. Constructing the Condition for more details.
  10. Save when done
  11. (Optional) Send records to simulate event to test the rule.