QoE Triggers & Notifications [Документация VAS Experts]

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
en:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications [2025/11/01 10:40] elena.krasnobryzhen:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications [2025/11/01 10:47] (current) elena.krasnobryzh
Line 26: Line 26:
 Also in this block there is a switch to enable/disable the trigger. **After the configuration is finished, make sure to enable it.** 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?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?700|}}\\ In this case, the verification script will run once a minute every day, i.e. it will run continuously.</note>+<note tip>Example of filling out a block for a report to check RTT delay from a subscriber:\\ {{:en:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:common_rtt.png?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:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:common_botnet.png?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 ==== ==== 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. 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.
Line 38: Line 38:
  
 For each query, 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: For each query, 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?800 |}}+{{ :en:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:queries_filters.png?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?700|}} +<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:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:queries_rtt.png?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?700|}}</note>+\\ \\ 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:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:queries_botnet.png?700|}}</note>
 ==== Step 3: Conditions ==== ==== Step 3: Conditions ====
 Set conditions – what should happen to the metric to run the trigger. \\ Set conditions – what should happen to the metric to run the trigger. \\
Line 62: Line 62:
   * Value – assign the required value for the condition.   * 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: \\ {{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:conditions_rtt.png?700|}}+<note tip>Example of filling out a block for a report to track RTT delay from a subscriber: \\ {{:en:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:conditions_rtt.png?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: \\ 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:
-\\ {{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:conditions_botnet.png?700|}}\\ In this case, the trigger will be fired if there is at least one subscriber in the table from step 2.</note>+\\ {{:en:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:conditions_botnet.png?700|}}\\ In this case, the trigger will be fired if there is at least one subscriber in the table from step 2.</note>
  
  
Line 75: Line 75:
   * “Ok” – the conditions set in the trigger did not work, everything is fine, and no actions 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:\\ {{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:error.png?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>+<note tip>Example of filling out the block for report and for alerts:\\ {{:en:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:error.png?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>
  
  
Line 87: Line 87:
  
   - Start BotFather with the ''/start'' command.   - Start BotFather with the ''/start'' command.
-  - Type ''/newbot'' to create a new bot.\\ {{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:action_telegram_newbot.png?600|}} +  - Type ''/newbot'' to create a new bot.\\ {{:en:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:action_telegram_newbot.png?600|}} 
-  - Enter the name of the bot.\\ {{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:action_telegram_name.png?600|}} +  - Enter the name of the bot.\\ {{:en:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:action_telegram_name.png?600|}} 
-  - Enter a unique ''username'' (Latin only, ending in "bot").\\ {{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:action_telegram_username.png?600|}}+  - Enter a unique ''username'' (Latin only, ending in "bot").\\ {{:en:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:action_telegram_username.png?600|}}
   - Copy the HTTP API access token from the bot registration message, it looks like this: ''5995002635:AAGdSR0udY9K9uxENaPu2HF4azmpsKQq98X''   - 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). \\ {{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:action_telegram_token.png?600|}}+  - Paste the copied token into the GUI settings (Administrator → GUI Configuration → Telegram Settings → Telegram bot API token). \\ {{:en:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:action_telegram_token.png?600|}}
  
 **Step 2: Get a chat ID for your personal Telegram account via https://t.me/RawDataBot** **Step 2: Get a chat ID for your personal Telegram account via https://t.me/RawDataBot**
Line 109: Line 109:
  
 Add the ID from step 2 to the Telegram action in the "Chat ID" field.\\ Add the ID from step 2 to the Telegram action in the "Chat ID" field.\\
-{{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:action_telegram_id.png?600|}}+{{:en:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:action_telegram_id.png?600|}}
  
 === E-Mail === === E-Mail ===
Line 116: Line 116:
   - If you click on the “Template parameters” button (2), it will open a menu with identifiers that can be used to compose the message.   - If you click on the “Template parameters” button (2), it will open a menu with identifiers that can be used to compose the message.
  
-{{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:action_email.png?600|}}+{{:en:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:action_email.png?600|}}
  
 For E-mail actions to work, you need to configure SMTP. Go to Administrator → GUI Configuration, select "SMTP Settings". For E-mail actions to work, you need to configure SMTP. Go to Administrator → GUI Configuration, select "SMTP Settings".
Line 125: Line 125:
   - Clicking on the “Template Options” button (2) opens a menu with identifiers that can be used to compose the message.   - Clicking on the “Template Options” button (2) opens a menu with identifiers that can be used to compose the message.
  
-{{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:action_notification.png?600|}}+{{:en:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:action_notification.png?600|}}
  
 ---- ----
Line 131: Line 131:
 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. 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.
  
-{{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:page_gui.png?1100|}}+{{:en:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:page_gui.png?1100|}}
 ===== “Triggers and Notification” page elements description ===== ===== “Triggers and Notification” page elements description =====
  
Line 137: Line 137:
 This will open the section as shown in the image below. This will open the section as shown in the image below.
  
-{{:en:dpi:dpi_components:dpiui:user_guide:qoe_analytics:triggers_and_notifications:elements.png?1100|}}+{{:en:dpi:qoe_analytics:qoe_gui:offline_analytics:triggers_and_notifications:elements.png?1100|}}