Tableau Resource Monitoring Tool Log Files

Log Files

Tableau Resource Monitoring Tool includes many components. Each component maintains its own set of log files.

By default, 31 log files with a max file size of 1 GB each will be retained in each set. Excess log files beyond that will be deleted automatically.

In an effort to align with our company values of Equality, we have changed non-inclusive terminology where possible. Because changing terms in certain places can causing a breaking change, we maintain the existing terminology. So, you may continue to see the terms in CLI commands and options, installation folders, configuration files. and other instances. For more information, see About Tableau Help.

Components

Component

Log File Location

C:\Program Files\Tableau\Tableau Resource Monitoring Tool\master\logs\

Description
Backgrounder background\YYYYMMDD-pts.log Logs generated by the general background processor.
Director director\YYYYMMDD-pts.log Logs generated by the director background processor.
Host host\YYYYMMDD.log Logs generated by the Windows service host.
Web Server web\YYYYMMDD-pts.log Logs generated by the web server.

For advanced troubleshooting, verbose logging can also be enabled for more internal activities. These activity logs are stored in the associated component’s log directory.

Activity Log File Location Description
Database logs\*\YYYYMMDD-ef.log Logs of internal database queries. By default, only errors are written to this log. Enable by changing db.logLevel to Debug or higher.
Message Queue logs\*\YYYYMMDD-mq.log Logs of internal message queue communication. By default, this log will not be generated. Enable by changing mq.logLevel to Debug or higher.

Log Level Configuration

Resource Monitoring Tool log levels can be adjusted in the following ways:

  • Resource Monitoring Tool web interface: From the Admin menu, navigate to Configuration and select the Advanced tab. You can set the log levels and also specify if you want to include database queries and message queue communications.

    Logging levels you can set using the web interface:

    Level
    Default: Includes Information, Warning, Error, and Critical levels
    Verbose: Includes Information, Warning, Error, Critical (everything in the default) and Debug levels

     

  • Settings in the config.json files. Log levels are configured independently for each component. The default config file paths are below. This may vary depending on your installation folder.

    Install Default Location
    Tableau Resource Monitoring Tool %PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\master\config\config.json
    Tableau Resource Monitoring Tool Agent %PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\agent\config\config.json

    Logging levels that can be configured using the configuration file:

    Level
    Trace
    Debug
    Information
    Warning
    Error
    Critical
    None

    Below is a snippet demonstrating some default log level settings:

Sending Log Files to Tableau Customer Support

If you are working with Tableau Support and they ask you to send log files, zip the files up before you send them:

  1. Connect to RMT Server and each server that has the Resource Monitoring ToolAgent installed.

  2. Open a command prompt and run: rmtadmin ziplogs <output file path>, to create a ZIP archive of the log files.

For more information on sending log files to Tableau, see the Tableau Knowledge Base(Link opens in a new window).

Who can do this

Resource Monitoring Tool Administrator or a Resource Monitoring Tool user with Server/Environment Management role.

Thanks for your feedback!