Supervision de Squash TM

Mémoire de la JVM

La mémoire allouée à la JVM de Squash TM est configurable dans le fichier startup via la propriété suivante :

Fichier startup.sh :

JAVA_ARGS="-Xms128m -Xmx1024m -server"

Fichier startup.bat :

set JAVA_ARGS=-Xms128m -Xmx1024m %SERVER_MODE%

Xms : taille minimale
Xmx : taille maximale

Il est recommandé d'allouer 2 Go de mémoire (Xmx) à la JVM de Squash TM pour un dimensionnement standard de Squash TM.
En cas de forte volumétrie de données cette valeur peut être augmentée pour garantir les performances de l'application lors des traitements de masse (recherche, exports, génération de rapports). Il faut pour cela modifier le Xmx par un multiple de 512.

Focus

S'assurer avant de modifier la mémoire allouée à la JVM que la machine sur laquelle est installée l'application dispose d'une RAM suffisante.

Gestion des logs

Les logs de Squash TM sont téléchargeables depuis l'administration de l'application ou depuis le répertoire logs sur le serveur. Les logs du jour sont dans le fichier squash-tm.log et les logs des jours précédents sont suffixés par leur date (exemple: squash-tm.log.20210527).

Niveau de logs

La rotation des logs applicatifs de Squash TM se configure dans le fichier conf/log4j2.xml.

Dans Squash TM, il existe trois niveaux de logs utiles : info, debug et trace. Le niveau "trace" est le plus précis des trois mais aussi le plus verbeux.

Pour mettre les logs de Squash TM en mode debug, il faut :

Eteindre Squash TM
Modifier dans le fichier log4j2.xml la valeur "info" par "debug" à la ligne :
```
<Root level="info">
```
Redémarrer Squash TM

Après avoir effectué le test souhaité revenir au mode "info" pour ne pas surcharger le serveur car les logs sont très volumineux en debug.

Loggers Squash TM

Le fichier log4j2.xml contient déjà un certain nombre de loggers. Il est d'ailleurs possible de modifier leur niveau de log individuellement en modifiant la valeur de la propriété level.

Voici une liste non exhaustive de loggers supplémentaires qu'il est possible d'ajouter à la suite de la dernière balise Logger du fichier :

Pour avoir des logs plus précis pour le bugtracker Jira Server :

<Logger name="org.squashtest.tm.plugin.bugtracker.jirarest" level="trace" additivity="false" >
    <AppenderRef ref="Console"/>
    <AppenderRef ref="Daily_log"/>
</Logger>

Pour augmenter le niveau de logs du plugin Git Connector :

<Logger name="org.squashtest.tm.plugin.scm.git.internal.GitClientImpl" level="trace" additivity="false" >
    <AppenderRef ref="Console"/>
    <AppenderRef ref="Daily_log"/>
</Logger>

Il est nécessaire de redémarrer Squash TM pour que les modifications réalisées sur le fichier soient prises en compte.

Logs Xsquash

Pour Xsquash Cloud, il est possible de télécharger les logs directement depuis l'administration Jira Cloud.

Pour Xsquash sur Jira Server, les logs du plugin sont confondus dans les logs de Jira.

Il est possible d'ajouter un logger en mode ERROR pour le package "org.squashtest.plugin.jira.Xsquash" pour activer une visualisation plus précise des erreurs Xsquash dans les logs Jira.

Voici les étapes à suivre pour ajouter ce logger :

Sur Jira Server, aller dans Administration > Système
Aller dans la partie "Connexion et création de profil"
Dans "Loggers par défaut", cliquer sur " Configurer le niveau de journalisation pour un autre paquet."
Renseignez le package "org.squashtest.plugin.jira.Xsquash" et un niveau de journalisation ERROR.