Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Content layer
id741469365
Content column
id741469376
Content block
id741469364

On this page

Table of Contents

Scripts

The following

are

is the script

files getlogfiles.sh

package used in this page:

  • clearlogfiles.sh
  • Content block
    id741469375

    When you report an issue with your modeling tool, Cameo Collaborator or Teamwork Cloud, always include related log files. Log files provide useful information that we need to investigate and troubleshoot your problem.

    Using the log file script package

    The script package contains utilities for gathering and managing log files on your Teamwork Cloud server. These scripts are designed to run from a Linux or Windows Cygwin command line.

    • Create log file package
      Use the getlogfiles.sh script to create a package of all log files associated with Teamwork Cloud operations. This script will create a TAR archive file containing all the latest logs, as well as some system information. The TAR package can be sent along with your support request to help analyze Teamwork Cloud-related issues.
    • Reset log files
      Sometimes you may need to create a fresh set of log files. Use the clearlogfiles.sh script to reset the log files associated with Teamwork Cloud operations. Please make sure all Teamwork Cloud services are stopped before running the script. This script will then rename all the current log files so that new log files can be generated when the Teamwork Cloud services are restarted. Resetting the log files will ensure that the logs will only contain the latest startup information.

    Accessing log files

    Installation paths

    PACKAGEOSVERSIONINSTALL_ROOT
    Teamwork
    Cloud
    Linux22xR2, 24x<install_root> /CATIANoMagicServices
    22xR1 and older<install_root> /TeamworkCloudSuite
    Windows22xR2, 24x<install_root>\CATIANoMagicServices
    22xR1 and older<install_root>\ TeamworkCloudSuite
    Magic
    Collaboration
    Studio
    LinuxAll<install_root>/MagicCollaborationStudio
    WindowsAll<install_root>\MagicCollaborationStudio
    • For a modeling tool:

    Open your modeling tool and in the main menu go to Help > About <modeling tool name>. In the Environment tab, click the link provided in the Log File line to open a log file.

    Or 

    Go to the <user.home>\<.modeling tool name>\<modeling tool version> directory and obtain <modeling tool name>.log file.

    Default path for Windows: C:\Users\<USERNAME>\AppData\Local\.<modeling tool name>\<modeling tool version number>
    Default path for other operating systems: <user.home>/.<modeling tool name>/< modeling tool version number>

    • For WebAppWeb Application Platform/Cameo Collaborator for Teamwork Cloud:

    Go to the <WebAppPlatform installation directory>/logs/webappplatform directory and obtain the web-app.log and/or collaborator.log files.

    Default path for Linux: /opt/local/TeamworkCloud/WebAppPlatform/logs/webappplatform

    Default path for Windows: C:\Program Files\TeamworkCloud\WebAppPlatform\logs\webappplatform

    • For Teamwork Cloud:

    Go to the <user.home>\.twcloud\<version number> directory and obtain the server.log file.

    Log files (e.g., webapp.logcollaborator.log, etc.)
    Linux: <install_root> /WebAppPlatform/logs/webappplatform
    Windows: <install_root> \WebAppPlatform\logs\webappplatform

    Configuration
    Linux: <install_root>/WebAppPlatform/shared/conf/webappplatform.properties
    Windows: <install_root>\WebAppPlatform\shared\conf\webappplatform.properties

    Teamwork Cloud/Magic Collaboration Studio

    Log file for 2024x and later
    Linux : <install_root>/TeamworkCloud/logs/server.log
    Windows: <install_root>\TeamworkCloud\logs\ server.log

    Configuration
    Linux: <install_root>/TeamworkCloud/configuration/application.conf
    Windows: <install_root>\TeamworkCloud\configuration\application.conf

    Log file for earlier versions
    Linux:Default path for Linux:  /home/twcloud/.twcloud/<version>
    Default path for /server.log
    Windows:   C:\Users\<USER><user>\.twcloud\<version>\server.log

    • For Authentication server:

    Log file for version 2022x and up: go to the <TeamworkCloud installation directory>later
    Linux: <install_root> /WebAppPlatform/logs/webappplatform directory and obtain the /authentication.logfile.

    For earlier versions: go to the <user.home>\.authserver\<version number> directory and obtain the authserver.log file.


    Windows: <install_root>\ WebAppPlatform\logs\webappplatform\authentication.log

    Configuration for 2022x and newer
    Linux: <install_root>/WebAppPlatform\shared\conf\authserver.properties
    Windows: <install_root>\WebAppPlatform\shared\conf\authserver.properties

    Log file for earlier versions
    Linux: Default path for Linux: /home/twcloud/.authserver/<version>
    Default path for /authserver.log
    Windows:   C:\Users\<USER><user>\.authserver\<version>\authserver.log

    Configuration for earlier versions
    Linux: <install_root> /AuthServer/config/authserver.properties
    Windows: <install_root>\ AuthServer\config\authserver.properties

    • For Cassandra:

    Log file
    Default path for Linux:  /var/log/cassandra
    Obtain /system.logand debug.log files.

    Default path for Windows: C:\apache-cassandra-<version>\logs
    Or go to <Cassandra installation directory>\logs directory and obtain system.log and debug.log files.

    Configuration files 
    Linux: /etc/cassandra/conf

    • Properties files for Teamwork Cloud:

    Default for Linux:
    /opt/local/TeamworkCloud/configuration/application.conf
    /opt/local/TeamworkCloud/Authserver/config/authserver.properties
    /opt/local/TeamworkCloud/WebAppPlatform/shared/conf/webappplatform.properties

    Default for Windows:
    C:\Program Files\TeamworkCloud\configuration\application.conf
    C:\Program Files\TeamworkCloud\Authserver\config\authserver.properties
    C:\Program Files\TeamworkCloud\WebAppPlatform\shared\conf\webappplatform.properties

    • For Cameo Collaborator for Alfresco:

    Go to Alfresco Community installation directory, and obtain the alfresco.logshare.log and solr.log files.

    Go to <Alfresco Community installation directory>\tomcat\logs, and obtain the alfrescotomcat-stderr.log, alfrescotomcat-stdout.log and catalina.log files.

    Generating a log file

    If the performance of your modeling tool declines or it freezes, go to <modeling tool installation directory>\bin, and run the submit_issue.exe or submit_issue.sh file several times. It dumps threads into the log file of your modeling tool. Then you can access the log file as described above.

    Java crash log files

    If your modeling tool crashes (disappears), try searching for Java crash log files. They are stored in the running location of the modeling tool, e.g., the <modeling tool installation directory>/bin or <modeling tool installation directory> directory. The names of these log files start with "hs_err", e.g., hs_err_pid15693.log. If you find the Java crash log file, it indicates that Java was the reason of your modeling tool crash.