Description des fichiers de log


Les fichiers de log sont des fichiers texte qui enregistrent, via des sondes et de manière chronologique, les événements d'activité des serveurs Logo - EasyVista.png. Ils permettent de comprendre la provenance d'une erreur en cas de bug, d'identifier les problèmes de performance, ...

  • Les sondes à activer et le paramétrage sont définis dans un fichier de configuration .ini par application.
  • Un fichier de log est généré pour chaque sonde activée.

Remarques

  • Les mots de passe ne sont pas affichés dans les fichiers de log.

Attention

  • Certaines sondes d'activité, très consommatrices en CPU, peuvent dégrader fortement les performances de l'application. De plus, la taille du fichier de log peut devenir très volumineux. Pour ces raisons, il est recommandé de ne pas utiliser ces sondes (indiquées ci-dessous en rouge) sur une base de production.

Les fichiers de log générés

Fichiers de log des sondes

  • Ces fichiers sont créés automatiquement dès que la sonde est activée.
  • Chaque fichier cumule les valeurs journalières de la sonde.
  • Format des fichiers : XML.
  • Un fichier est créé chaque jour, permettant d'avoir un historique des événements d'activité de la sonde.
    • Nom des fichiers = <nomApplication><nomSonde>_<dateYYMMJJ>.xml
               Example documentation icon FR.png  SMO_MSSQLException_190125.xml, SMO_MSSQLException_190124.xml, SMO_MSSQLException_190123.xml
    • Un fichier .xsl est généré pour chaque application, permettant d'avoir un affichage visible de l'ensemble des fichiers .xml.
               Example documentation icon FR.png  SMO_MSSQLException.xsl

Fichier LogConfig.txt

Ce fichier contient toutes les modifications effectuées sur les tables de configuration. 

  • Ce fichier est toujours créé.
  • Format du fichier : JSON.

Liste des sondes

Contenu d'un fichier de log d'une sonde

Tous les fichiers de log contiennent au moins les informations principales ci-dessous.

  • Code erreur
  • Plateforme
  • Fonction SMO Serveur (InterfaceName)
  • Host : Serveur sur lequel tourne le SMO Serveur
  • Remote : Machine ayant fait l'appel (ex. : Serveur PHP)
  • Versions des bases
  • Input : Toutes les informations et paramètres passés au SMO Serveur pour la requête
  • Pour les événements de type SQL :
    • Type de requête SQL
    • Requête reçue, requête bindée, requête envoyée au serveur SQL
    • Contexte de connexion : Initialisation et contexte info

Descriptif des différentes sondes

  • ltInterface : Logue tous les appels au SMO Serveur depuis le PHP.
    • Attention : Cette sonde peut dégrader les performances de l'application. Elle est donc déconseillée sur une base de production.
  • ltApplication : Logue les fonctions d'initialisation et tous les appels.
    Pour le SMO Serveur :
    • Il s'agit des appels qui viennent du Broker et des autres modules (internes au SMO Serveur, mis à part les workflows, l'envoi d'e-mails, ...). 
    • Elle ne contient pas les appels issus du PHP. 
    • Attention : Cette sonde peut dégrader les performances de l'application. Elle est donc déconseillée sur une base de production.
  • ltWarning : Logue les requêtes et les fonctions SMO Serveur trop longues à s'exécuter.
    • Pour éviter d'écrire trop de lignes dans le fichier de log, des valeurs limites au-delà desquelles les warnings doivent être logués peuvent être définies  - Open url.png voir Description
  • ltException : Logue les erreurs applicatives.
  • ltIntegration : Logue les étapes de traitement lors de l'intégration de données.
  • ltMail : Logue les problèmes lors de l'envoi d'e-mails.
  • ltScheduler (Note : Utilisée uniquement lorsque le scheduler est actif sur le SMO Serveur) : Logue toutes les activités du scheduler.
  • ltAuthentication : Logue toutes les connexions au SMO Serveur (login, account, type d'authentification, résultat, ...).

Activation des sondes

  • Le paramètre Log_Type du fichier de configuration .ini permet d'indiquer la liste des sondes à activer.
    • Syntaxe : Les sondes à activer doivent être séparées par des caractères |.
                 Example documentation icon FR.png
      • Log_Type= ltWarning  |  ltException |  ltIntegration  |  ltMail
      • Log_Type= lt_all
       
    • La valeur ltAll active toutes les sondes.
      Attention : Cette valeur peut dégrader les performances de l'application. Elle est donc déconseillée sur une base de production.
  • La liste des sondes peut être définie pour chacune des applications : smoBroker, smoServer, smoMail, ...

Paramétrages possibles

Définition de tailles limites pour les champs logués

Pour éviter d'avoir des fichiers de logs trop volumineux, plusieurs paramètres permettent de tronquer la taille de certains champs dans le log.

La valeur -1 indique aucune limite de taille.

  • Log_Input_Maxsize : Taille maximum du champ Input, contenant la totalité de l'instruction envoyée au serveur. Valeur proposée : 100.
    Note : Lorsque le champ Input n'est pas restreint, le champ ReceivedQuery peut être restreint car la requête arrive forcément dans le champ Input.
  • Log_Output_Maxsize : Valeur proposée : 100. Valeur conseillée : 500.
  • Log_BindedSQL_Maxsize : Valeur proposée : 100.
  • Log_QuerySentToSGBD : Valeur proposée : -1 . Vous pouvez conserver cette valeur ou ne pas restreindre le champ ReceivedQuery
  • Log_ReceivedQuery_Maxsize : Valeur proposée : 100.

Définition de seuils pour les sondes warning

Des seuils peuvent être définis pour les sondes warning, indiquant la limite au-delà de laquelle un warning doit être logué dans le fichier de la sonde.

  • warning_exec_time : Logue les warnings pour toutes les fonctions de l'interface. Valeur proposée : 3000.
  • warning_query_time : Logue les warnings pour les requêtes. Valeur proposée : 3000.
  • warning_Critical_Enter : Logue le temps pour entrer dans la section critique. Valeur proposée : 50000.
  • warning_Critical_Process : Logue le temps passé dans la section critique. Valeur proposée : 50000.

Procédure : Comment paramétrer les fichiers de log pour une application

1. Ouvrez le fichier de configuration de l'application.

           Example documentation icon FR.png  smoServer.ini

2. Indiquez la liste des sondes à activer via le paramètre Log_Type, séparées par des caractères |.

           Example documentation icon FR.png  Log_Type= ltWarning  |  ltException |  ltIntegration  |  ltMail

3. (optionnel) Paramétrez les limites pour tronquer la taille des champs dans le log  - Open url.png voir Description

  • Indiquez le nombre de caractères maximum du champ. 
  • Laissez la valeur -1 pour indiquer aucune limite de taille.

4. (optionnel) Paramétrez les seuils des sondes warning  - Open url.png voir Description

5. Sauvegardez le fichier.

6. Redémarrez les services.

Tags:
Modifié par Utilisateur inconnu le 2019/07/22 10:00
Créé par Administrator XWiki le 2019/07/22 10:00

Raccourcis

L'actualité mensuelle
•  Newsletter

Tous les changements
•  Service Manager
•  Service Apps
•  Self Help

Glossaire

Powered by XWiki ©, EasyVista 2020