Differences

This shows you the differences between two versions of the page.

--- en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:start [2023/07/31 09:43] – [Step 2: Select a data source and metrics] edrudichgmailcom
+++ en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:start [Unknown date] (current) – removed - external edit (Unknown date) 127.0.0.1
@@ Line 1: / Line 1: @@
-====== QoE Triggers & Notifications ======
-{{indexmenu_n>5}}
-===== Purpose of use =====
-In the "Triggers and Notification" section you can configure sending periodic reports and operational alerts to Telegram or E-mail and display them in the GUI. When a trigger is activated, you will receive a message with information about the specified event and links to the corresponding reports. By default, there are 4 reports in .csv, .tsv, .xlsx, .pdf formats, but the message template can be edited.
-<note>Triggers and Notification section requires an active subscription – Standard license for GUI.</note>
-Let's make the settings using two scenarios as an example:
-  - **Periodic report to track the RTT delay from a subscriber.** \\ The report will show subscribers whose "RTT from subscriber" value is greater than or equal to 150000 ms. It will be sent on Mondays and Thursdays **in Telegram**.
-  - **Alert about subscribers being a part of a botnet.**\\ We will set up a table check once a minute every day. Notification will be sent **to your email** as soon as at least one infected subscriber is detected in the table.
-===== How to create and configure triggers =====
-  - In the GUI, go to QoE analytics → Triggers and Notification.
-  - Click the + on the Triggers dashboard to add a trigger. This will open the configuration pop-up window.
-It takes 5 steps to create a new trigger. Trigger settings are divided into blocks, you need to fill all of them.
-==== Step 1. Schedule ====
-Fill in the required fields:
-  * Name – choose any unique name for the trigger.
-  * Severity – select the level of importance: information, warning, medium/high importance. For example, “Information” can be set for a regular report, and all others can be set for different notifications as you see fit. **Optional field.**
-  * Days of the week – on which days of the week the trigger will run.
-  * Check frequency — how often the validation script will be run. For example, if the value “1 min” is set – the check script will be run once a minute on the specified days of the week.
-  * Start and end date and time. **Optional fields.**
-Also in this block there is a switch to enable/disable the trigger. **After the configuration is finished, make sure to enable it.**
-<note tip>Example of filling out a block for a report to check RTT delay from a subscriber:\\ {{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:common_rtt.png?nolink&700|}}\\ In this case, the check script will run on the specified days once every 24 hours - once on Monday and once on Thursday.\\ \\ Example of filling out a block for notification about subscribers with cyber threats:\\ {{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:common_botnet.png?nolink&700|}}\\ In this case, the verification script will run once a minute every day, i.e. it will run continuously.</note>
-==== Step 2: Select a data source and metrics ====
-Select a metric and data table. Triggers only work with ready-made tables found in Netflow and Clickstream, to start customization you need to find a table that has the required metric.
-To create a query, click on the **+** under the block name.
-  * Report – select a table with data from the ready-made reports of the system, which are analyzed.
-  * “Period from” and “-to”. For example, if you need to analyze data for the last 24 hours, set “Period from” – 24 hours, “Period to” – now.
-<note>The value "Now" in the query parameters "Period from" and "Period to" means when the trigger is started. It is summarized from the "Days of Week" and "Check Frequency" values from step 1.</note>
-For each request, you can create a filter where you can set the value of IP host, subscriber login, etc. For example, you can customize the generation of a report or notification for one specific host, if you set the filter like this:
-{{ :en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:queries_filters.png?nolink&800 |}}
-<note tip>Example of filling out a block for a report to track RTT delay from a subscriber. Here you need to select the report “Top subscribers with high RTT”, it has the required metrics for this trigger. Since you want the report to come on Mondays and Thursdays, “Period from” should be set equal to the interval between these days – “Now – 4 days”, the data for the last 4 days will be analyzed.\\ {{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:queries_rtt.png?nolink&700|}}
-\\ \\ Example of filling out the block for notification about subscribers with cyber threats. Here you need to select the report “Top infected subscribers with botnet traffic”, it has the required metrics for this trigger. In this case, the data for the last 24 hours will be analyzed.\\ {{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:queries_botnet.png?nolink&700|}}</note>
-==== Step 3: Conditions ====
-Set conditions – what should happen to the metric to run the trigger. \\
-To create a condition, click the **+** below the block name.\\
-For each condition, you need to configure the following parameters:
-  * AND/OR relationship – compare with the names of requests for fulfillment of either several conditions at once or at least one of the specified conditions.
-  * Name – select one of the created requests.
-  * Function – select the type of aggregate function to be applied to the values in the condition:
-    * "count" counts the number of items or records in the dataset,
-    * "any" returns any value available in the dataset,
-    * "anyLast" returns the last value available in the dataset,
-    * "avg" calculates the average value of the numeric data in the dataset,
-    * "min" returns the minimum value from the available data in the dataset,
-    * "max" returns the maximum value from the available data set,
-    * "sum" calculates the sum of the numeric data in the set,
-    * "uniq" returns unique values in the dataset, removing duplicates.
-  * Combinator – select a non-numeric/non-zero/numeric/zero value or leave blank.
-  * Series – select the desired metric from the report.
-  * Operator – select: =, !=, >, >=, <, ⇐, between //<color #c3c3c3>(will return records where the expression is between value1 and value2 inclusive)</color>//,, not between //<color #c3c3c3>(returns all records where the expression is NOT between value1 and value2 inclusive)</color>//.
-  * Value – assign the required value for the condition.
-<note tip>Example of filling out a block for a report to track RTT delay from a subscriber: \\ {{:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:conditions_rtt.png?nolink&700|}}\\ In this case, the trigger will go off if the RTT value from the subscriber is greater than or equal to 150000 ms in the table from step 2.\\ \\ Example of filling out the block for alerts about subscribers with cyber threats:
-\\ {{:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:conditions_botnet.png?nolink&700|}}\\ In this case, the trigger will be fired if there is at least one subscriber in the table from step 2.</note>
-==== Step 4: Error handling ====
-Set the trigger behavior when errors occur.\\
-Select one of the values in the “If there is no data” and “If there is a runtime error or timeout” fields:
-  * “Notification” – there is the condition specified in the trigger.
-  * “No data” – no data is found when processing the reports set in the trigger.
-  * “Save last condition” – no action needed.
-  * “Ok” – the conditions set in the trigger did not work, everything is fine, and no actions needed.
-<note tip>Example of filling out the block for report and for alerts:\\ {{:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:error.png?nolink&700|}}\\ In both cases, if there is no data – the trigger will not be fired and the message will not be sent; if there is an error or timeout – notification will be sent.</note>
-==== Step 5: Actions ====
-Setting up an action will allow you to receive a message to E-mail or Telegram in case of triggering. \\
-To create an action, press **+** under the block name. \\
-To delete an action, press **✕** next to the action name.
-=== Telegram ===
-**Step 1: Register your bot via https://t.me/BotFather.**
-  - Start BotFather with the ''/start'' command.
-  - Type ''/newbot'' to create a new bot.\\ {{:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:action_telegram_newbot.png?nolink&600|}}
-  - Enter the name of the bot.\\ {{:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:action_telegram_name.png?nolink&600|}}
-  - Enter a unique ''username'' (Latin only, ending in "bot").\\ {{:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:action_telegram_username.png?nolink&600|}}
-  - Copy the HTTP API access token from the bot registration message, it looks like this: ''5995002635:AAGdSR0udY9K9uxENaPu2HF4azmpsKQq98X''
-  - Paste the copied token into the GUI settings (Administrator → GUI Configuration → Telegram Settings → Telegram bot API token). \\ {{:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:action_telegram_token.png?nolink&600|}}
-**Step 2: Get a chat ID for your personal Telegram account via https://t.me/RawDataBot**
-<note important>To get chat ID, user must have ''username'' in Telegram profile!</note>
-  - Start Telegram Bot Raw with the ''/start'' command.
-  - Copy the ''ID'', it looks like this:\\ <code>"chat": {
-      "id": 222455434,
-      "first_name": "Ivan",
-      "last_name": "Nat",
-      "username": "HardNat",
-      "type": "private"
-},</code>
-**Step 3: Connect Telegram to the configured trigger**
-Add the ID from step 2 to the Telegram action in the "Chat ID" field.\\
-{{:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:action_telegram_id.png?nolink&600|}}
-=== E-Mail ===
-Creates a notification and sends it to the specified e-mail address.\\
-  - If the “Message” field is not filled in – click on the “Set default template” button (1) to fill the action fields with default values. If necessary, all values can be edited.
-  - If you click on the “Template parameters” button (2), it will open a menu with identifiers that can be used to compose the message.
-{{:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:action_email.png?nolink&600|}}
-For E-mail actions to work, you need to configure SMTP. Go to Administrator → GUI Configuration, select "SMTP Settings".
-=== GUI Notifications ===
-Notification can be used to test the functionality of triggers.\\
-  - Click on the “Set default template” button (1) to fill the action fields with default values. All values can be edited if necessary.
-  - Clicking on the “Template Options” button (2) opens a menu with identifiers that can be used to compose the message.
-{{:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:action_notification.png?nolink&600|}}
-----
-\\
-After creating a trigger, click “Save”. On the “Triggers” dashboard, enable the necessary triggers. If the GUI page has not been refreshed – refresh the page in the browser or click the “Refresh” button.
-{{:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:page_gui.png?nolink&1100|}}
-===== “Triggers and Notification” page elements description =====
-Go to QoE Analytics → Triggers and Notification. \\
-This will open the section as shown in the image below.
-{{:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:elements.png?nolink&1100|}}
-This section contains three sections:
-  * List of the triggers.
-  * List of the notifications.
-  * List of actions performed by triggers as a result of notifications.
-Types of triggers:
-  * System. These are set by the vendor and can only be enabled/disabled.
-  * Custom. User-defined and can be freely configured.
-For a detailed description of configuring a trigger, see [[en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:start#how_to_create_and_configure_triggers|How to create and configure triggers]].