Quick Tracking:Reach Channel

Overview

You can use the touch channel to set the push channel of monitoring alert, such as email and webhook. After setting, the information of monitoring alerts can be reached through this channel.

Effective Scope: All valid within the scope of the organization.

Introduction

Email settings

The following figure shows how to configure Send Email Address, Email Authorization Code, and SMTP.

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 Webhook mode, add settings, platform name can be customized (can be set to DingTalk group name, easy to distinguish)

Webhooks 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 to QT "Touch Channel"

5. Message style

Custom Webhook Channel

1. Custom webhook flowchart

2. Procedure

   When configuring the webhook, the protocol of each customer will be different. In order to be compatible with multiple situations, the webhook configuration will support multiple methods, as follows:

   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 (defined by the customer, the format is json, with braces {{xx}} as a placeholder, indicating a predefined variable)	{ "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	The application name
   WebhookPlatformName	Custom webhook name
   MonitorTaskId	Monitoring task ID
   MonitorTaskName	Monitoring task name
   IndicatorDescription	The description of the metric.
   IndicatorExceptionMsgContent	Metric exception message body
   IndicatorExceptionMsgList	Metric exception information list

3. Use the sample code that is shown in the following figure and configure the parameters in the code.

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"
    ]
}