ServiceNow Incident Events

Le stream connector ServiceNow Incident Events vous permet d'envoyer des données depuis Centreon vers des instances ServiceNow Incident.

Avant de commencer

• Dans la plupart des cas, vous enverrez les données depuis le serveur central. Il est également possible de les envoyer depuis un serveur distant ou un collecteur (par exemple si vous voulez éviter que le serveur central ne représente un point de défaillance unique, ou bien si vous êtes un MSP et vous installez le stream connector sur un collecteur ou un serveur distant dans l'infratructure de votre client).
• Par défaut, le stream connector ServiceNow Incident Events envoie des évènements Broker host_status et service_status. Le format des évènements est décrit ici.
• Ces évènements sont envoyés à chaque contrôle sur l'hôte ou le service. Des paramètres dédiés vous permettent de ne pas envoyer certains évènements.

Installation

Faites l'installation sur le serveur qui enverra les données à ServiceNow Incident (serveur central, serveur distant, collecteur).

1. Connectez-vous en tant que root en utilisant votre client SSH préféré.

2. Exécutez la commande suivante :

Alma / RHEL / Oracle Linux 8

dnf install centreon-stream-connector-servicenow

Alma / RHEL / Oracle Linux 9

dnf install centreon-stream-connector-servicenow

Debian 12

apt install centreon-stream-connector-servicenow

Configurer votre équipement ServiceNow Incident

Vous devrez paramétrer votre équipement ServiceNow Incident pour qu'il puisse recevoir des données de la part de Centreon. Reportez-vous à la documentation ServiceNow Incident. Assurez-vous que ServiceNow Incident puisse recevoir les données envoyées par Centreon : les flux ne doivent pas être bloqués par la configuration de ServiceNow Incident ou par un équipement de sécurité.

Configurer le stream connector dans Centreon

1. Sur votre serveur central, allez à la page Configuration > Collecteurs > Configuration de Centreon Broker.
2. Cliquez sur central-broker-master (ou sur la configuration du Broker correspondant si les évènements seront envoyés par un serveur distant ou un collecteur).
3. Dans l'onglet Output, sélectionnez Generic - Stream connector dans la liste, puis cliquez sur Ajouter. Un nouvel output apparaît dans la liste.
4. Remplissez les champs de la manière suivante :

Champ	Valeur
Name	ServiceNow Incident events
Path	/usr/share/centreon-broker/lua/servicenow-incident-events-apiv2.lua
Filter category	Neb

5. Pour permettre à Centreon de se connecter à votre équipement ServiceNow Incident, remplissez les paramètres obligatoires suivants. La première entrée existe déjà. Cliquez sur le lien +Add a new entry en-dessous du tableau Filter category pour en ajouter un autre.

Type	Nom	Explication	Exemple de valeur
string	instance	the name of the ServiceNow instance	MyCompany
string	client_id	The Oauth client_id	Client_ID
string	client_secret	The Oauth client_secret	Client_Secret
string	username	The Oauth user	User
string	password	The Oauth password	Password

6. Renseignez les paramètres optionnels désirés (en utilisant le lien +Add a new entry) :

Type	Nom	Explication	Valeur par défaut
string	logfile	Fichier dans lequel les logs sont écrits	/var/log/centreon-broker/servicenow-incident-events.log
number	log_level	Niveau de verbosité des logs : de 1 (erreurs) à 3 (debug)	1
string	http_server_url	L'adresse du serveur ServiceNow	service-now.com
string	incident_table	Le nom de la table incident	incident
string	source	Le nom de la source de l'incident	centreon

7. Utilisez les paramètres optionnels du stream connector pour filtrer ou adapter les données que vous voulez que Centreon envoie à ServiceNow Incident.

8. Déployez la configuration.

9. Redémarrez centengine sur tous les collecteurs :

   systemctl restart centengine

ServiceNow Incident reçoit maintenant des données de Centreon. Pour tester le bon fonctionnement de l'intégration, voir Commandes curl : tester le stream connector.

Filtrer ou adapter les données que vous voulez envoyer à ServiceNow Incident

Tous les stream connectors ont un jeu de paramètres optionnels qui vous permettent de filtrer les données que vous enverrez à votre équipement ServiceNow Incident, de reformatter les données, de définir un proxy...

Chaque paramètre optionnel a une valeur par défaut, qui est indiquée dans la documentation correspondante.

• Pour surcharger la valeur par défaut d'un paramètre, cliquez sur le lien +Add a new entry en-dessous du tableau Filter category, afin d'ajouter un paramètre personnalisé. Par exemple, si vous ne voulez envoyer à ServiceNow Incident que les évènements traités par un collecteur nommé "poller-1", entrez :

  type = string
  name = accepted_pollers
  value = poller-1

• Pour le stream connector ServiceNow Incident Events, les données suivantes surchargent toujours les valeurs par défaut (il n'est pas nécessaire de les redéfinir dans l'interface).

Type	Nom	Valeur par défaut pour le stream connector
string	accepted_categories	neb
string	accepted_elements	host_status,service_status
string	host_status	1,2
string	service_status	1,2,3

Event bulking

Ce stream connector est compatible avec l'event bulking. Cela signifie qu'il est capable d'envoyer plus d'un évènement lors de chaque appel à l'API REST ServiceNow Incident.

Pour utiliser cette fonctionnalité, vous devez ajouter le paramètre suivant à la configuration de votre stream connector.

Type	Nom	Valeur
number	max_buffer_size	more than one

Format des évènements

Ce stream connector envoie des évènements au format suivant :

Évènement service_status

{
  "source": "centreon",
  "short_description": "CRITICAL  my_host my_service is not doing well",
  "cmdb_ci": "my_host",
  "comments": "HOST: my_host\n SERVICE: my_service\n OUTPUT: is not doing well"
}

Évènement host_status

{
  "source": "centreon",
  "short_description": "CRITICAL  my_host is not doing well",
  "cmdb_ci": "my_host",
  "comments": "HOST: my_host\n OUTPUT: is not doing well"
}

Format d'évènement personnalisé

Ce stream connector vous permet de modifier le format de l'événement en fonction de vos besoins. Seule la partie event du json est personnalisable. Il vous permet également de gérer des types d'événements qui ne sont pas gérés par défaut, tels que les événements ba_status.

Pour utiliser cette fonctionnalité, vous devez configurer un fichier json de format d'événement et ajouter un nouveau paramètre de connecteur de flux.

Type	Nom	Valeur
string	format_file	/etc/centreon-broker/servicenow-incident-events-format.json

Le fichier de configuration du format des événements doit être lisible par l'utilisateur centreon-broker.

Pour en savoir plus sur les formats d'événements personnalisés et les fichiers modèles, consultez cette page.

Commandes Curl : tester le stream connector

Si vous voulez tester que les commandes de configuration sont envoyées à ServiceNow Incident correctement, utilisez les commandes curl suivantes.

Vous devez remplacer tous les <xxxx> à l'intérieur des commandes ci-dessous par leur valeur appropriée. <instance>` peut devenir MyCompany.

Get OAuth tokens

1. Connectez-vous au serveur que vous avez configuré pour envoyer les évènements à ServiceNow Incident (le serveur central, un serveur distant ou un collecteur).
2. Exécutez la commande suivante :

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" 'https://<instance_name>.service-now.com/oauth_token.do' -d 'grant_type=password&client_id=<client_id>&client_secret=<client_secret>&username=<username>&password=<password>'

3. Vérifier que la commande renvoie le token attendu.

Refresh OAuth tokens

1. Connectez-vous au serveur que vous avez configuré pour envoyer les évènements à ServiceNow Incident (le serveur central, un serveur distant ou un collecteur)
2. Exécutez la commande suivante :

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" 'https://<instance_name>.service-now.com/oauth_token.do' -d 'grant_type=refresh_token&client_id=<client_id>&client_secret=<client_secret>&username=<username>&password=<password>&refresh_token=<refresh_token>'

Le <refresh_token> est obtenu grâce à cette commande curl.

3. Vérifier que la commande renvoie le token attendu.

Envoyer des évènements

1. Connectez-vous au serveur que vous avez configuré pour envoyer les évènements à ServiceNow Incident (le serveur central, un serveur distant ou un collecteur)
2. Exécutez la commande suivante :

curl -X POST -H "content-type: application/json" -H "DD-API-KEY: <api_key>" '<http_server_url><servicenow_event_endpoint>' -d '{"title":"CRITICAL my_host my_service","text":"my service is not working","aggregation_key":"service_27_12","alert_type":"error","host":"my_host","date_happened":1630590530}'

Le <refresh_token> est obtenu grâce à cette commande curl.

3. Vérifiez que l'évènement a bien été reçu par ServiceNow Incident.