Requesting Debugging and Diagnostic Output

System Coupling can generate diagnostics and debugging output to help you troubleshoot issues with coupled analyses. For more information on requested this output from System Coupling in Workbench, see:

Requesting Debug Log Files

System Coupling can generate debug log files to record transactions between itself and its participant solvers. Log file content is controlled by the command-line options listed in Debug Logging Command-Line Options in the System Coupling Settings and Commands Reference documentation.

To request that debug log files are generated, perform the following steps:

  1. On Workbench's Project Schematic, right-click the System Coupling system's Solution cell and select Properties.

    Corresponding properties are shown to the right in the Properties of Schematic: Solution pane. Under General, note the Command Line Options property.

  2. Enable the generation of debug log files.

    In the Command Line Options property's Values field, type in the -l or --logLevel option, setting it to a value of 1 or higher.

  3. Optionally, you can use the following additional arguments to specify details for the log output:

    • Use the --logDir option to specify an output directory for the log files.


      Note:  By default, the log files are written to System Coupling's working directory within the project's dp0 directory (dp0\SC\SC).


    • If the logging level is set to a value of 2 or higher, use the --logMaxArrayElements to specify the maximum number of data array elements that can be included in the file. (Default value is 5.)

When the System Coupling system's Solution cell is updated, debug logging is activated.

During the solution, System Coupling will write data to the following files, with "date" and "time" indicating when the run began:

SyC_Log_Controller_<date>_<time>.txt

Contains log information from the controller process.

SyC_Log_CNode<N>_<date>_<time>.txt

Contains log information from compute node "N"


Tip:  The log file for compute node 0 usually contains the most relevant information.


Example 51: Request that Level 1 debug log files are written to the default directory

Log files containing RPC calls will be written to System Coupling's working directory.


--logLevel=1


Example 52: Request that Level 2 debug log files are written to the specified directory

Log files containing RPC calls and diagnostics will be written to the SyC/DebugOutput directory within System Coupling's working directory.


> "%AWP_ROOT242%\SystemCoupling\bin\systemcoupling" -G --logLevel=2 --logDir=SyC/DebugOutput
 

Example 53: Request that Level 3 debug log files are written to the default directory

Log files containing RPC calls/diagnostics and a maximum of three heavyweight data-array elements will be written to System Coupling's working directory.


$ "$AWP_ROOT242/SystemCoupling/bin/systemcoupling" -l3 --logMaxArrayElement=3