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'URL à utiliser 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. Voici un tableau récapitulatif de ces paramètres :
| Nom du paramètre | Obligatoire | Valeur par défaut | Valeurs possibles |
|---|---|---|---|
| type | OUI | Pour plus d'informations, consulter la partie sur les types de rapports | |
| filter | OUI | Chaîne de caractère : séparateur "/". Possibilité d'utiliser "*" pour sélectionner tous les checks d'un hôte ou un cluster | |
| dateBegin | OUI | Date dans le format "AAAA-MM-JJ" | |
| dateEnd | OUI | Date dans le format "AAAA-MM-JJ" | |
| login | NON | user depuis le cookie | Le nom de l'utilisateur encodé en base64 |
| password | NON | mot de passe depuis le cookie | Le mot de passe de l'utilisateur encodé en base64 |
| show_downtime | NON | on | on et off (pas encore implémenté) |
| show_ack | NON | on | on et off (pas encore implémenté) |
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 obligatoire au minimum:
- 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é
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. Voici un tableau explicatif
| Type de filtre | Description | Exemple |
|---|---|---|
| normal/cluster | état d'un cluster | normal/cluster_oracle_srv |
| normal/host | état d'un hôte | normal/shinken |
| normal/check | état d'un check | normal/cpu |
| normal/host_template | état des hôtes qui ont ce template | normal/linux |
| normal/hostgroup | état des hôtes contenu dans un groupe d'hôte | normal/france |
D'autres types de rapport seront ajoutés ultérieurement :
| Type de filtre | Description | Exemple |
|---|---|---|
| dependency/cluster | état d'un cluster et de toutes ses dépendances | dependency/cluster_oracle_srv |
| dependency/cluster/check | état d'un cluster et de toutes ses dépendances avec un check | dependency/cluster_oracle_srv/connected-users |
| normal/cluster/check | état d'un cluster et de ses checks | normal/cluster_oracle_srv/* |
| normal/host/check | état d'un hôte et de ses checks | normal/shinken/cpu |
| normal/host_template/check | état des hôtes et checks qui ont ce template | normal/linux/cpu |
| normal/hostgroup/check | état des hôtes et checks contenu dans un groupe d'hôte | normal/france/cpu |
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=YWRtaW4= : 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.
| Info |
|---|
| Pour exploiter ce rapport, voir la partie concernant les Rapport CSV. |