You can configure alert rules in Operation Center. This topic describes the formats of alert messages sent by using a custom webhook.
Connectivity test
{
"message":{
"content": "DataWorks Workbench Alarm Connectivity Test"
}
}
Custom alerts
Message body
Alerts for auto triggered instances
{
"message": {
"title": "DataWorks_Remind",
"remind_name": "webhookTest",
"remind_unit": "Task"
"occur_time": "2021-07-13 16:16:20",
"remind_type": "uncompleted",
"task_size": 1,
"node_id_list": "220167523",
"node_name_list": "nodeName",
"node_owner_list": "123123123",
"remind_founder": "jingyan20182222",
"number_of_alerts": 3,
"more_information": "http://..."
}
} Alerts for resource groups
{
"message": {
"title": "DataWorks_Remind",
"remind_name": "Alert rule name",
"remind_unit": "ScheduleResourceGroup",
"occur_time": "2021-07-13 16:16:20",
"remind_type": "resGroup use ratio",
"resource_group_name": "Resource group name",
"threshold": 99,
"duration": 30,
"remind_founder": "jingyan20182222"
}
}Fields
Field | Description | Example |
title | The title of the alert. | DataWorks_Remind |
task_size | The number of tasks. | 1 |
remind_name | The name of the alert rule. | webhookTest |
occur_time | The time when the alert was triggered. | 2021-07-13 16:16:20 |
remind_type | The trigger condition. Valid values:
| completed |
node_id_list | The node IDs. Separate multiple IDs with commas (,). A maximum of five node IDs are supported. | 220167523 |
node_name_list | The node names. Separate multiple names with commas (,). A maximum of five node names are supported. | nodeName |
node_owner_list | The node owners. Separate multiple owners with commas (,). A maximum of five node owners are supported. | 123123 |
remind_founder | The creator of the alert rule. | jingyan20182222 |
remind_unit | The monitoring granularity of the alert rule. Valid values:
| Task |
number_of_alerts | The nth trigger of the alert. | 3 |
more_information | The URL of the desired auto triggered instance in Operation Center. | http://XXXX |
threshold | The threshold. This parameter is available only for resource groups.
| 99 |
duration | The duration. Unit: minutes. This parameter is available only for resource groups. | 30 |
Baseline alerts
Message body
{
"message": {
"cycle_number": 1,
"occur_time": "2024-07-31 11:29:43",
"baseline_owners": "dp3base",
"baseline_name": "Baseline test",
"key_instance": 10590018690,
"sla_time": "2024-07-30 17:30:00",
"buffer": -1081,
"title": "DataWorks_Baseline_Alert",
"status": "overSla"
}
}Fields
Field | Description | Example |
cycle_number | The ID of the cycle of the baseline instance. The ID of a day-level cycle is | 1 |
occur_time | The time when the alert was triggered. | 2024-07-31 11:29:43 |
baseline_owners | The baseline owner. | dp3base |
baseline_name | The name of the baseline. | baseline_test |
key_instance | The current key instance. | 10590018690 |
sla_time | The committed completion time. | 2024-07-30 17:30:00 |
buffer | The alert margin threshold for a baseline. Unit: minutes. | -1081 |
title | The title that specifies the alert type. | DataWorks_Baseline_Alert |
status | The status of the baseline. Valid values:
| overSla |
Event alerts
Message body
{
"message": {
"task_name": "Name of a failed task",
"event_type": "ERROR",
"task_owner_name": "dp3base",
"occur_time": "2024-07-30 23:06:06",
"event_name": "20240729-10000213793(Failed hour-level baseline)(24)-[project:lwt_test_hongkong]Error",
"title": "DataWorks_Event_Remind"
}
}
Fields
Field | Description | Example |
task_name | The name of the abnormal task. | failed_task |
event_type | The type of the event. Valid values:
| ERROR |
task_owner_name | The owner of the task. | dp3base |
occur_time | The time when the alert was triggered. | 2024-07-30 23:06:06 |
event_name | The name of the event. Format:
|
|
title | The title that specifies the alert type. | DataWorks_Event_Remind |