IBM Support

Planning Analytics Server Logging for ODATA\Planning Analytics Workspace

Question & Answer


Question

This Technote provides steps to enable REST API debug logging for the TM1 Server. This logging is essential to understand how Planning Analytics Workspace interacts with a TM1 model.

Answer

Add the following lines to the tm1s-log.properties file. The tm1s-log.properties file can be found in the same directory as the tm1s.cfg file.

log4j.logger.TM1.HttpRequest=DEBUG, S2
log4j.logger.TM1.HttpRequestBody=DEBUG, S2
log4j.logger.TM1.HttpResponse=DEBUG, S2
log4j.logger.TM1.HttpResponseBody=DEBUG, S2
log4j.logger.TM1.Login=DEBUG, S2
log4j.appender.S2=org.apache.log4j.SharedMemoryAppender
log4j.appender.S2.MemorySize=5MB
log4j.appender.S2.File=restapi.log
log4j.appender.S2.MaxFileSize=100MB
log4j.appender.S2.MaxBackupIndex=20
log4j.appender.S2.TimeZone=GMT

If the tm1s-log.properties file does not exist it can be created with the following content. This file must be created in the same directory as the tm1s.cfg file.

log4j.logger.TM1=INFO, S1
log4j.appender.S1=org.apache.log4j.SharedMemoryAppender
log4j.appender.S1.MemorySize=5 MB
log4j.appender.S1.MaxFileSize=100 MB
log4j.appender.S1.MaxBackupIndex=20
log4j.appender.S1.TimeZone=GMT
log4j.logger.TM1.HttpRequest=DEBUG, S2
log4j.logger.TM1.HttpRequestBody=DEBUG, S2
log4j.logger.TM1.HttpResponse=DEBUG, S2
log4j.logger.TM1.HttpResponseBody=DEBUG, S2
log4j.logger.TM1.Login=DEBUG, S2
log4j.appender.S2=org.apache.log4j.SharedMemoryAppender
log4j.appender.S2.MemorySize=5MB
log4j.appender.S2.File=restapi.log
log4j.appender.S2.MaxFileSize=100MB
log4j.appender.S2.MaxBackupIndex=20
log4j.appender.S2.TimeZone=GMT

The REST API debug logging will be written to a restapi.log file in the same directory as the tm1server.log file. No service restart is required after creating or updating the tm1s-log.properties file.

[{"Product":{"code":"SSCTEW","label":"IBM Planning Analytics Local"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Planning Analytics v2.0 - TM1 Server","Platform":[{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"2.0.2;2.0.1;2.0","Edition":"","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

Document Information

Modified date:
12 November 2020

UID

swg22004711