Transmettre les événements par push à l’instance à l’aide de l’API de service Web

Vous pouvez utiliser une interface de service Web, prise en charge par ServiceNow, qui fonctionne sur l’objet JSON comme le format d’entrée et de sortie de données.

Avant de commencer

Rôle requis : evt_mgmt_integration

Pourquoi et quand exécuter cette tâche

Pour insérer des enregistrements dans la table d’événements [em_event] en un seul appel, utilisez cette API de service Web :

https://<nominstance>.service-now.com/api/global/em/jsonv2

Remarque :

Les règles métier sur la table d’événements ne sont pas invoquées lorsque cette URL est utilisée.

N’ajoutez pas de champs supplémentaires à un événement en ajoutant un champ personnalisé à la table d’événements [em_event]. Toutefois, des champs supplémentaires doivent être inclus dans le champ Informations supplémentaires [additional_info] de l’événement. Pour plus d’informations sur l’inclusion de champs supplémentaires dans des événements, reportez-vous à la section Champs d’alerte personnalisés.

L’URL au format : http://<nominstance>.service-now.com/em_event.do?JSONv2&sysparm_action=insertMultiple est également prise en charge si vous souhaitez activer les règles métier. Cependant, les performances de la première URL sont supérieures.

Pour utiliser l’URL qui se termine par =insertMultiple, ajoutez les propriétés suivantes, avec leurs valeurs respectives, au serveur MID :

• « mid.probe.event.queue.compress » : valeur : faux
• « mid.probe.event.bulk_size » - valeur : 100
• « mid.probe.event.endpoint.url » : valeur : em_event.do ? JSONv2%26sysparm_action=insertMultiple

Procédure

1. Envoyez la demande avec les en-têtes suivants :

   Paramètre	Type	Description
   Accepter	Chaîne	Type acceptable pour ce message. La valeur par défaut est application/json.
   Type de contenu	Chaîne	Type de contenu pour ce message. La valeur par défaut est application/json.
   POST	Chaîne	Le type de demande est POST, avec un ou plusieurs enregistrements de fin.

2. Un ou plusieurs événements au format JSON peuvent être envoyés comme charge utile de l’appel de service web.
   Les champs d’événement qui doivent être renseignés sont les suivants :

   Variable	Description
   source	Le nom du type de source d’événement. Par exemple, SCOM ou SolarWinds.
   event_class	Instance spécifique du sourcefichier . Par exemple, SCOM 2012 du 20.10.30.40
   nœud	Le champ de nœud doit contenir un identificateur pour l’hôte (serveur/commutateur/routeur/autres) pour lequel l’événement a été déclenché. La valeur du champ de nœud peut être l’un des identificateurs suivants de l’hôte : Nom FQDN Adresse IP Adresse MAC Si elle existe dans la CMDB, cette valeur est également utilisée pour lier l’événement au CI ServiceNow correspondant.
   Ressource	Si l’événement fait référence à un appareil, tel qu’un disque, un processeur ou une carte réseau, ou à une application ou un service en cours d’exécution sur un hôte, le nom de l’appareil ou de l’application doit être renseigné dans ce champ. Par exemple, Disk C :\ ou Nic 001 ou l’application web Trade.
   metric_name	Nom de la mesure qui a déclenché l’alerte. Par exemple, Mémoire utilisée ou Utilisation totale du processeur.
   type	Le type d’événement. Ce type peut être similaire au champ metric_name , mais il est utilisé pour le regroupement général des types d’événements.
   message_key	Cette valeur est utilisée pour la déduplication des événements. Par exemple, il peut y avoir deux événements pour le même CI, où un événement a une CPU de 50 % et l’événement suivant une CPU de 99 %. Lorsque les deux événements doivent être mappés à la même alerte ServiceNow, ils doivent avoir la même clé de message. Le champ peut être laissé vide, auquel cas la valeur du champ est définie par défaut sur source+nœud+type+ressource+metric_name. Le message_key ne doit être renseigné que lorsqu’il existe un meilleur identificateur que l’identificateur par défaut.
   severity	Gravité de l’événement. Les valeurs ServiceNow pour la gravité vont de 1 – Critique à 5 – OK, avec la gravité 0 – Effacer. Les valeurs de gravité d’origine doivent être envoyées dans le cadre des informations supplémentaires.
   additional_info	Ce champ est au format clé/valeur JSON et est destiné à contenir toutes les informations susceptibles d’être utiles à l’utilisateur. Il n’est pas mappé à un champ d’événement ServiceNow prédéfini. Par exemple, les ID d’objets dans la source d’événement, la priorité de l’événement (si elle n’est pas identique à la gravité), les informations sur le groupe d’affectation, etc. Les valeurs du champ Informations supplémentaires d'un événement qui ne sont pas au format clé/valeur JSON sont normalisées au format clé/valeur JSON lorsque l'événement est traité.
   time_of_event	Heure à laquelle l’événement s’est produit sur l’origine de l’événement. Le format est : aaaa-MM-jj HH :mm :ss L’heure spécifiée doit être conforme à l’heure GMT.
   resolution_state	Facultatif : pour indiquer qu’un événement a été résolu ou ne se produit plus, certains moniteurs d’événements utilisent la gravité « effacer », tandis que d’autres moniteurs d’événements utilisent une valeur « proche » pour la gravité. Ce champ est utilisé pour les moniteurs qui proposent ce dernier. Les valeurs valides sont Nouveau et Fermeture.

