Choose a custom logging configuration file

The default logging configuration file is automatically used. You can choose to use a custom logging configuration file by setting the value of an environment variable.

Procedure

1. To use a custom logging configuration file, update the value of the environment variable USE_TCME_LOGGER to false.
2. Ensure that you update your custom logging configuration file with the required loggers and appenders. The following is a sample logging configuration (Log4j2 XML style) with appenders and logger information. Add these to your custom logging configuration file.

<Configuration status="WARN" name="MBSEIntegrationClientLog">
    <Properties>
        <Property name="LOG_DIR_ROOT">${sys:user.home}/Siemens/logs/MBSEIntegration</Property>
        <Property name="CLIENT_LOG_DIR">${LOG_DIR_ROOT}</Property>
        <Property name="ARCHIVE">${LOG_DIR_ROOT}/archive</Property>
        <Property name="LIB_FILE">MBSEIntegrationClient</Property>
        <Property name="PATTERN">%-5level - %d{yyyy/MM/dd-HH:mm:ss.SSS}{GMT+0} UTC - %C{1}:%M(%L) - %X{correlation-id} - %m%n</Property>
    </Properties>

    <!-- Responsible for publishing logging information to various preferred destinations. -->
    <Appenders>
        <Console name="STDOUT" target="SYSTEM_OUT">
            <PatternLayout pattern="${PATTERN}"/>
        </Console>
        <RollingFile name="MBSEIntegrationClient"
                     filePattern="${CLIENT_LOG_DIR}/${LIB_FILE}_%d{yyyy-MM-dd-HH-mm}.log">
            <PatternLayout pattern="${PATTERN}"/>
            <SizeBasedTriggeringPolicy size="10 MB" />
        </RollingFile>
        <RollingFile name="MBSEIntegrationSOA"
                     filePattern="${CLIENT_LOG_DIR}/${LIB_FILE}_SOA_%d{yyyy-MM-dd-HH-mm}.log">
            <PatternLayout pattern="${PATTERN}"/>
            <SizeBasedTriggeringPolicy size="10 MB" />
        </RollingFile>
        <RollingFile name="MBSEIntegrationComm"
                     filePattern="${CLIENT_LOG_DIR}/${LIB_FILE}_Comm_%d{yyyy-MM-dd-HH}_%i.comlog">
            <PatternLayout pattern="${PATTERN}"/>
            <SizeBasedTriggeringPolicy size="100 MB" />
        </RollingFile>
    </Appenders>

    <!-- Supported levels of logging: ALL turns on all logging; DEBUG designates fine-grained
         informational events most useful to debug an application; INFO designates informational
         messages that highlight the progress of the application at a coarse-grained level;
         WARN designates potentially harmful situations; ERROR designates error events that
         might still allow the application to continue running; OFF turns off logging. -->

    <!-- Responsible for capturing logging information. -->
    <Loggers>
        <Logger name="com.teamcenter.soa" level="DEBUG" additivity="false" >
          <AppenderRef ref="MBSEIntegrationSOA"/>
        </Logger>
        <!-- set the level to DEBUG to generate comlog file with SOA call details for TCME client -->
        <Logger name="com.teamcenter.soa.client.Connection" level="DEBUG" additivity="false" >
          <AppenderRef ref="MBSEIntegrationComm"/>
        </Logger>
       <Logger name="com.teamcenter.behaviormodeling" level="DEBUG" additivity="false" >
          <AppenderRef ref="MBSEIntegrationClient"/>
       </Logger>
       <Logger name="com.teamcenter.projectmanagement" level="DEBUG" additivity="false" >
          <AppenderRef ref="MBSEIntegrationClient"/>
       </Logger>
       <Logger name="com.teamcenter.modelrepositorysystem" level="DEBUG" additivity="false" >
          <AppenderRef ref="MBSEIntegrationClient"/>
       </Logger>
       <Logger name="com.teamcenter.scmadapter" level="DEBUG" additivity="false" >
          <AppenderRef ref="MBSEIntegrationClient"/>
       </Logger>
       <Logger name="com.teamcenter.tcmeclient" level="DEBUG" additivity="false" >
          <AppenderRef ref="MBSEIntegrationClient"/>
       </Logger>
       <Logger name="com.teamcenter.analysisrequest" level="DEBUG" additivity="false" >
          <AppenderRef ref="MBSEIntegrationClient"/>
       </Logger>
       <Logger name="com.teamcenter.swm0binarymgmt.swbinarymgmt" level="DEBUG" additivity="false" >
          <AppenderRef ref="MBSEIntegrationClient"/>
       </Logger>
        <Root level="ERROR">
            <AppenderRef ref="MBSEIntegrationClient"/>
            <AppenderRef ref="MBSEIntegrationSOA"/>
        </Root>
    </Loggers>
</Configuration>

The source topic provides this same sample content in both a .properties-oriented example and an .xml example (both shown as the XML configuration above).