---
schema_version: "1"
id: 21d68394d1e08fab278e4f6cbd5937626dd107ec81edb26a721b483d9a5d7b2a
title: Change Logging Levels
collection: tableau
version: current
locale: en-gb
portal_url: https://docs.salesforce.com/tableau/current/en-gb/server-linux/logs_debug_level.md
canonical_url: https://help.tableau.com/current/server-linux/en-gb/logs_debug_level.htm
source_site: help.tableau.com
content_type: documentation
content_hash: 5aceb6ad541f5ac70cc05b5adb1c9b467d049d9a1206046a2b20b7be5afe5970
description: Change logging levels for Tableau Services Manager and Tableau Server.
---
[Skip to main content](#main-content)

# 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, as instructed by Support. You should only set a logging level to debug when investigating a specific issue. Changing log levels can have these impacts:

- Increasing the log level to `debug` or `trace` increases the amount of information being logged and can have a significant impact to performance. Reproduce the issue and then reset the logging level back to info.
- Setting the log level to `warn` or `error` can reduce the amount of information so much that it is not useful for Tableau Support.

**Note:** When logging at the `DEBUG` level, full environment information is gathered when Tableau starts. This means that if you have any sensitive information in an environment variable, it may be included in a log. Logging at the default `INFO` level only gathers safe environment information.

## 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 **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.

### Dynamic log level configuration

In version 2020.2, we introduced dynamic configuration. The capability has been expanded in subsequent releases. If you are only changing logging levels for one or more of these components, and are running the appropriate version of Tableau, you can change the logging levels without restarting Tableau Server.

These logging levels are dynamically configurable, beginning with these versions:

- 2020.2 - tsm services (`tsm.log.level`) and control application services (`tsm.controllerapp.log.level`).
- 2020.3 - backgrounder (`backgrounder.log.level`), cluster controller (`clustercontroller.log.level`), data server (`dataserver.log.level`), file store (`filestore.log.level`), data source properties (`tdsservice.log.level`), and VizQL server (`vizqlserver.log.level`).
- 2020.4 - adds interactive microservice container (`tomcatcontainer.log.level`) and application server (`vizportal.log.level`).

## Configuration Keys for Changing Logging Levels

This table includes both dynamically configurable keys and those that are not dynamically configurable.

<table class="table--plain"><tbody><tr class="TableStyle-Basic-Border-Body-Body1"><td class="TableStyle-Basic-Border-BodyE-Column1-Body1"><b>Configuration key</b></td><td class="TableStyle-Basic-Border-BodyD-Column1-Body1"><b>Location of affected logs</b><p>(path begins with <code>/var/opt/tableau/tableau_server/data/tabsvc/logs/</code>)</p></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td class="TableStyle-Basic-Border-BodyE-Column1-Body1"><p><code>tsm.log.level</code></p><p>Changes TSM logging levels for:&nbsp;activationservice, appzookeeper, backuprestore, clientfileservice, databasemaintenance, licenseservice, siteimportexport, tabadminagent, tabadmincontroller, tabsvc</p></td><td class="TableStyle-Basic-Border-BodyD-Column1-Body1"><p><code>/&lt;service&gt;/&lt;service&gt;_node&lt;n&gt;-&lt;instance&gt;.log</code></p><p>example:<code> /clientfileservice/clientservice_node1-0.log</code></p></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td class="TableStyle-Basic-Border-BodyE-Column1-Body1"><p><code>tsm.controlapp.log.level</code></p><p>Changes TSM logging levels for:&nbsp;control applications</p></td><td class="TableStyle-Basic-Border-BodyD-Column1-Body1"><p><code>/&lt;service&gt;/control_&lt;service&gt;_node&lt;n&gt;-&lt;instance&gt;.log</code></p><p>examples:<code> /clientfileservice/control_clientservice_node1-0.log</code></p><p><code> /filestore/control_filestore_node1-0.log</code></p></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td class="TableStyle-Basic-Border-BodyE-Column1-Body1"><p><code> &lt;process&gt;.native_api.log.level</code></p><p>Valid process names are backgrounder, vizportal, vizqlserver, dataserver</p><p><strong>Note:</strong>&nbsp;These are not dynamically configurable.</p></td><td class="TableStyle-Basic-Border-BodyD-Column1-Body1"><code>/vizqlserver/*.txt</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td class="TableStyle-Basic-Border-BodyE-Column1-Body1"><p><code>backgrounder.log.level</code></p><p>Changes logging levels for:&nbsp;Backgrounder</p></td><td class="TableStyle-Basic-Border-BodyD-Column1-Body1"><code>/backgrounder/*.log</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td class="TableStyle-Basic-Border-BodyE-Column1-Body1"><p><code>clustercontroller.log.level</code></p><p>Changes logging levels for:&nbsp;Cluster Controller</p></td><td class="TableStyle-Basic-Border-BodyD-Column1-Body1"><code>/clustercontroller/*.log</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td class="TableStyle-Basic-Border-BodyE-Column1-Body1"><p><code>dataserver.log.level</code></p><p>Changes logging levels for:&nbsp;Data Server</p></td><td class="TableStyle-Basic-Border-BodyD-Column1-Body1"><code>/dataserver/*.log</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td class="TableStyle-Basic-Border-BodyE-Column1-Body1"><p><code>filestore.log.level</code></p><p>Changes logging levels for:&nbsp;File Store</p></td><td class="TableStyle-Basic-Border-BodyD-Column1-Body1"><code>/filestore/*.log</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td class="TableStyle-Basic-Border-BodyE-Column1-Body1"><p><code>gateway.log.level</code></p><p>Changes logging levels for:&nbsp;Gateway control processes</p></td><td class="TableStyle-Basic-Border-BodyD-Column1-Body1"><code>/gateway/*.log</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td class="TableStyle-Basic-Border-BodyE-Column1-Body1"><p><code>gateway.httpd.loglevel</code></p><p><strong>Note:</strong>&nbsp;added in version 2021.3.0</p><p>Changes logging levels for:&nbsp;Gateway</p></td><td class="TableStyle-Basic-Border-BodyD-Column1-Body1"><code>/gateway/*.log</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td class="TableStyle-Basic-Border-BodyE-Column1-Body1"><p><code>hyper.log.level</code></p><p>Changes logging levels for:&nbsp;Hyper</p></td><td class="TableStyle-Basic-Border-BodyD-Column1-Body1"><code>/hyper/*.log</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td class="TableStyle-Basic-Border-BodyE-Column1-Body1"><p><code>tdsservice.log.level</code></p><p>Changes logging levels for:&nbsp;Data Source Properties service</p></td><td class="TableStyle-Basic-Border-BodyD-Column1-Body1"><code>/tdsservice/*.log</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td class="TableStyle-Basic-Border-BodyE-Column1-Body1"><p><code>tomcatcontainer.log.level</code></p><p>Changes logging levels for microservices in:&nbsp;Interactive Microservice Container and Non-Interactive Microservice Container</p></td><td class="TableStyle-Basic-Border-BodyD-Column1-Body1"><code>/tomcatcontainer/*.log</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td class="TableStyle-Basic-Border-BodyE-Column1-Body1"><p><code>vizportal.log.level</code></p><p>Changes logging levels for:&nbsp;Application Server</p></td><td class="TableStyle-Basic-Border-BodyD-Column1-Body1"><code>/vizportal/*.log</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td class="TableStyle-Basic-Border-BodyE-Column1-Body1"><p><code>vizqlserver.log.level</code></p><p>Changes logging levels for:&nbsp;VizQL&nbsp;Server</p></td><td class="TableStyle-Basic-Border-BodyD-Column1-Body1"><code>/vizqlserver/*.log</code></td></tr></tbody></table>

For more information, see [tsm configuration set Options](https://help.tableau.com/current/server-linux/en-gb/cli_configuration-set_tsm.htm).

If you are only changing dynamically configurable logging levels, you do not need to stop or start the server (for more information, see [Dynamic log level configuration](#DynamicLogLevel) above). If you are changing other logging levels, you may need to stop Tableau Server before changing the logging levels and restart it afterwards. If this is the case, you will be prompted.

On a multi-node installation of Tableau Server, set logging levels from the initial node.

To change the logging level:

1. (Optional for dynamically configurable logging levels 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 and gather information about the issue, reset the logging levels to avoid lingering performance impact and additional disk space use.

In Tableau Server 2026.2 and later, you can view and reset all service logging levels to their default values with `tsm maintenance log-levels` commands. For more information, see [tsm maintenance](https://help.tableau.com/current/server-linux/en-gb/cli_maintenance_tsm.htm).

- To see all log level configurations before resetting, run:
    
    `tsm maintenance log-levels list`
- To set all log level configurations to their default values, run:
    
    `tsm maintenance log-levels reset`

For earlier versions of Tableau Server, or to reset specific keys, run the `tsm configuration set` command with the `-d` option.

Examples:

- tsm configuration set -k backgrounder.native\_api.log.level -d
- tsm configuration set -k tsm.log.level -d

You must apply pending changes after resetting log levels. If you’re resetting log levels for Tableau Server processes, check the pending changes list. If the update requires a restart, stop the server, apply the changes and then start it again.