Les Logs d'utilisation de l'API Rest V2
Description des logs
Le fichier de log sera dans le répertoire : /var/log/shinken/brokers/modules/broker-module-livedata_API-REST
Le nom du fichier de log est par défaut : api_v2.log ( modifiable via le paramètre du module : broker_module_livedata__rest_api_log__file_name )
Chaque appel loguera les informations suivantes en fonction du API-REST_log_level :
| Niveau de log | Ce qui est logué | Description ( ) | exemple |
|---|---|---|---|
| NORMAL | Date | date au format humain [ YYYY-MM-DD HH:MM:SS ] | [ 2020-11-12 15:03:38 ] |
| NORMAL | TYPE du log | [ INFO / WARNING / ERROR ] Toujours 7 caractères pour gérer l'alignement du log. | [ INFO ] |
| NORMAL | TYPE de l'appel | [ READ / CREATE / UPDATE / DELETE ] Méthode de l'appel, utile pour la notion de droit d’accès défini pour les utilisateurs dans l'interface de configuration | [ READ ] |
| NORMAL | URL | L'appel demandé | [ inventory/ ] |
| NORMAL | Code Retour | Valeur de retour de l'appel [ RESULT: XXX ] 200, 400, 500, ... | [ RESULT:200 ] |
| NORMAL | Le temps d’exécution de l'appel | en millisecondes [ TIME: XXXXXXms ] | [ TIME: 357ms ] |
| VERBOSE | Corps de la requête | Les paramètres de l’appel [ PARAMETERS: { params } ] | [ PARAMETERS:{ "sort" : "father_name":"desc"~"status":"asc", "checks_in_tree": "false" } ] |
| NORMAL | UIID de l'utilisateur | [ USER:SEUIID ] | [ USER:123456789123 ] |
| VERBOSE | UIID et Nom de l'utilisateur | [ USER:SEUIID / USER_NAME ] | [ USER:123456789123 / John Doe ] |
| NORMAL | Address IP Source | [ CALL_BY:XXX.XXX.XXX.XXX ] Après CALL_BY: L'adresse fait toujours au mininum 15 caractères ( différence entre IPV4 et IPV6 ). Si elle est plus petite, il y a des espaces devant pour atteindre 15 caractères. | [ CALL_BY: 192.168.1.42 ] |
Les logs seront tournés tous les jours à minuit, et après rotation, seuls les 5 derniers fichiers sont gardés.
Exemple de logs
[ 2020-11-12 15:03:38 ] [ READ ] [ inventory/ ] [ RESULT:200 ] [ TIME: 357ms ] [ USER:123456789123 ] [ CALL_BY:192.168.1.42 ]
[ 2020-11-12 15:03:38 ] [ READ ] [ inventory/ ] [ RESULT:200 ] [ TIME: 357ms ] [ PARAMETERS:{ "sort" : "father_name":"desc"~"status":"asc", "checks_in_tree": "false" } ] [ USER:123456789123/John Doe ] [ CALL_BY:192.168.1.42 ]