3. Pour créer plusieurs enregistrements avec un seul appel, déclenchez le service Web d’événements à l’aide de l’URL suivante, où la variable < nom d’instance > est remplacée par le nom de l’instance requise :
   https://<nominstance>.service-now.com/api/global/em/jsonv2
   Exemple illustrant la charge utile pour deux événements envoyés dans un seul appel de service Web :

   {
     "records": [
       {
         "source": "SCOM",
         "event_class": "SCOM 2012 on scom.server.com",
         "resource": "D:",
         "node": "name.of.node.com",
         "metric_name": "Percentage Logical Disk Free Space",
         "type": "Disk space",
         "severity": "4",
         "description": "The disk D: on computer V-W2K8-abc.abc.com is running out of disk space. The value that exceeded the threshold is 38% free space.",
         "additional_info": {
           "scom-severity": "Medium",
           "metric-value": "38",
           "os_type": "Windows.Server.2008"
         }
       },
       {
         "source": "SCOM",
         "event_class": "SCOM 2012 on scom.server.com",
         "resource": "MSSQL-database-name",
         "node": "other.node.com",
         "metric_name": "DB Allocated Size (MB)",
         "type": "Database Storage",
         "severity": "3",
         "description": "High number of active connections for MSSQL-database-name running on name.of.node.com. Active connections exceed 5000.",
         "additional_info": {
           "scom-severity": "Medium",
           "metric-value": "38",
           "os_type": "Windows.Server.2008"
         }
       }
     ]
   }

4. Pour créer un enregistrement avec un seul appel, déclenchez le service Web d'événement à l'aide de l'URL suivante, où la variable <nominstance> est remplacée par le nom de l'instance requise :
   https://<nominstance>.service-now.com/api/global/em/jsonv2
   Exemple montrant la charge utile d'un événement envoyé dans un seul appel de service Web :

   {
     "records": [
       {
         "source": "SCOM",
         "event_class": "SCOM 2007 on scom.server.com",
         "resource": "C:",
         "node": "name.of.node.com",
         "metric_name": "Percentage Logical Disk Free Space",
         "type": "Disk space",
         "severity": "4",
         "description": "The disk C: on computer V-W2K8-dfg.dfg.com is running out of disk space. The value that exceeded the threshold is 41% free space.",
         "additional_info": {
           "scom-severity": "Medium",
           "metric-value": "38",
           "os_type": "Windows.Server.2008"
         }
       }
     ]
   }

   Exemple : demande cURL :

   {
     curl -X POST "https://<instancename>.service-now.com/api/global/em/jsonv2" \
     --header "Content-Type: application/json" \
     --user "username:password" \
     --data '{
       "records": [
         {
           "source": "SCOM",
           "event_class": "SCOM 2007 on scom.server.com",
           "resource": "C:",
           "node": "name.of.node.com",
           "metric_name": "Percentage Logical Disk Free Space",
           "type": "Disk space",
           "severity": "4",
           "description": "The disk C: on computer V-W2K8-dfg.dfg.com is running out of disk space. The value that exceeded the threshold is 41% free space.",
           "additional_info": {
             "scom-severity": "Medium",
             "metric-value": "38",
             "os_type": "Windows.Server.2008"
           }
         }
       ]
     }'
    

Concepts associés

• Transmettre les événements par push à l’API via le Serveur MID service Web