Change Logging Levels

By default, Tableau Services Manager (TSM) and Tableau Server log events at the Info level. You can change this if you need to gather more information (if you are working with Tableau Support, for example).

As a best practice you should not increase logging levels except when troubleshooting an issue. Increasing the log level to debug or trace increases the amount of information being logged and can have a significant impact to performance. You should only set a logging level to debug when investigating a specific issue. Reproduce the issue and then reset the logging level back to info.

Logging Levels

The following logging levels are listed in order of increasing amount of information logged:

  • off
  • fatal
  • error
  • warn
  • info (the default)
  • debug
  • trace

Change Logging Levels

Set logging levels for TSM and Tableau Server processes using one of several tsm configuration set configuration keys. The key you use depends on which component of TSM or Tableau Server you want to change the logging level for.

Note: If you are only changing TSM logging levels (tsm.log.level and tsm.controlapp.log.level) you can do this without restarting Tableau Server.

Configuration key Location of affected logs

(The default path begins with C:\ProgramData\Tableau\Tableau Server\data\tabsvc\logs\)

tsm.log.level

Changes TSM logging levels for:  clientfileservice, clustercontroller, licenseservice, tabadminagent, tabadmincontroller, tabsvc

\<service>\<service>_node<n>-<instance>.log

example: \clientfileservice\clientservice_node1-0.log

tsm.controlapp.log.level

Changes TSM logging levels for: control applications

\<service>\control_<service>_node<n>-<instance>.log

examples: \clientfileservice\control_clientservice_node1-0.log

\filestore\control_filestore_node1-0.log

<process>.native_api.log.level

Valid process names are backgrounder, vizportal, vizqlserver, dataserver

\vizqlserver\*.txt
vizportal.log.level \vizportal\*.log
vizqlserver.log.level \vizqlserver\*.log

For more information, see tsm configuration set Options.

If you are only changing TSM logging levels (tsm.log.level, tsm.controlapp.log.level), you do not need to stop or start the server (for more information, see Dynamic Configuration in What's New and Changed for 2020.2). If you are changing Tableau Server logging levels, or both types of logging levels, you need to stop Tableau Server before changing the logging levels, and restart it afterward. On a multi-node installation of Tableau Server, set logging levels from the initial node.

To change the logging level:

  1. (Optional for TSM logging in 2020.2.0 and later) Stop Tableau Server by opening a command prompt and typing:

    tsm stop

  2. Set the logging level to by typing tsm configuration set -k <config.key> -v <config_value>

    where <config.key> is one of the keys in the above table and <config_value> is a valid logging level.

    Examples:

    • tsm configuration set -k backgrounder.native_api.log.level -v debug                    
    • tsm configuration set -k tsm.log.level -v debug
    • tsm configuration set -k tsm.controlapp.log.level -v debug
  3. Apply pending changes by running the tsm pending-changes apply command.
  4. (Optional, only if server is stopped) Start Tableau Server by running the following command:

    tsm start

Reset Logging Levels

After you reproduce the issue and gather the information related to the issue, reset the logging levels so there is no lingering performance impact and no additional disk space used up.

Reset the logging level back to its default (info) using the appropriate command with a -d option. You need to apply pending changes after resetting the level, and if you are resetting logging levels for Tableau Server processes, you must stop the server before making the change, and start it applying the pending changes.

Examples:

  • tsm configuration set -k backgrounder.native_api.log.level -d
  • tsm configuration set -k tsm.log.level -d
Thanks for your feedback! There was an error submitting your feedback. Please try again.