my default tm1s-log.properties file
Thought I’d share the ‘standard’ tm1s-log.properties file I regularly use. tm1s-log.properties controls how and where tm1 logs things and the config file below generates you 4 files:
- tm1server.log – I’m adding the Debug level for locks to see the name of the objects locked at that point in time. I’m also switching the timezone to local to avoid the mental math of UTC conversion, it’s not worth it unless you’re running a truly global system.
- tm1event.log – Event logging as per this description, tells you ‘thread X was running for more than 100s and was locked by thread Y’ type of things. Still not sure how useful it is, but why not :)
- tm1top.log – this is fairly new (2.7 onwards) and gives you good old tm1top logs as text files. You can either read them like text files (I do this 95% of the time) or you can load them into Apache Jmeter plugin to visualise threads per time
- tm1logins.log – this log just captures ‘user X has logged in’ events and is usefull for various licensing evaluations
I’m also limiting each file to 10mb in size (log4j.appender.S1.MaxFileSize) to make them easier to open and store 10 or 20 of such files (log4j.appender.S1.MaxBackupIndex).
Update 2021/08/16: splitting the locks log to a separate file and disabling the debug logs to the main log
# main logging file
log4j.logger.TM1=INFO, S1
# S1 is set to be a SharedMemoryAppender
log4j.appender.S1=org.apache.log4j.SharedMemoryAppender
# Specify the size of the shared memory segment
log4j.appender.S1.MemorySize=5 MB
# Specify the max filesize
log4j.appender.S1.MaxFileSize=10 MB
# Specify the max backup index
log4j.appender.S1.MaxBackupIndex=20
# event logging configuration
# Meeds EventLogging=T in the tm1s.cfg
# https://www.ibm.com/support/knowledgecenter/SSD29G_2.0.0/com.ibm.swg.ba.cognos.tm1_inst.2.0.0.doc/c_eventlogging.html
log4j.logger.Event=INFO, S_Event
log4j.appender.S_Event=org.apache.log4j.SharedMemoryAppender
log4j.appender.S_Event.MemorySize=1 MB
log4j.appender.S_Event.MaxFileSize=10 MB
log4j.appender.S_Event.MaxBackupIndex=10
log4j.appender.S_Event.File=tm1event.log
log4j.appender.S_Event.Format=TM1Event
# tm1top logging configuration
# Set up TopLogging=T in the tm1s.cfg
# https://www.ibm.com/support/knowledgecenter/SSD29G_2.0.0/com.ibm.swg.ba.cognos.tm1_op.2.0.0.doc/c_pa_top_logger.html
log4j.logger.Top=INFO, S_Top
log4j.appender.S_Top=org.apache.log4j.SharedMemoryAppender
log4j.appender.S_Top.MemorySize=5 MB
log4j.appender.S_Top.MaxFileSize=10 MB
log4j.appender.S_Top.MaxBackupIndex=20
log4j.appender.S_Top.File=tm1top.log
log4j.appender.S_Top.Format=TM1Top
# Logins file -- records every time a user logins, can be used for license evaluation or just checking user activity
log4j.logger.TM1.Login=DEBUG, S_Login
log4j.additivity.TM1.Login=false
log4j.appender.S_Login=org.apache.log4j.SharedMemoryAppender
log4j.appender.S_Login.MemorySize=5 MB
log4j.appender.S_Login.MaxFileSize=10 MB
log4j.appender.S_Login.MaxBackupIndex=20
log4j.appender.S_Login.File=tm1login.log
# it's good to have Locks details -- provides the names of the locked objects
# putting to a separate file to have a cleaner main log as PaW rollbacks requests a lot
log4j.logger.TM1.Lock.Exception=DEBUG, S_Lock
log4j.additivity.TM1.Lock.Exception=false
log4j.appender.S_Lock=org.apache.log4j.SharedMemoryAppender
log4j.appender.S_Lock.MemorySize=5 MB
log4j.appender.S_Lock.MaxFileSize=10 MB
log4j.appender.S_Lock.MaxBackupIndex=20
log4j.appender.S_Lock.File=tm1lock.log