Difference between revisions of "Adding a rule"
From Senfi Docs
| (64 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | === Pre-requisites === | + | <translate> |
| + | === Pre-requisites === <!--T:1--> | ||
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 [[Rule|this guide]] first. | 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 [[Rule|this guide]] first. | ||
| − | You should also be | + | <!--T:2--> |
| + | You should also be familiar with the basic [[Measurement|measurements]] and its concepts. Please read [[Concepts#Measurement.2C_Metric.2C_Tag|this section]] if you require a refresher. | ||
| + | <!--T:3--> | ||
You should | You should | ||
| − | * Know what event | + | * Know what event the Rule should detect. |
| − | * Know what you would like Senfi to do ('''Action''') when event | + | * Know what you would like Senfi to do ('''Action''') when the event is detected |
| − | * Have already created the | + | * Have already created the '''Input''' measurement & metrics. |
| − | * Be able to send records to | + | * Know the thresholds or values which indicates occurrence of event. |
| − | * (Optional) Be able to send simulated records to | + | * 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 Rule === <!--T:4--> | ||
| + | |||
| + | <!--T:5--> | ||
| + | # 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 [[Rule#Rule_execution_options|Evaluate Type]] of the rule. | ||
| + | # (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. Read section on [[Rule#Constructing_Condition|"Constructing Condition"]] for more details. | ||
| + | # Save when done. | ||
| + | # (Optional) Test the rule by sending records to simulate event. | ||
| + | |||
| + | |||
| + | <!--T:6--> | ||
| + | <div class="right">[[Adding_a_computed_measurement|Next: Adding a computed measurement]]</div> | ||
| + | </translate> | ||
Latest revision as of 14:18, 5 November 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 familiar with the basic measurements and its concepts. Please read this section if you require a refresher.
You should
- Know what event the Rule should detect.
- Know what you would like Senfi to do (Action) when the event is detected
- Have already created the Input measurement & metrics.
- Know the thresholds or values which indicates occurrence of event.
- 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 Rule
- Login to the 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.
- (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. Read section on "Constructing Condition" for more details.
- Save when done.
- (Optional) Test the rule by sending records to simulate event.