Configurer le contexte du collecteur d'événements MID WebService

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 4 minutes de lecture
  • Configurez le contexte du collecteur d'événements MID WebService pour fournir une méthode d'URL pour transmettre par push les messages d'événements d'une source externe au Serveur MID.

    Avant de commencer

    Assurez-vous que le module d’extension Gestion des événements Connecteurs (sn_em_connector) est installé sur l’instance Now Platform .

    Rôle requis : evt_mgmt_admin

    Pourquoi et quand exécuter cette tâche

    Le format par défaut de l'URL pour transmettre par push les messages d'événements d'une source externe au Serveur MID est le suivant : http://{IP_MID_Server}:{port_MID_Web_Server}/api/mid/em/jsonv2. Cette URL assure des performances optimales.

    À partir d'une source externe, pour transmettre par push les messages d'événements qui ne sont pas au format jsonv2, le format de l'URL est le suivant : http://{IP_MID_Server}:{port_MID_Web_Server}/api/mid/em/inbound_event??Transform={nom_du_script_de_conversion}, où la variable {nom_du_script_de_conversion} correspond au nom complet du script et commence toujours par le texte : TransformEvents_.

    Par exemple, prenons les valeurs suivantes :
    • {IP_MID_Server} : 10.118.69.27
    • {port_MID_Web_Server} : 8097
    • Nom du script de conversion : EventsToProcess
    L’URL à utiliser est donc la suivante : http://10.118.69.27:8097/api/mid/em/inbound_event/TransformEvents_EventsToProcess
    Remarque :
    • L'URL au format http://{IP_MID_Server}:{port_MID_Web_Server}/api/mid/em/{nom_script_conversion}est également prise en charge.
    • Le format de date pour les événements est le suivant : aaaa-M-d h:mm:ss.

      Si vous recevez un événement dont la date est dans un format différent, vous devez utiliser un {nom_du_script_de_conversion} approprié au format de date de l'événement à venir, auquel cas l'événement ne sera pas traité correctement.

      Par exemple, si un événement se produit le 27 juin 2019 à 11 h 25 avec une date répertoriée de 2019/06/27/ 11:25:00 a, utilisez une valeur {nom_du_script_de_conversion} avec un format de date de yyyy/MM/dd/ HH:mm:ss a pour qu'elle corresponde au format de l'événement reçu.

    Procédure

    1. Accédez à la Tous > Gestion des événements > Intégrations > Écouteur d'événement de MID WebService.
    2. Dans la liste Contextes du collecteur d'événements MID WebService, cliquez sur Nouveau.
    3. Renseignez les champs du formulaire.
      Tableau 1. Formulaire Contexte des collecteurs d'événements MID WebService
      Champ Description
      Nom Nom unique pour ce collecteur pour une identification facile.
      Description courte Saisissez une brève description significative de ce collecteur.
      Extension MID Web Server Spécifiez, puis démarrez l'extension MID Web Server. Les méthodes d'authentification prises en charge sont répertoriées dans le champ Type d'authentification de l'extension MID Web Server. Pour en savoir plus sur la configuration d'une extension MID Web Server, consultez la rubrique Configurer l'extension MID Web Server.
      États Ce champ est automatiquement renseigné avec l'état de l'extension MID Web Server. Ce champ est vide tant que l'extension MID Web Server n'est pas démarrée. Après avoir émis une commande à l'extension MID Web Server, l'une des valeurs suivantes s'affiche :
      • A démarré : le collecteur est en cours d'exécution.
      • Est arrêté : le collecteur n'est pas en cours d'exécution.
      • Hors-ligne : le Serveur MID est en panne.
      • Erreur : le collecteur a échoué avec une erreur (le message d'erreur s'affiche dans Message d'erreur).
      • Avertissement : une exception d'exécution s'est produite.
      Exécuter sur Serveur MID spécifique ou grappe de Serveur MID spécifique, tel que défini sur l’extension du serveur Web MID spécifiée.
      Serveur MID MID Server spécifique ou Cluster de MID Server spécifique, tel que défini sur l'extension MID Web Server spécifiée.
      Exécution sur Nom du Serveur MID sur lequel l'extension MID Web Server est exécutée.
    4. Cliquez avec le bouton droit de la souris sur le titre du formulaire, puis cliquez sur Enregistrer.
    5. Sous Liens connexes, cliquez sur Démarrer pour démarrer le collecteur.
      Tableau 2. Commandes dans le formulaire de contexte Gestion des événements
      Lien connexe Description
      Début Démarre le collecteur s'il n'est pas en cours d'exécution. Cette action vérifie qu'un point de terminaison d'API de service Web avec l'application Gestion des événements est en cours d'exécution sur le Serveur MID.
      Arrêter Arrête l'exécution du collecteur sur le Serveur MID configuré. Si le collecteur n'est pas en cours d'exécution, aucune action n'est effectuée.
      Redémarrer Arrête, puis démarre le collecteur sur le Serveur MID configuré.
      Mettre à jour les paramètres Envoie des paramètres mis à jour au collecteur. Les paramètres sont également mis à jour lorsque l'extension de contexte Gestion des événements Serveur MID est mise à jour. Si vous cliquez sur ce contrôle et que le collecteur n'est pas en cours d'exécution, aucune mise à jour n'est effectuée.

    Exemple

    Affichage de l'utilisation de l'URL pour convertir les messages d'événements au format JSON v2

    Supposons que les messages d'événement au format JSON v2 sont envoyés au Serveur MID. Lors de l'utilisation de l'URL jsonv2, il n'est pas nécessaire d'utiliser un script Include.

    Tableau 3. Données pour l'exemple JSON v2
    Champ Valeur
    MID_Server_IP 10.218.64.27
    MID_Web_Server_Extension_Port 8097
    Format du message d'événement jsonv2

    Remplacez les variables au format par défaut de l'URL http://<mon-instance>.service-now.com/api/global/em/jsonv2 par les valeurs de la table précédente : http://10.218.64.27:8097/api/global/em/jsonv2

    Exemple montrant l'URL pour transmettre des messages qui ne sont pas au format jsonv2

    Le format de l'URL pour transmettre des messages d'événement à partir d'une source externe qui ne sont pas au format jsonv2 est la suivante : http://{IP_MID_Server}:{port_MID_Web_Server}/api/mid/em/inbound_event/Transform={nom_du_script_de_conversion}, où la variable {nom_du_script_de_conversion} correspond au nom complet du script et commence toujours par le texte : TransformEvents_. Le nom du script doit être spécifié en tant que paramètre d'en-tête Transform et doit toujours commencer par le préfixe TransformEvents_.

    Pour cet exemple, supposons que le nom du script est EventsToProcess ; l'URL est donc la suivante : http://10.138.64.27:8097/api/mid/em/inbound_event/TransformEvents_EventsToProcess

    Exemple d'affichage des messages d'événement au format JSON v2
    Remarque :
    lorsque vous copiez-collez le texte suivant, il est possible que les caractères masqués soient également copiés, ce qui peut entraîner des résultats inattendus.
    
    curl -v -H "Accept: application/json" -H "Content-Type: application/json" -X POST --data "{
        "records":
        [ {
             \"source\" : \"Simulated\",
            \"node\" : \"nameofnode\",
            \"type\" : \"High Virtual Memory\",
            \"resource\" : \"C:\",
            \"severity\" : \"5\",
            \"description\" : \"Virtual memory usage exceeds 98%\",
            \"ci_type\":\"cmdb_ci_app_server_tomcat\",
            \"additional_info\":\"{\\\"name\\\":\\\"My Airlines\\\"}\"
          },
          {
          \"source\" : \"Simulated\",
          \"node\" : \"01.myairlines.com\",
          \"type\" : \"High CPU Utilization\",
          \"resource\" : \"D:\",
          \"severity\" : \"5\",
          \"description\" : \"CPU on 01.my.com at 60%\"
          }
       ]
    }" -u UserName:Password http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/jsonv2