Lorsque vous utilisez un webhook personnalisé pour la surveillance et les alertes DataWorks, DataWorks transmet par défaut les messages d'alerte à votre service webhook via le réseau public. Choisissez une méthode de connexion en fonction de l'environnement de déploiement du service webhook. Pour utiliser le réseau public, ajoutez les adresses IP de sortie publiques de DataWorks à la liste d'autorisation du service webhook. Pour utiliser le réseau interne, spécifiez un groupe de ressources capable de se connecter au service webhook dans la politique d'alerte du locataire ; ce groupe de ressources envoie alors les messages d'alerte. Cette approche garantit la livraison des alertes.
Remarques
Limites réseau : Par défaut, les messages d'alerte sont transmis via le réseau public. Si votre service webhook est déployé sur un réseau interne, spécifiez, dans la politique d'alerte du locataire, un groupe de ressources capable de se connecter au service webhook. Ce groupe de ressources envoie alors les messages d'alerte. Pour plus d'informations sur ces deux méthodes de connexion, consultez les sections Mode réseau public et Mode réseau interne.
Limites d'édition : Les webhooks personnalisés sont pris en charge uniquement dans l'édition Enterprise de DataWorks.
Configuration réseau
Par défaut, DataWorks transmet les messages d'alerte à votre service webhook via le réseau public. Selon l'environnement de déploiement de votre service webhook, choisissez le mode réseau public ou le mode réseau interne.
Mode réseau public
Par défaut, DataWorks transmet les messages d'alerte à votre service webhook via le réseau public. Aucune configuration réseau supplémentaire n'est requise.
Ignorez cette étape si votre service webhook n'utilise pas de contrôle d'accès basé sur une liste d'autorisation.
Si votre service webhook utilise une liste d'autorisation pour le contrôle d'accès, ajoutez les adresses IP publiques suivantes de DataWorks à cette liste.
|
Nom de la région |
ID de région |
Adresse IP |
|
Chine (Pékin) |
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 |
|
Chine (Zhangjiakou) |
cn-zhangjiakou |
39.100.0.109,39.100.9.117,39.100.9.121 |
|
Chine (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 |
|
Chine (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 |
|
Chine (Shenzhen) |
cn-shenzhen |
47.107.81.9,47.112.11.104,47.112.21.108,47.112.22.239,47.112.23.85 |
|
Malaisie (Kuala Lumpur) |
ap-southeast-3 |
47.254.198.127,47.254.200.185 |
|
Japon (Tokyo) |
ap-northeast-1 |
47.74.22.81,47.74.23.43 |
|
Corée du Sud (Séoul) |
ap-northeast-2 |
47.80.13.207,47.80.10.92 |
|
Chine (Chengdu) |
cn-chengdu |
47.108.64.120,47.108.119.242 |
|
Singapour |
ap-southeast-1 |
47.74.209.97,47.74.229.187,47.74.243.124 |
|
Indonésie (Jakarta) |
ap-southeast-5 |
149.129.253.151,149.129.253.185 |
|
Chine (Hong Kong) |
cn-hongkong |
47.52.128.224,47.244.33.205 |
|
Allemagne (Francfort) |
eu-central-1 |
47.91.89.154,47.254.153.91 |
|
États-Unis (Virginie) |
us-east-1 |
47.89.191.99,47.90.253.133 |
|
États-Unis (Silicon Valley) |
us-west-1 |
47.88.4.25,47.88.6.226 |
|
Royaume-Uni (Londres) |
eu-west-1 |
8.208.12.7,8.208.15.6 |
|
Arabie saoudite (Riyad - Région partenaire) |
me-central-1 |
8.213.30.84,8.213.30.232 |
Mode réseau interne
Si votre service webhook est déployé sur un réseau interne, spécifiez, pour le webhook personnalisé dans la politique d'alerte du locataire, un groupe de ressources capable de se connecter au service webhook. Ce groupe de ressources envoie les messages d'alerte. Ainsi, les alertes ne quittent pas le réseau interne et leur transmission est plus sécurisée.
Connectez-vous à la console DataWorks et accédez au Centre d'opérations. Dans le volet de navigation de gauche, cliquez sur .
Cliquez sur Tenant Alert Policy Settings.
Sélectionnez un groupe de ressources capable de se connecter à votre service webhook pour le paramètre Custom Webhook Resource Group (seuls les groupes de ressources Serverless sont pris en charge) afin de finaliser la configuration. Pour plus d'informations sur les politiques d'alerte du locataire, consultez la section Paramètres de la politique d'alerte du locataire. Pour savoir comment configurer la connectivité réseau d'un groupe de ressources, consultez la section Configurer la connectivité réseau.
Si aucun groupe de ressources n'est sélectionné, les webhooks personnalisés du locataire envoient par défaut les messages d'alerte via le réseau public. Une fois la configuration appliquée, un message s'affiche en haut de la page Informations sur les alertes, indiquant que l'envoi basé sur un groupe de ressources est activé pour les webhooks personnalisés du locataire actuel. Cliquez sur Modify Configuration dans ce message pour modifier les paramètres.
Format des messages
DataWorks envoie les messages d'alerte à votre service webhook personnalisé au format JSON. Les sections suivantes décrivent la charge utile du test de connectivité, des exemples de corps de message et la description des champs pour chaque type d'alerte.
Test de connectivité
{
"message":{
"content": "DataWorks Workbench Alarm Connectivity Test"
}
}
Alertes personnalisées
Corps du message
Alertes pour les instances déclenchées automatiquement
{
"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://..."
}
} Alertes pour les groupes de ressources
{
"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"
}
}Champs
Champ | Description | Exemple |
title | Le titre de l'alerte. | DataWorks_Remind |
task_size | Le nombre de tâches. | 1 |
remind_name | Le nom de la règle d'alerte. | webhookTest |
occur_time | L'heure de déclenchement de l'alerte. | 2021-07-13 16:16:20 |
remind_type | La condition de déclenchement. Valeurs possibles :
| completed |
node_id_list | Les ID des nœuds. Séparez plusieurs ID par des virgules (,). Un maximum de cinq ID de nœud est pris en charge. | 220167523 |
node_name_list | Les noms des nœuds. Séparez plusieurs noms par des virgules (,). Un maximum de cinq noms de nœud est pris en charge. | nodeName |
node_owner_list | Les propriétaires des nœuds. Séparez plusieurs propriétaires par des virgules (,). Un maximum de cinq propriétaires de nœud est pris en charge. | 123123 |
remind_founder | Le créateur de la règle d'alerte. | jingyan20182222 |
remind_unit | La granularité de surveillance de la règle d'alerte. Valeurs possibles :
| Task |
number_of_alerts | Le nième déclenchement de l'alerte. | 3 |
more_information | L'URL de l'instance déclenchée automatiquement souhaitée dans le Centre d'opérations. | http://XXXX |
threshold | Le seuil. Ce paramètre est disponible uniquement pour les groupes de ressources.
| 99 |
duration | La durée. Unité : minutes. Ce paramètre est disponible uniquement pour les groupes de ressources. | 30 |
Alertes de baseline
Corps du message
{
"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"
}
}Champs
Champ | Description | Exemple |
cycle_number | L'ID du cycle de l'instance de baseline. L'ID d'un cycle quotidien est | 1 |
occur_time | L'heure de déclenchement de l'alerte. | 2024-07-31 11:29:43 |
baseline_owners | Le propriétaire de la baseline. | dp3base |
baseline_name | Le nom de la baseline. | baseline_test |
key_instance | L'instance clé actuelle. | 10590018690 |
sla_time | L'heure de fin convenue. | 2024-07-30 17:30:00 |
buffer | Le seuil de marge d'alerte pour une baseline. Unité : minutes. | -1081 |
title | Le titre qui spécifie le type d'alerte. | DataWorks_Baseline_Alert |
status | L'état de la baseline. Valeurs possibles :
| overSla |
Alertes d'événement
Corps du message
{
"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"
}
}
Champs
Champ | Description | Exemple |
task_name | Le nom de la tâche anormale. | failed_task |
event_type | Le type d'événement. Valeurs possibles :
| ERROR |
task_owner_name | Le propriétaire de la tâche. | dp3base |
occur_time | L'heure de déclenchement de l'alerte. | 2024-07-30 23:06:06 |
event_name | Le nom de l'événement. Format :
|
|
title | Le titre qui spécifie le type d'alerte. | DataWorks_Event_Remind |