You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 13 Next »
The monitoring source is a fundamental element of the event management process. The main task of the Monitoring Source module is to reduce the number of spam incidents and to inform users about important ones in time. It is also used to classify incidents by type according to settings and analyze them.
The monitoring source has the information about the following entities:
- a specified monitoring system
- a method for getting information from the system
- a data structure provided by the system.
To create a monitoring source, complete the steps below:
- Navigate to Monitoring and Event Management → Configuration → Monitoring Sources.
- Click New.
- Follow the instructions given on the page.
- Once all steps are completed, click Finish.
Step 1. Monitoring source name
You need to specify a unique monitoring source name. The name of the monitoring source will also be used in the title of the target table as follows: Name Target Messages.
Step 2. Data structure
You need to specify the data structure that you want to get from the monitoring source. You can use one of the available fields to enter data:
- JSON – insert data in JSON format. Use Latin letters and {} , "" _ symbols.
Attributes and keys – create attributes by entering them in the input field. Use Latin letters and the _ symbol.
You cannot create the same attributes.
When data is inserted in one of the fields, it is automatically transferred to the other field in the required format.
Select the attributes from the list on the right that will be used as composite keys.
You need to select at least one attribute from the list that will be used as composite keys to go to the next step.
Step 3. Columns of a target table
In step 3 you need to create columns for the target table. To do this, complete the following steps:
- In the New column area, fill in the fields.
- Click Add.
- Repeat and create as many columns as you need.
- When all columns are created, click Next to go to the last step.
Field | Mandatory | Description |
---|---|---|
Column type | Y | Specify a column type. The column type specifies the type of the data stored. Depending on the type selected, additional fields may appear on the form (see below). For more information, refer to the Column Types article. |
Title | Y | Specify a column title displayed on the form. It should be meaningful and human-readable. You can use Latin or Cyrillic letters, [0..9] numbers, and the underscore symbol ( _ ). |
Column name | Y | System column name. This field is populated automatically, depending on the title entered. Latin letters, [0..9] numbers, and the underscore symbol ( _ ) are allowed. |
Reference | Y | Specify a dictionary with the values you need. The field appears when the List or Reference option is selected in the Column type field. |
Choice table | N | Reference to a table with options. The field appears when the Choice option is selected in the Column type field. |
Choice type | Y | Define whether the None option is applicable for the field. Available options:
If the Dropdown without --None-- is chosen, the Default value field becomes mandatory. The field appears when the Choice option is selected in the Column type field. |
Default value | Y/N | Specify a default value that will be populated automatically to the field when a new record is created. The field appears when the Choice option is selected in the Column type field. It becomes mandatory when the Dropdown without --None-- (specify a default value) type is chosen. |
Choice options | N | Create choice options for the column. Click
The field appears when the Choice option is selected in the Column type field. |
To change the values of the created column or delete it, complete the steps below:
- Click on its title in the Added columns area. The form will appear on the left.
- Make changes and click Save, or click Delete to delete the column.
- To close the form without any changes, click
in the top right corner of the area.
- To close the form without any changes, click
Step 4. Field mapping
This step is optional. To finish the monitoring source setup, click Finish.
Set the field mapping to define the correlation between fields of the monitoring source and fields of the target table.
To do this, complete the following steps:
- Click the element in one of the areas. The chosen element is highlighted.
- In the opposite area, click the corresponding element.
As a result, the formed pair is highlighted in green, a connecting line runs between the elements. The pair is sorted to the bottom of the element list.
To disconnect the elements, click .
Add, edit and delete a script
You can add a script to the connected field pair so that the record object of the monitoring source is taken as an argument and returns the value to put into the target table field.
To add a script, complete the following steps:
- Click
to open the modal window.
- Enter the script using the SimpleOne Server-Side API.
- Click Add.
When there is a script for a pair of fields, the icon becomes green
.
To open the edit window with the script specified, click . Make changes and click Save, or click Delete to delete the script.
Results
As a result, the following entities are created:
- a Monitoring Source record. The field values are populated automatically with the values specified during the setup.
- an endpoint in the API Actions (sys_api_action) table. The endpoint link is generated that you can copy by clicking
.
- an Import Source record. It contains the import text in JSON format inserted in step 2.
- a Target Table record. The table contains columns that were created in step 3.
For further setup you need to create Monitoring Rules, Event Rules and Event Actions.
- No labels