This documentation supports the 20.08 version of BMC Digital Workplace Basic, which is available only to BMC Helix subscribers (SaaS). To view an earlier version, select the version from the Product Version menu.

Configuring logs

This topic describes how to configure logs. For information about the available logs, see Contents-of-the-logs.


Related topics

Troubleshooting

Working-with-logs

To configure logging from the BMC Digital Workplace Admin console

The BMC Digital Workplace administrator can set the log level directly from the BMC Digital Workplace Admin console.

  1. In the BMC Digital Workplace Admin console, go to Configuration > Logging.
  2. Select the Override the log config file settings check box.
  3. In the Log Level list, select an appropriate log level. 
    The log level is changed on all nodes.


Best practice
To troubleshoot a problem, we recommend that you set the log level to DEBUG. After troubleshooting a problem, set the log level to WARN. If you leave DEBUG enabled, you must monitor log growth and manage it accordingly.

The following video (4:47) demonstrates how you can configure logs manually in BMC Digital Workplace.

Important

The video shows an older version of BMC Digital Workplace. The previous product name was MyIT. Although there might be minor changes in the UI, the overall functionality remains the same.



icon-play.png https://www.youtube.com/watch?v=HQXmqoRtsYI?rel=0

To set the log level for other components to debug

Debug settings
<!--Optional SQL LOGGER-->
<if condition='${LOG_SQL_STATEMENTS}'>
   <then>
      <!-- SQL LOGGER -->
      <logger name="SQL" level="DEBUG" additivity="false">
        <appender-ref ref="SQL-FILE"/>
      </logger>
   </then>
</if>

<!--Optional annotated code logger-->
<if condition='${LOG_ANNOTATED}'>
   <then>
      <logger name="ANNOTATED" level="DEBUG" additivity="false">
        <appender-ref ref="ANNOTATED-FILE"/>
      </logger>
   </then>
</if>

<!--Optional Globalsearch logger-->
<if condition='${LOG_GLOBALSEARCH}'>
   <then>
      <logger name="com.bmc.bsm.myit.service.globalsearch" level="DEBUG" additivity="false">
        <appender-ref ref="GLOBALSEARCH-FILE"/>
      </logger>
   </then>
</if>

<!--Optional Social logger-->
<if condition='${LOG_SOCIAL_RESPONSES}'>
   <then>
      <logger name="social.server.debug.logger" level="DEBUG" additivity="false">
        <appender-ref ref="SOCIAL-FILE"/>
      </logger>
   </then>
</if>

<!-- Measure performance -->
<logger name="instrumentation" level="DEBUG" additivity="false">
   <appender-ref ref="PERF-FILE"/>
</logger>

To configure self-managing logs

The dwp.timeStamp.part.n.log logs are self-managing based on the settings in logback-dwp.xml file.

  1. From the BMC Digital Workplace server, open the logback-dwp.xml file in C:\Program Files\Apache Software Foundation\Tomcat8.0\external-conf.
  2. In the header of the file, modify the following settings:
    • Log file size limit—When the maximum defined log file size is reached, a new log file is created, and the n counter in the log file name is incremented to n+1.
    • Daily or time-based rollover
    • Period for number of time-based rollovers
  3. Save the file and restart the Tomcat server.

To configure logging history

The dwp.log files record history according to the properties defined in the logback-dwp.xml file.

  1. From the BMC Digital Workplace server, open the logback-dwp.xml file in C:\Program Files\Apache Software Foundation\Tomcat8.0\external-conf.

  2. As needed, configure the following properties to configure the period of time and log file size limit:

    <!-- Period of time. Keep history for number of time based rollovers -->  
    <property name="MAX_HISTORY" value="60"/>
    <!-- Log file size limit -->
    <property name="LOG_FILE_SIZE" value="20MB"/>
  3. Save the file and restart the Tomcat server.