Quick Tracking:Reach Channel

Overview

Reach channels define how monitoring alerts are delivered. Supported channel types include email and webhook. After a channel is configured, alert notifications are sent through it automatically.

Effective scope: organization-wide.

Introduction

Email settings

To set up email notifications, configure the sender email address, email authorization code, and SMTP server as shown in the following figure.

1. Sending address: the email address to which the email is sent, such as "c***@1*.com".

2. Obtain the email authorization code and SMTP (Outbox server address):

• Take a QQ email as an example. In the "Settings-Account-POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV service" section of the mailbox, click "Enable" of the POP3/SMTP service and generate an authorization code by using a mobile phone message.

• Take 163 NetEase email as an example. On the Settings-POP3/SMTP/IMAP page, click Open for IMAP/SMTP and generate an authorization code by SMS.

Group Webhook Channel

Select the Webhook mode and add a channel. You can customize the platform name, for example, by using the DingTalk group name for easy identification.

Webhook notifications can be pushed to DingTalk groups.

Obtain webhook links

1. First, you need to add a custom robot to the receiving group.

2. In the DingTalk robot set keyword:

For more information about how to use "QT Business Alert"

3. Obtain the webhook URL

4. Add the webhook URL to the QT Reach Channel settings.

5. Message style

Custom Webhook Channel

1. Custom webhook flowchart

2. Procedure

   Webhook protocols vary by customer. To support different protocols, the webhook configuration provides the following options:

   Parameter	Parameter	Required	Meaning	Cron expression
   request	method	Yes	Request method (POST/GET)	https://xxx.yyy.com
   	headers	No	Request Header (Enter Key-Value)	POST
   	body	No	Request body (JSON format, defined by the customer. Use double braces {{xx}} as placeholders for predefined variables).	{ "name": "Test custom webhook", "title": "An exception occurred in the" {{AppName}} "monitoring task" {{MonitorTaskName}} "of" {{OrgName}} ", "content": "Metric: {{IndicatorDescription}} exception occurred \nThe exception message is:{{IndicatorExceptionMsgContent}}" }
   bodySuccessTag	-	No	Request success identification

   Predefined Fields

   Predefined Fields	Description
   OrgName	Organization name
   AppName	Application name
   WebhookPlatformName	Custom webhook name
   MonitorTaskId	Monitoring task ID
   MonitorTaskName	Monitoring task name
   IndicatorDescription	Metric description
   IndicatorExceptionMsgContent	Metric exception message body
   IndicatorExceptionMsgList	Metric exception information list

3. Refer to the following sample code and configure the parameters as needed.

Example 1:

Configurations:

{
  "request": {
    "method": "post",
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "name": "Test custom webhook",
      "title": "An exception occurred in the" {{AppName}} "monitoring task" {{MonitorTaskName}} "of" {{OrgName}} ",
      "content": "Metric: {{IndicatorDescription}} exception occurred \nThe exception message is:{{IndicatorExceptionMsgContent}}"
    }
  }
}

Response:

{
    "name": "Test custom webhook",
    "title": "An exception occurred in the test view monitoring task" test view monitoring "of the test organization",
    "content": "Indicator: The number of times that the device ID of any event (preset) is triggered is abnormal. \nThe exception information is: Alarm calculation time: 2024/05/09 01:00:00" SDK version ["5.3.2"] "The current indicator value is 232.0, and the range is 1 to 10000. \nThe current indicator value of" SDK version ["6.5.6"] "is 186.0. Interval 1 to 10000\n" SDK version [\"6.3.0\"] "The current indicator value is 326.0, interval 1 to 10000\n" SDK version [\"10.3.2\"] "The current indicator value is 288.0, interval 1 to 10000\n" SDK version [\"12.5.6\"] "The current indicator value is 48.0, range 1 to 10000\n" SDK version ["11.3.0"] "Current metric value is 48.0, range 1 to 10000"
}

Example 2:

Configurations:

{
  "request": {
    "method": "post",
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "name": "Test custom webhook",
      "title": "An exception occurred in the" {{AppName}} "monitoring task" {{MonitorTaskName}} "of" {{OrgName}} ",
      "taskId": "{{MonitorTaskId}}",
      "msgList": {{IndicatorExceptionMsgList}}
    }
  }
}

Response:

{
    "name": "Test custom webhook",
    "title": "An exception occurred in the test view monitoring task" test view monitoring "of the test organization",
    "taskId": "1837812901",
    "msgList": [
      "The current metric value of" SDK version [\"5.3.2\"] "is 232.0",
      "The current metric value of" SDK version [\"6.5.6\"] "is 186.0, and the range is 1 to 10000",
      "The current indicator value of" SDK version [\"10.3.2\"] "is 288.0, and the range is 1 to 10000",
      "The current metric value of" SDK version [\"12.5.6\"] "is 48.0 in the range of 1 to 10000"
    ]
}