Was this page helpful?
Yes No

Change Logging Levels

Tableau Server on Windows now includes Tableau Services Manager (TSM), which replaces the Configuration Utility and the tabadmin command line tool. If you need help for an earlier version of Tableau Server, see the Tableau Help page.

By default, Tableau Server logs 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

Note: Logging levels for new TSM processes are set at info and cannot be changed easily. If you are working with Tableau Technical Support and they determine that logs for these processes are needed, they can help you change the logging level temporarily. Processes impacted by this limitation include: Administration Agent, Administration Controller, Client File Service, Service Manager, Database Maintenance, and Backup/Restore.

Change Logging Levels

Set logging levels for Tableau Server using one of several tsm configuration set commands. The command you use depends on which component of Tableau Server you want to change the logging level for.

Configuration key Location of affected logs

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

<process>.native_api.log.level

Valid process names are backgrounder, vizportal, vizqlserver, or dataserver

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

For more information, see tsm configuration set Options.

You need to stop Tableau Server before changing the logging levels, and restart it afterward. If you are running a distributed installation of Tableau Server, set logging levels from the initial node.

To change the logging level:

  1. Stop Tableau Server by typing:

    tsm stop

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

    where <config.key> is <process>.native_api.log.level, vizportal.log.level, or vizqlserver.log.level

    and <config_value> is a valid logging level.

    Examples:

    • tsm configuration set -k backgrounder.native_api.log.level -v debug                    
    • tsm configuration set -k vizqlserver.log.level -v warn
    • tsm configuration set -k vizportal.log.level -v debug
  3. Apply pending changes by running the tsm pending-changes apply command.
  4. Start Tableau Server by running the following command:

    tsm start

Reset Logging Levels

After you gather the information related to the issue you are investigating, reset the logging levels so there is no lingering performance impact.

Reset the logging level back to its default (info) using the appropriate command with a -d option.

Examples:

  • tsm configuration set -k backgrounder.native_api.log.level -d
  • tsm configuration set -k vizportal.log.level -d
  • tsm configuration set - k vizqlserver.log.level -d