Les Rapports par URL peuvent être crées depuis un navigateur mais également depuis une ligne de commande ou un script, ce qui permet sa génération automatique depuis un crontab ou bien un ordonnanceur.
L'adresse IP utilisée dans l'URL sera celle du broker.
Le rapport généré sera le même que les Rapport CSV.
Les paramètres
Pour générer un rapport depuis l'URL, vous avez besoin de déterminer différents paramètres. Ceux-ci seront envoyés par une requête HTTP de type GET. Voici un tableau récapitulatif de ces paramètres :
| Nom du paramètre | Obligatoire | Valeur par défaut | Valeurs possibles | Exemples |
|---|---|---|---|---|
| dateBegin | OUI | Date dans le format "AAAA-MM-JJ" | 2017-07-01 | |
| dateEnd | OUI | Date dans le format "AAAA-MM-JJ" | 2017-07-31 | |
| type | OUI | Consulter la partie sur les types de rapports | normal/cluster/ | |
| filter | OUI | Chaîne de caractère contenue dans le nom de l'élément filtré | all_oracle | |
| login | NON | nom d'utilisateur depuis le cookie | Le nom de l'utilisateur encodé en base64 | YWRtaW4= |
| password | NON | mot de passe depuis le cookie | Le mot de passe de l'utilisateur encodé en base64 | cGFzc3dvcmQ= |
Pour utiliser ces paramètres, il vous faut
- l'adresse du broker : http://ip-serveur-shinken:7767
- l'adresse de l'API des rapports (celle-ci est fixe) : /reporting-csv
- la liste de tous les paramètres (obligatoires et facultatifs):
- Le premier paramètre est précédé d'un "?".
- Les paramètres suivants sont ajouté par un "&".
- Les noms des paramètres sont suivit d'un "=" puis de la valeur souhaitée.
- Aucun espace n'est autorisé.
- Si un paramètre obligatoire est manquant, le serveur générera une erreur 400 (Bad Request).
Ce qui nous donne par exemple : http://ip-serveur-shinken:7767/reporting-csv?dateBegin=2017-07-01&dateEnd=2017-07-31&type=normal/host/&filter=Shinken
Les types de rapports
Il est possible de générer différents types de rapport avec l'URL. Le type de rapport choisit (en complément avec le filtre) vous permet de choisir quels seront les éléments affichés.
Ce paramètre est obligatoire. S'il est absent ou mal orthographié, une erreur 400 (Bad Request) vous sera retournée.
Voici les différents types de filtres disponibles :
| Type de filtre | Description |
|---|---|
| normal/cluster/ | Affiche l'état d'un cluster. |
| normal/host/ | Affiche l'état d'un hôte. |
| normal/check/ | Affiche l'état d'un check sur les différents hôtes sur lesquels il est présent. |
| normal/host_template/ | Affiche l'état des hôtes qui ont ce templatemodèle. |
| normal/hostgroup/ | Affiche l'état des hôtes contenus dans un groupe d'hôte. |
Génération du rapport
Voici par exemple l'URL suivante :
http://ip-serveur-shinken:7767/reporting-csv?login=YWRtaW4=&password=YWRtaW4=&dateBegin=2017-07-01&dateEnd=2017-07-31&type=normal/host/&filter=Shinken
Dans cet exemple, les paramètres utilisés sont les suivants:
- login=YWRtaW4= : représente le base64 du nom d'utilisateur
- password=cGFzc3dvcmQ= : représente le base64 du mot de passe
- dateBegin=2017-07-01 : la date de début du rapport
- dateEnd=2017-07-31 : la date de fin du rapport
- type=normal/host/ : le type de rapport
- filter=Shinken : le filtre sur la valeur "Shinken"
Cette URL peut être utilisée pour générer ce rapport depuis un navigateur ou bien depuis une console linux avec la commande wget ou encore cURL.
Ex. :
| Code Block | ||
|---|---|---|
| ||
$ wget -O 2017-07_rapport-host_shinken.csv "http://ip-serveur-shinken:7767/reporting-csv?login=YWRtaW4= &password=cGFzc3dvcmQ=&dateBegin=2017-07-01&dateEnd=2017-07-31&type=normal/host/&filter=Shinken" --2017-08-24 09:24:01-- http://ip-serveur-shinken:7767/reporting-csv?login=YWRtaW4=&password=cGFzc3dvc mQ=&dateBegin=2017-07-01&dateEnd=2017-07-31&type=normal/host/&filter=Shinken Connecting to ip-serveur-shinken:7767... connected. HTTP request sent, awaiting response... 200 OK Length: 842 [text/csv] Saving to: ‘2017-07_rapport-host_shinken.csv’ 100%[===================================================================>] 842 --.-K/s in 0s 2017-08-24 09:24:01 (127 MB/s) - ‘2017-07_rapport-host_shinken.csv’ saved [842/842] |
| Info |
|---|
| Pour exploiter ce rapport, voir la partie concernant les Rapport CSV. |