Enabling logging for web services


This topic describes steps to enable logging for web services.

To enable logging for web services

  1. Edit the logback_server.xml file by using ConfigMaps.
    For more information, see the topic Using ConfigMaps to access the configuration files.
  2. Update the file with the following lines:

    <logger name="com.bmc.arsys.ws.client.WebServiceSoapClientImpl"   
                   level="debug" additivity="false">
                   <appender-ref ref="ServerLog" />
    </logger>
  3. Restart the AR System server.
    If you have provided the appender-ref as ServerLog, the logs for web services will be generated in arerror.log file.

To create a separate log file for web services

  1. Create new appender in the logback_server.xml file. The logback_server.xml file is located at <install-location>/conf.
  2. Locate and copy the existing appender "ServerLog".
  3. Paste the existing appender "ServerLog" after the last appender.
    Refer to the following example for a new appender entry:

    <appender name="webservicelog" class="com.bmc.arsys.logging.SuspendableRollingFileAppender">
          <file>${com.bmc.arsys.homedir}/${com.bmc.arsys.server.dbdir}/arwebsvc.log</file>
          <append>true</append>
          <enableThreadLogging>true</enableThreadLogging>
          <!-- <param name="Encoding" value="UTF-8" /> -->
          <rollingPolicy class="com.bmc.arsys.logging.StoredRollingPolicy">
             <fileNamePattern>${com.bmc.arsys.homedir}/${com.bmc.arsys.server.dbdir}/arwebsvc${threadId}.log.%i</fileNamePattern>
             <minIndex>1</minIndex>
             <maxIndex>8</maxIndex>
          </rollingPolicy>
          <triggeringPolicy class="com.bmc.arsys.logging.ARSizeBasedTriggeringPolicy">
             <maxFileSize>128MB</maxFileSize>
          </triggeringPolicy>
          <encoder>
             <charset>UTF-8</charset>
             <pattern>%m%n</pattern>
          </encoder>
    </appender>
  4. Change the appender name and file name from the <file> tag and the <fileNamePattern> tag. Enter rest of the information as it is. 
  5. Create the logger using the created appender name in the logback_server.xml file. Create the logger after the last logger in file.
    Refer to the following example for a new logger entry:

    <logger name="com.bmc.arsys.ws.client.WebServiceSoapClientImpl"   
                   level="debug" additivity="false">
                   <appender-ref ref="webservicelog" />
    </logger>
  6. Save the logback_server.xml file.
  7. Restart the AR System server.
  8. Open the file location mentioned in logback_server.xml file and verify that the newly created file is present.

Related topics

Publishing-the-AR-System-functionality-as-a-web-service

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Helix Innovation Suite 25.1