Jama Connect User Guide

View log and profile

Log files can help with troubleshooting.

  1. Log in to the application as root user and select Logging > Log Viewer to view the log. Select Refresh at the top right to refresh the log.

  2. Select Logging > Configuration.

    adminlogging.png

    Tip

    By default all logging levels are set to info and will reset to that default when the application is restarted

    To permanently change the logging level and appenders, edit the file:

    /data/config/log4j.properties

    The log configuration for Elasticsearch and search service can also be found in:

     /data/config

    You cannot change the location to where log files are written. Changes to these configuration files are applied within a few seconds and are persisted across restarts of the application.

  3. Select Edit in the right column to open a pop-up and change the logging level from the default setting of Info.

    log_level_dropdown.png
  4. Scroll to the bottom of the list. Under Profiling select Enable profiler log additional content for every log entry in the contour.log.

    profile_access_threads.png

    Profiling is indicated in the log file as the [jama.Profiler] package. The profiler prints out the following information:

    • The user who submitted the call.

    • The organization the user belongs to.

    • The java thread id of the call.

    • A stack trace of the call that includes processing time and memory usage of each trace.

    Note

    Enabling the profiler logging strongly enhances the logging in Jama but may require additional resources to generate this content. For best performance, use the profiler for investigative purposes.

    Here is a sample log entry:

    2011-04-28 09:37:19,865 INFO [org.directwebremoting.impl.DefaultRemoter] - Exec: projectSvc.getExtTreeNodeForProject()

    2011-04-28 09:37:19,869 INFO [jama.Profiler] - user:admin org:2 thread:96 start:2011-04-28 09:37:19,866

    [3ms] [+88K/-88K 837755K/254041K]- com.jamasoftware.Jama.dwr.impl.DwrProjectServiceImpl.getExtTreeNodeForProject

    [3ms] [+88K/-88K 837755K/254041K]- com.jamasoftware.contour.service.impl.ProjectServiceImpl.getExtTreeNodeForProject

    [2ms] [+88K/-88K 837755K/254041K]- com.jamasoftware.contour.service.impl.DocumentTypeServiceImpl.getAvailableDocumentTypesForProject

  5. Under Access log select Enable access logging to capture information of all requests users makes in Jama, whether it is logging in or selecting an item. It will also store locked out users. Information is captured in contour.log.

    Entries in the log file are noted by the [jama.AccessLog] package:

    • Date of the request

    • Server processing time to handle the request

    • The user who submitted the request

    • The organization id of the user who submitted the request

    • The user session id of the user whom made the request

    • The server address the request was made to

    Here is a sample log entry:

    2014-08-29 16:24:59,370 INFO http-bio-8080-exec-17 [jama.AccessLog] - [3 ms] PRBDIJN9 1 - 083BBE5B1E8C481033DA7AFBBEF023A5 160 http://localhost:8080/contour/

  6. Under Thread dump select Dump threads information to take a one time dump of the current running java threads being executed.

    Information is captured in contour-threaddump.log.

    This information is useful for identifying long running processes. If Jama seems to hang, run a thread dump and send the log file to support@jamasoftware.com.