Ao usar um webhook personalizado para monitoramento e alertas no DataWorks, o DataWorks envia mensagens de alerta para o seu service de webhook pela rede pública por padrão. Selecione um método de conexão de acordo com o ambiente de implantação do service de webhook. Para usar a rede pública, adicione os endereços IP de saída pública do DataWorks à lista de permissões do service de webhook. Para usar a rede interna, especifique um grupo de recursos capaz de se conectar ao service de webhook na política de alertas do tenant — esse grupo de recursos será responsável pelo envio das mensagens. Isso garante a entrega das mensagens de alerta.
Observações de uso
Restrições de rede: Por padrão, as mensagens de alerta são enviadas pela rede pública. Se o seu service de webhook estiver implantado em uma rede interna, especifique um grupo de recursos que possa se conectar a ele na política de alertas do tenant — esse grupo de recursos ficará responsável pelo envio. Para mais informações sobre os dois métodos de conexão, consulte Public network mode e Internal network mode.
Restrições de edição: Webhooks personalizados são compatíveis apenas com o DataWorks Enterprise Edition.
Configuração de rede
Por padrão, o DataWorks envia mensagens de alerta para o seu service de webhook pela rede pública. Escolha o modo de rede pública ou o modo de rede interna de acordo com o ambiente de implantação do seu service de webhook.
Modo de rede pública
Por padrão, o DataWorks envia mensagens de alerta para o seu service de webhook pela rede pública, sem necessidade de configuração adicional de rede.
Ignore esta etapa se o seu service de webhook não utilizar controle de acesso baseado em lista de permissões.
Se o seu service de webhook utilizar lista de permissões para controle de acesso, adicione os seguintes endereços IP públicos do DataWorks a essa lista.
|
Nome da região |
ID da região |
Endereço IP |
|
China (Beijing) |
cn-beijing |
47.93.5.9,47.93.60.157,47.94.111.106,59.110.166.34,60.205.184.153,60.205.227.157,60.205.223.44,123.56.217.46,123.57.155.168,123.57.243.71 |
|
China (Zhangjiakou) |
cn-zhangjiakou |
39.100.0.109,39.100.9.117,39.100.9.121 |
|
China (Hangzhou) |
cn-hangzhou |
47.96.30.97,47.97.175.135,116.62.247.242,120.27.233.168,121.40.70.19,121.199.31.66,121.199.41.143,121.199.61.16 |
|
China (Shanghai) |
cn-shanghai |
47.100.10.242,47.101.166.155,47.101.179.29,47.101.196.116,101.132.179.94,106.14.1.102,106.15.197.122,106.15.202.114 |
|
China (Shenzhen) |
cn-shenzhen |
47.107.81.9,47.112.11.104,47.112.21.108,47.112.22.239,47.112.23.85 |
|
Malaysia (Kuala Lumpur) |
ap-southeast-3 |
47.254.198.127,47.254.200.185 |
|
Japan (Tokyo) |
ap-northeast-1 |
47.74.22.81,47.74.23.43 |
|
South Korea (Seoul) |
ap-northeast-2 |
47.80.13.207,47.80.10.92 |
|
China (Chengdu) |
cn-chengdu |
47.108.64.120,47.108.119.242 |
|
Singapore |
ap-southeast-1 |
47.74.209.97,47.74.229.187,47.74.243.124 |
|
Indonesia (Jakarta) |
ap-southeast-5 |
149.129.253.151,149.129.253.185 |
|
China (Hong Kong) |
cn-hongkong |
47.52.128.224,47.244.33.205 |
|
Germany (Frankfurt) |
eu-central-1 |
47.91.89.154,47.254.153.91 |
|
US (Virginia) |
us-east-1 |
47.89.191.99,47.90.253.133 |
|
US (Silicon Valley) |
us-west-1 |
47.88.4.25,47.88.6.226 |
|
UK (London) |
eu-west-1 |
8.208.12.7,8.208.15.6 |
|
SAU (Riyadh - Partner Region) |
me-central-1 |
8.213.30.84,8.213.30.232 |
Modo de rede interna
Se o seu service de webhook estiver implantado em uma rede interna, especifique um grupo de recursos capaz de se conectar a ele para o webhook personalizado na política de alertas do tenant. Esse grupo de recursos será responsável pelo envio das mensagens de alerta. Dessa forma, as mensagens não saem da rede interna e são transmitidas com maior segurança.
Faça login no DataWorks console e acesse o Operation Center. No painel de navegação à esquerda, clique em .
Clique em Tenant Alert Policy Settings.
Selecione um grupo de recursos capaz de conectar ao seu service de webhook em Custom Webhook Resource Group (apenas grupos de recursos Serverless são compatíveis) para concluir a configuração. Para mais informações sobre políticas de alertas do tenant, consulte Tenant alert policy settings. Para mais informações sobre como configurar a conectividade de rede de um grupo de recursos, consulte Configure network connectivity.
Se nenhum grupo de recursos for selecionado, os webhooks personalizados do tenant enviarão mensagens de alerta pela rede pública por padrão. Após a configuração entrar em vigor, uma mensagem aparecerá no topo da página Alert information, indicando que o envio baseado em grupo de recursos está ativado para webhooks personalizados no tenant atual. Clique em Modify Configuration na mensagem para alterar as configurações.
Formato das mensagens
O DataWorks envia mensagens de alerta para o seu service de webhook personalizado no formato JSON. As seções a seguir descrevem o payload do teste de conectividade, exemplos de corpo de mensagem e descrições de campos para cada tipo de alerta.
Teste de conectividade
{
"message":{
"content": "DataWorks Workbench Alarm Connectivity Test"
}
}
Alertas personalizados
Corpo da mensagem
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"
}
}Campos
Campo | Descrição | Exemplo |
title | O título do alerta. | DataWorks_Remind |
task_size | O número de tarefas. | 1 |
remind_name | O nome da regra de alerta. | webhookTest |
occur_time | O horário em que o alerta foi disparado. | 2021-07-13 16:16:20 |
remind_type | A condição de disparo. Valores válidos:
| completed |
node_id_list | Os IDs dos nós. Separe múltiplos IDs com vírgulas (,). O máximo suportado é cinco IDs de nó. | 220167523 |
node_name_list | Os nomes dos nós. Separe múltiplos nomes com vírgulas (,). O máximo suportado é cinco nomes de nó. | nodeName |
node_owner_list | Os proprietários dos nós. Separe múltiplos proprietários com vírgulas (,). O máximo suportado é cinco proprietários de nó. | 123123 |
remind_founder | O criador da regra de alerta. | jingyan20182222 |
remind_unit | A granularidade de monitoramento da regra de alerta. Valores válidos:
| Task |
number_of_alerts | O número de disparos do alerta (n-ésimo disparo). | 3 |
more_information | A URL da instância disparada automaticamente desejada no Operation Center. | http://XXXX |
threshold | O limiar. Este parâmetro está disponível apenas para grupos de recursos.
| 99 |
duration | A duração. Unidade: minutos. Este parâmetro está disponível apenas para grupos de recursos. | 30 |
Alertas de baseline
Corpo da mensagem
{
"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"
}
}Campos
Campo | Descrição | Exemplo |
cycle_number | O ID do ciclo da instância de baseline. O ID de um ciclo diário é | 1 |
occur_time | O horário em que o alerta foi disparado. | 2024-07-31 11:29:43 |
baseline_owners | O proprietário da baseline. | dp3base |
baseline_name | O nome da baseline. | baseline_test |
key_instance | A instância-chave atual. | 10590018690 |
sla_time | O prazo de conclusão comprometido. | 2024-07-30 17:30:00 |
buffer | O limiar de margem de alerta para uma baseline. Unidade: minutos. | -1081 |
title | O título que identifica o tipo de alerta. | DataWorks_Baseline_Alert |
status | O status da baseline. Valores válidos:
| overSla |
Alertas de evento
Corpo da mensagem
{
"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"
}
}
Campos
Campo | Descrição | Exemplo |
task_name | O nome da tarefa com anomalia. | failed_task |
event_type | O tipo do evento. Valores válidos:
| ERROR |
task_owner_name | O proprietário da tarefa. | dp3base |
occur_time | O horário em que o alerta foi disparado. | 2024-07-30 23:06:06 |
event_name | O nome do evento. Formato:
|
|
title | O título que identifica o tipo de alerta. | DataWorks_Event_Remind |