Working with logs
To configure logs
You can configure logging by using the logback.configuration configuration parameter in the Centralized configuration. For more information, see Centralized-configuration.
Contents of the logs
The following log files are available. For most log files, the format of the content is as follows:
TIME| THREAD | LEVEL| COMPONENT| MESSAGE.
Log file | Location | Description |
|---|---|---|
smartit_install_log.txt |
| Smart IT Installer Logs. Check this file for Exceptions if the installation is:
If any DEF import failure exceptions are logged, check the RIK log files located at: <InstallDir>/Smart_IT/Logs/ |
openFire_error.log | <InstallDir>/Smart_IT/openfire/logs/ <InstallDir>/Smart_IT/Logs/ | Openfire logs. Check these files to troubleshoot issues with Openfire chat in Smart IT. |
smartit.n.log | <InstallDir>/Smart_IT/Logs/ | Primary Tomcat log file. It contains data related to back-end calls and their duration. When the maximum defined log file size reached 128 MB (by default), a new log file is created, and the n counter in the log file name is incremented to n+1 (till 8 files). |
smartit.log | <InstallDir>/Smart_IT/Logs/ | The current version of log file is smartit.log. |
smartit-error.log | <InstallDir>/Smart_IT/Logs/ | Tomcat error log file. All errors are logged to this file. |
smartit-perf.log | <InstallDir>/Smart_IT/Logs/ | Additional Tomcat log file created if log type selected is Performance. |
smartit-data-access.log | <InstallDir>/Smart_IT/Logs/ | Logging based on user name and tenant ID.This log file captures Rest API calls and also the subsequent AR API calls. The REST call includes Query parameters and Payload. All AR API calls log Fields and the Qualification being used for a specific request. Log format: "%date{${DATE_FORMAT}} | %-2thread | %-10X{userId} | %-10X{tenantId} | %msg%n" Example: 18:29:02.565 | http-bio-8080-exec-24 | Allen | 000000000000001 | REST API called [ GET /smartit/restapi/person/supportgroupperson/Allen ] with parameters/payload [ Allen ] Enabling the logger By default, the logger is not enabled. When needed, this logger can be enabled through the logback.configuration configuration parameter in the Centralized-configuration. To enable the log, set the LOG_DATA_ACCESS property in the logback.configuration parameter to TRUE and set the log level to DEBUG. Changing the value does not require you to restart the services for it to take effect. Note:
Best practice: Since enabling this logger will be an overhead to the system, we recommend that you enable the logs when you require to capture logs against specific use cases or scenarios and then disable it as soon as you are done. Limitation: Currently JPA calls are not captured in this log. |
To generate logs for the integration with BMC Digital Workplace requests
If you get an error, you can check the arjavaplugin.log, which is the standard AR java plug-in log. Otherwise, you can also generate a log file to check the details if you get an error. To generate a log file for the BMC Digital Workplace request integration, include the following code in the file \ARSystem\pluginsvr\log4j_pluginsvr.xml and restart plugin:
<param name="File"
value="C:/Program Files/BMC Software/ARSystem/ARServer/Db/sbeplugin.log"/>
<param name="MaxFileSize" value="5MB"/>
<!-- Keep two backups -->
<param name="MaxBackupIndex" value="10"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d %-5p [%t] %C (%F:%L) - %m%n"/>
</layout>
</appender>
<logger additivity="false" name="com.bmc.remedy.itsm.sbe">
<level value="debug"/>
<appender-ref ref="SBEPluginLog"/>
</logger>