Enabling and disabling logging

Logging is enabled when a TM1® server detects a logging properties file in the same directory where the server's configuration file, tm1s.cfg, is located.

Procedure

  1. Edit a copy of the sample logging properties file, tm1s-log.properties, to configure logging message level and output settings, as described in Configuring logging level in tm1s-log.properties and Configuring logging parameters in tm1s-log.properties.
  2. Put the tm1s-log.properties into the same directory where the configuration file, tm1s.cfg, is located for the TM1 database that you want to monitor.

    The location of the tm1s.cfg file is typically the data directory of the TM1 database, but could be a different location depending on your specific TM1 configuration. For example, if your tm1s.cfg file is located in the C:\salesdata directory on a Microsoft Windows system, then copy the tm1s-log.properties file into this directory.

    After the tm1s-log.properties file is placed in the same directory as the tm1s.cfg file, the server starts logging based on the settings configured in the tm1s-log.properties file. It is not necessary to restart the TM1 server to initialize logging, unless you are running a local server.

    Note: The TM1 local server only checks the logging properties file, tm1s-log.properties, when the local server starts up. After startup, a local server never checks for changes in the tm1s-log.properties file, so all settings in a local server's tm1s-log.properties file must be considered static. If you change any logging properties for a local server, you must restart the server to apply the new logging settings.
  3. To temporarily turn off logging, set the TM1 logger values to either INFO or OFF. Using a value of INFO is recommended.
    • Setting a logger value to INFO will continue some logging, but at a much decreased amount compared to a setting of DEBUG. Using a setting of INFO, instead of OFF, is useful because TM1 will still log important messages for WARN, ERROR, and FATAL messages.
    • Setting a logger value to OFF will stop all logging for that logger, and you could miss any potential WARN, ERROR and FATAL messages.