Enabling Java debug logging for Remedy Developer Studio

The first step you can take to investigate issues with Developer Studio is to enable logs. This topic describes how to enable Java debug logging for Developer Studio.

Before enabling Java debug logging, ensure that the Java Runtime Environment (JRE) or Java Development Kit (JDK) are available. The following error is displayed if JRE or JDK are not available:

JRE.png



 To resolve this issue, rectify the Java path in the devstudio.ini file.

For example, <Install directory>/BMCTools/Java/jre1.8.0_45/bin/javaw.exe.

devStudio.png

To enable Java debug logging for Developer Studio

  1. Navigate to the installation folder for Developer Studio, that is, ...\BMC Software\ARSystem\DeveloperStudio and then create a new folder named, for example, Logs.

  2. Navigate to ...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_<versionstring>.
    See the following table to know about the version and location:

    Version

    Location

    8.1, 8.1.01, and 8.1.02

    ...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_8.1.0.build001

    9.0

    ...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_9.0.0.build001

    9.1

    ...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_9.1.0.build001

    9.1.02

    ...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_9.1.2.build001

    9.1.03

    ...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_9.1.3.build002

    9.1.04

    ...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_9.1.4.build003

    9.1.05 (18.05)

    ...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_9.1.5.build004

    9.1.06 (18.08)

    ...\DeveloperStudio\plugins\com.bmc.arsys.studio.api_9.1.6.build005

  3. Find the log4j.xml file.
  4. Copy the log4j.xml file as log4j.xml.bak in the same folder.

  5. Open the log4j.xml file in Notepad or any other text editor and then change the text <param name="File" value="javaapi.log" /> to <param name="File" value="<Full path>/<folder created in step 1>/javaapi.log" />.
    For example (using Developer Studio 9.1.03):
    Change the text <param name="File" value="javaapi.log" /> to <param name="File" value="D:/Program Files (x86)/BMC Software/9.1.03/DeveloperStudio/Logs/javaapi.log" />.

    Important

    When you copy the full path from the Windows Explorer address bar, the path includes backslashes. Ensure that you change the backslashes to forward slashes. If you do not change these, the entry is ignored.

    Note

    You might notice that javaapi.log is not generated if you specify the full path. You can keep javaapi.log as the default value with no path. The javaapi.log file is generated in the D:/Program Files (x86)/BMC Software/9.1.03/developerstudio/ folder.

  6. In the log4j.xml file, replace the value fatal with the value all.

    Before
     <!-- Print only messages of level fatal in the package com.bmc.arsys -->
                 <logger name="com.bmc.arsys">
                    <level     value="fatal" />
                 </logger>
                 <logger name="com.bmc.arsys.api">
                    <level     value="fatal" />
                  </logger>
                  <logger name="com.bmc.arsys.arrpc">
                     <level     value="fatal" />
                  </logger>

                 <!--Set root category priority to fatal -->
                 <root>
                 <priority value ="fatal" />
    After
    <!-- Print only messages of level fatal in the package com.bmc.arsys -->
                 <logger name="com.bmc.arsys">
                    <level     value="all" />
                 </logger>
                 <logger name="com.bmc.arsys.api">
                    <level     value="all" />
                  </logger>
                  <logger name="com.bmc.arsys.arrpc">
                     <level     value="all" />
                  </logger>

                 <!--Set root category priority to fatal -->
                 <root>
                 <priority value ="all" />

  7. Enable the logging to be appended into the log file and the console (default) by removing the "comment" tags.

    Before
    <!-- use FileLog as the appender for logging to the log file -->
             <!--
             <appender-ref ref="FileLog" />
             -->
             <appender-ref ref="Console" />
    After
     <!-- use FileLog as the appender for logging to the log file -->
             <appender-ref ref="FileLog" />    
             <appender-ref ref="Console" />
  8. Save the log4j.xml file.
    When you start Developer Studio, the javaapi.log file is created at the location specified in step 5.