Versions Compared

Old Version 2

changes.mady.by.user Guillaume ROY

Saved on

compared with

New Version 3

changes.mady.by.user Guillaume ROY

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


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 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ètreObligatoireValeur par défautValeurs possiblesExemples
typeOUIPour plus d'informations, consulter la partie sur les types de rapportsfilterOUIChaîne de caractère : séparateur "/". Possibilité d'utiliser "*" pour sélectionner tous les checks d'un hôte ou un clusterdateBeginOUI
Date dans le format "AAAA-MM-JJ"2017-07-01
dateEndOUI
Date dans le format "AAAA-MM-JJ"2017-07-31
typeOUI
Consulter la partie sur les types de rapportsnormal/cluster/
filterOUI
Chaîne de caractère contenue dans le nom de l'élément filtré


all_oracle
loginNONuser nom d'utilisateur depuis le cookieLe nom de l'utilisateur encodé en base64YWRtaW4=
passwordNONmot de passe depuis le cookieLe mot de passe de l'utilisateur encodé en base64
show_downtimeNONonon et off (pas encore implémenté)
show_ackNONonon et off (pas encore implémenté)
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 obligatoire au minimum(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. Voici un tableau explicatif

Type de filtreDescriptionExemplenormal/clusterétat d'un clusternormal/cluster_oracle_srvnormal/hostétat d'un hôtenormal/shinkennormal/checkétat d'un checknormal/cpunormal/host_templateétat des hôtes qui ont ce templatenormal/linuxnormal/hostgroupétat des hôtes contenu dans un groupe d'hôtenormal/france

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 D'autres types de rapport seront ajoutés ultérieurement :

dependency et de toutes ses dépendances avec un checkdependency/cluster_oracle_srv/connected-usersclustercheck cluster et de ses checkscluster_oracle_srv* hôte et de ses checksshinken/cpunormal/check et checks linux/cpunormal/check et checks contenu
Type de filtreDescriptionExemple
normal/cluster/état d'un cluster et de toutes ses dépendancesdependency/cluster_oracle_srvdependency/cluster/checkAffiche l'état d'un cluster.
normal/host/Affiche l'état d'un hôte.
normal/check/normal/host/checkAffiche 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 template.
normal/hostgroup/Affiche l'état des hôtes contenus 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=YWRtaW4cGFzc3dvcmQ= : 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
languagebash
$ 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.