IBM Support

Overview of the log files in IBM Rational Rhapsody

Question & Answer


Question

What is the purpose of the log files that are found in Rational Rhapsody?

Answer

Below are some of the log files that are generated by Rational Rhapsody and a brief description of what these files contain.

Rational Rhapsody creates log files for recording information related to loading of models, saving of models, and code generation from models.

When troubleshooting problems, you can view the log files that IBM Rational Rhapsody uses for recording information related to:

  • loading of models
  • saving of models
  • code generation (trace information)
  • add to model (trace information)
  • configuration management (trace information)

The logging settings, such as the file names for the log files, are defined in the rhapsody.properties file located in the [installation directory]\Share\Log directory.

When you use Save As to save a project, or set a project to active in your browser, the log files are contained in the new project directory. You can change the path of a log file by modifying the value of the fileHandler.fileName variable. If a directory name is not included in the path, the log file is saved to the operating system's temp directory. When specifying a path, use forward slashes, for example, c:/logs/rhapsody/load.log. (This applies to Windows users as well.)

The level of information recorded is determined by the value of the variable lf.level. The possible values, from the highest to lowest threshold, are:

  • FATAL
  • ERROR
  • WARNING
  • INFO
  • DEBUG_MIN
  • DEBUG_MID
  • DEBUG_MAX

To turn off logging, set the value of the [logger name].logging variable to false, for example, Load.logging=false. (This variable might not be present in the file by default.) To turn logging back on, set the value of this variable to true or remove it altogether from the file.

You can optimize logging performance by adding keyword entries to the rhapsody.properties file. Rational Rhapsody supports the following keywords:

  • $PID$ (the process ID)
  • $DATE$
  • $TIME$

The following example is an entry for a process ID log file containing information on loading models.

fileHandler.fileName=load_$PID$.log

Following are some description of the different log files

  • silentMode.log

    The silentMode.log is used for storing debugging information when the system is in "silent mode"
    In this mode, no dialog or any message is popped-up to the user. So any info that should pop-up to the user will be stored there. Most of that is for debugging purpose.
     
  • load.log

    The load.log contains some debugging info about loading the model
     
  • store.log

    Store.log contains debugging information that is being written while Rhapsody saves the model
     
  • plugin.log

    This file is created when there is a failure with loading a Rhapsody plug-in.
    Plug-ins could be Test-conductor, Rules player or even just a user plug-in

    Similarly, as the name goes atg.log belongs to Automatic test Generator add-on and the rtc.log - to Rational Team Concert.
     

 

[{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSB2MU","label":"IBM Engineering Systems Design Rhapsody"},"Component":"General Information","Platform":[{"code":"PF033","label":"Windows"}],"Version":"8.3","Edition":"","Line of Business":{"code":"LOB59","label":"Sustainability Software"}}]

Product Synonym

Rational Rhapsody

Document Information

Modified date:
27 May 2022

UID

swg21421787