Skip to content

Supervise Squash TM

JVM Memory

The memory allocated to Squash TM's JVM can be configured in the startup file via the following property:

startup.sh file:

JAVA_ARGS="-Xms128m -Xmx1024m -server"

startup.bat file:

set JAVA_ARGS=-Xms128m -Xmx1024m %SERVER_MODE%

Xms: minimum size
Xmx: maximum size

We recommend that you dedicate 2 GB of the memory (Xmx) to Squash TM's JVM for a standard sizing of Squash TM.
In case of high volume of data, you can increase this value to guarantee the app's performance during mass processing (searches, exports, reports). For this, you must modify the Xmx by a multiple of 512.

Focus

Before modifying the memory dedicated to the JVM, make sure that the server on which the app is installed has enough RAM.

Manage Logs

You can download Squash TM logs from the administration workspace or from the logs repository on the server. The logs of the day are in the file squash-tm.log whereas the previous logs are suffixed with their date (example: squash-tm.log.20210527)

Logs Level

You can configure the Squash TM's app log rotation in the file conf/log4j2.xml.

In Squash TM, there are three levels of useful logs: info, debug, and trace. The "trace" level is the most precise of the three, but also the most verbose.

To put Squash TM logs in debug mode, you must:

  1. Stop Squash TM
  2. In the file log4j2.xml, modify the value "info" by "debug" in the line:

    <Root level="info">
    
  3. Restart Squash TM

After running your test, come back to the "info" mode so as not to overload the server, since the logs have are very voluminous in debug mode.

Squash TM Loggers

The file log4j2.xml already contains a certain number of loggers. You can also individually modify their log level by modifying the value of the property level.

Here is a non-exhaustive list of additional loggers that you can add after the file's last Logger tag:

To get more precise logs for the Jira Server bugtracker:

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

To increase the Git Connector plugin's logs level:

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

You must restart Squash TM for the app to take the changes made to the file into account.

Xsquash Logs

For Xsquash Cloud, you can download the logs directly from the Jira Cloud administration.

For Xsquash on Jira Server, the plugin logs are merged into the Jira plugins.

You can add a logger in ERROR mode for the package "org.squashtest.plugin.jira.Xsquash" to activate a more precise view of Xsquash errors in Jira logs.

Here are the steps to follow to add this logger:

  1. In Jira Server, go to Administration > System
  2. Go to the part "Log in and profile"
  3. In "Loggers by default", click on " Configure the le journaling level for another package".
  4. Enter the package "org.squashtest.plugin.jira.Xsquash" and an ERROR level of journaling.
Back to top