Q100719: Enabling debug and verbose logging

SUMMARY

Enabling debug messages in the Render Log can help with troubleshooting render crashes within Katana and obtain more detail around the area where the issue is occurring. Render plug-ins also have settings to enable more verbose logging to help renderer crashes that occur within the render vendor plug-in.

This article will walk you step-by-step on how to enable more verbose logging in Katana using different renderers.

 

MORE INFORMATION

To enable debug messages in the Render Log for Katana, you need to adjust the log level in the Katana’s logging configuration file.

The default configuration file can be found in %KATANA_ROOT%/bin/log.conf. If you find it more convenient, you can copy this file to another directory, modify it as needed, and then set Katana to use your custom configuration file by specifying the FNLOGGING_CONFIG environment variable. For more details, please see the Katana User Guide on Message Logging

Once you're ready to enable debug messages in the Render Log, follow these steps to open and edit the logging configuration file, which is usually found at %KATANA_ROOT%/bin/log.conf:

  1. Change the following line from 

log4cplus.rootLogger=INFO, KatanaLogFile, KatanaConsoleOutput

to

log4cplus.rootLogger=DEBUG, KatanaLogFile, KatanaConsoleOutput
log4cplus.logger.python = DEBUG

  1. To clear out old data from the Render Log and begin viewing the latest recorded messages, you need to delete the katana.log file. If you're using Windows, you'll find this file in the `%TEMP%` directory. For Linux users, it can be located in the `/tmp/` directory.

If you're having issues with USD files after converting USD data into Katana data, you can collect additional information to help troubleshoot the problem. By creating a RenderSettings node and looking for the deferredUsdToKatana section. Inside this section, enable the Verbosity mode. Once there you can check Verbosity mode in order to get more information from the output info during USD scene composition and scenegraph generation.

 

Plug-in Specific Log Levels

In addition to increasing the render log level for Katana, some render vendor plug-ins have the option to increase the verbosity settings for messages logged in the Render Log. If a crash relates to the render vendor plug-in, then enabling render vendor plug-in specific verbose settings would give some clarity where the crash might occur. The following are steps for altering the log level for render vendor plug-ins per session and not globally.

Note: Any crashes caused by a render vendor plug-in would need to be reported to the render vendor directly.

3Delight

If you want to enable verbose mode in 3Delight to get additional informative messages before, during and after rendering, you can set the verbose option to 1 in your 3delight installation folder which by default is installed in  C:\Program Files\3Delight

Please visit the 3Delight documentation for the most current information: The 3delight.config File

Arnold

To activate verbose mode in the KatanaToArnold plug-in, you can do so by creating an ArnoldGlobalSettings node and enabling the AI_LOG_DEBUG option under the Verbosity Settings

Please visit the Arnold documentation for the most current information: Verbosity Settings - Arnold for Katana

RenderMan

By default the log level for RenderMan for Katana is set to “INFO”, and it is determined by the log configuration file in $KATANA_HOME$/logging and modifying rootLogger. Alternatively, you can also increase the log-level in the RenderManForKatana plug-in, by creating a PrmanGlobalStatements node and changing the commandArguments.loglevel parameter.

Please visit the RenderMan documentation for the most current information: RenderSettings using RenderManforKatana

Redshift

To increase the verbosity level in the Redshift4Katana plug-in, you can create a RedshiftRenderSettings node and change options.Log Level parameter. 

Please visit the Redshift documentation for the most current information: Log File Location

 

FURTHER READING 

For help more help on how to troubleshoot render issues, please visit Q100391: Troubleshooting rendering issues in Katana

For help troubleshooting performance issues, please visit the Katana User Guide - Optimizing Performance > Geolib3-MT Profiling

 

FURTHER HELP

If you are still experiencing render issues, please open a Support ticket and let us know the issue you are encountering and the troubleshooting steps you have taken so far. Please also include the system information outlined in Q100520: Obtaining operating system reports for hardware specs to send during Foundry Support investigations

For more information on how to open a Support ticket, please refer to the Q100064: How to raise a support ticket article.

    We're sorry to hear that

    Please tell us why