Configuring Admin Server logging

Configuration for TM1® Admin Server logging is contained in the tm1admsrv-log.properties file. This file is located in the <pa_install_directory>\bin64 directory.

The sections of the tm1admsrv-log.properties file are:

  • Logger section

    Configures the TM1 subcomponents and message severity level that you want to log.

    Example:

    log4j.rootLogger=INFO*, R1

    log4j.logger.TM1=INFO

    *INFO is the message level.

  • Appender section

    Example:

    Controls the output destination of the logging. The default configuration uses the RollingFileAppender option to write messages to the tm1admsrv.log file.

    # R1 is set to be a RollingFileAppender

    log4j.appender.R1=org.apache.log4j.RollingFileAppender

    log4j.appender.R1.File=tm1admsrv.log*

    log4j.appender.R1.MaxFileSize-10 MB

    log4j.appender.R1.MaxBackupIndex=2

    *tm1admsrv.log is the log file name.

  • Pattern Layout section

    Controls the output fields and formatting of the messages that are written to the log file. The default settings use a time reference of GMT.

    Example:

    # R1 uses PatternLayout

    log4j.appender.R1.layout=org.apache.log4j.PatternLayout

    log4j.appender.R1.layout.ConversionPattern=%t %p %d(%Y-%m-%d %H:%M:%S,%Q) %c %m%n

    log4j.appender.R1.layout.TimeZone=GMT

The default logging configuration logs all INFO level messages. You can adjust the logging message level by editing the following two statements in the tm1admsrv-log.properties file:

log4j.rootLogger=INFO, R1
log4j.logger.TM1=INFO

For example, replace INFO with the DEBUG logging level:

log4j.rootLogger=DEBUG, R1
log4j.logger.TM1=DEBUG
Note: The default logging configuration is intended for everyday use and does not typically require adjustment. Contact customer support for assistance if you need to configure the logging properties file for troubleshooting purposes.