Alert Push

Network products and platforms support Alert push. The push format of the platform is relatively fixed and should not be modified. Network product's own Alert push is divided into two types: HTTP push and UDP push. Generally, Network's HTTP push is used.

Alert push interface

Please refer to "Tingyun Network Data Dictionary - Alert Push API Instructions".

HTTPAlert push template

More and more customers are beginning to use a unified information access platform to connect to information pushed by third-party service providers, such as Alert information. Network products implement a templated Alert push method, which can splice standard Alert fields into the required format according to customer needs to meet customers' diverse needs for Alert information.

Usage process

1. Create a monitoring task in the Network console.

2. The customer is configuring alerts on the platform.

3. Customers need settings Tingyun server whitelist.

106.75.114.38, 106.75.25.50, 106.75.108.179

4. The customer provides a specific service push address (where the Alert information is pushed).

5. The customer provides the template format pushed by Alert (or the document of the customer’s access content).

6. Tingyun R&D personnel customize push services according to customer needs.

Supported fields

**Currently, only the following field splicing templates are supported, and the development of additional fields is not supported. **

The Probe number of The performance indicators set by

JSON parameter	type	Description
user_name	string	account name.
task_name	string	task name.
task_url	string	task address.
alarm_id	int	AlertID.
item_seq	int	Alert periodic sequence.
alarm_type	int	Alert type. (0: Performance Alert, 1: Error Alert, 3: Intelligent Alert)
alarm_name	string	Alert name.
alarm_status	string	Alert status. Including two states: Alert and normal.
alarm_status_detail	string	("Alert","Critical Alert","normal")
alarm_time	string	Alert sampling period.
point_total	string	samples.
perf	string	(described only for performance Alert and smart Alert).
avail	string	Availability (described only for performance Alert and smart Alert).
pointError	string	points Error description (only Error Alert will have a description).
errorPercent	string	Error proportion description (only Error Alert will have a description).
triggerOn	string	Alert trigger reason. performanceAlert: Both performance indicators and Availability triggered warnings; Availability triggered a warning; triggers a warning when performance and Availability exceed the set warning threshold; Alert is lifted. Error Alert: Error Probe number exceeds the threshold; Error monitoring percentage exceeds the threshold; Alert is lifted.
alarmPoints	scatter Dataset (set).
	tmBase	string	monitoring time.
	probeIp	string	Probe IP.
	city	string	monitors the city.
	isp	string	monitoring operator.
	performance	string	performance value (only performance Alert and smart Alert have value).
	compDesc	string	performance indicator name.
	compUnit	string	performance units.
	destIp	string	Host IP.
	destCity	string	Host city.
	destIsp	string	Host operator.
	errorDesc	string	Error description.
	domainUrl	string	monitors the domain name (data will only be available on the domain name Alert).

Request parameters/return parameters/Error code

Content description	Customers customize the JSON data structure according to their own System, and Request parameters are customer-defined.
Interaction Rules	HTTP push

Splicing example

Required fields should be identified using ${}.

{ "rule_id":"${alarm_id}", "state":<#if status = 1||status = 2>"open"<#else>"close"</#if>, "title":"${alarm_name}", "content":"Alert name: ${alarm_name}Alert Data sampling time: ${alarm_time}${triggerOn}<#if >${perf}${avail}</#if><#if >${point_total}${pointError}${errorPercent}</#if>" }

An example of the results is as follows:

{ "rule_id": "19,790", "state": "open", "title": "Task_Error Alert Push", "content": "Your monitoring task on the Tingyun monitoring platform settings: Error Alert push, because the number of Error Probe exceeds the threshold..." }