Install the Tableau Resource Monitoring Tool

The Tableau Resource Monitoring Tool consists of a Master Server that is installed on a dedicated machine, and Agents that are installed on every node in the Tableau Server installation you will be monitoring with Resource Monitoring Tool.

The Resource Monitoring Tool prerequisites and the Master Server must be installed on dedicated hardware to guarantee they have the necessary resources, and that there is no contention for machine resources with other programs or software. These should not be installed on your Tableau Server computer, except in exceptional cases (for example, for limited demonstration purposes in non-production environments).

For information about upgrading from Power Tools for Tableau Server to the Resource Monitoring Tool, see Upgrade Power Tools for Server to Tableau Resource Monitoring Tool.

The installer for installing Resource Monitoring Tool can be found on the Server Management Product and Release Notes site(Link opens in a new window). Starting in 2020.2, a single installer will install the prerequisites and the Master Server. Download all the files that start with Tabrmt. Starting in 2020.2, you will need only two installers: One for Master Server that includes prerequisites, and one for installing the Agent.

Before Installing the Resource Monitoring Tool

  • Review the following requirements and instructions:
  • Make sure the Tableau Server installation you are going to be monitoring is licensed with the Server Management Add-onlicense. You must have a valid Server Management Add-on license to use the Resource Monitoring Tool.
  • Review the size of Tableau Server logs. Once Agent is installed and configured, the Resource Monitoring Tool processes relevant historical data from Tableau Server logs before data is displayed. If there is a large amount of historical log data, it may take a while to process the information which in turn might result in a delay of processing newer events on the Server.

    If you are concerned about the delay, and not having historical information does not concern you, you can do the following to clean up the existing files:

    Note: Performance data like CPU usage and memory usage are not gathered using historical log data and are collected after Agent is installed and configured so cleaning up historical data does not affect performance data.

  • Optional: Enable the readonly built-in user for Tableau Server Repository. This user is used when installing the Resource Monitoring Tool Agent. For more information, see Collect Data with the Tableau Server Repository.

The steps you follow to install Resource Monitoring Tool are:

  1. Install the Master Server.

    When you start the Resource Monitoring Toolinstaller, the setup program will install certain programs required to run Resource Monitoring Tool first. The programs installed are RabbitMQ, Erlang, and a dedicated PostgreSQL database. It will then proceed to install the Master Server.

  2. Install the Agent

    Install the Agent on every one of your Tableau Server nodes. The Agent sends information about Tableau Server usage and performance to the Master Server for reporting.

Setup Architecture

A high level view of the Resource Monitoring Tool setup. This diagram shows a three node Tableau Server Cluster.

 

A detailed view of the Resource Monitoring Tool components installed on the Master Server and Agent.

 

Installation on Windows

Antivirus

We recommend that you exclude Tableau Resource Monitoring Tool Log Files from your antivirus scans. This will improve performance by avoiding contention when Resource Monitoring Tool writes to the log files.

HTTPS

As a best practice, you should use HTTPS to protect sensitive information and user credentials.

The Require HTTPS setting in the Server configuration is used for communications between the users and the Master Server. It is also used when you register an Agent. Regular agent communications between Agent and Master to collect data is done through Rabbit MQ.

Initially, the Resource Monitoring Tool Master Server is installed with a self-signed certificate and will use that certificate for HTTPS communication which includes communication during Agent registration. You can use your own certificate to replace the self-signed certificate. This can be done during Master Server install in the Server Configuration page or after the installation is complete.

SSL Certificate Requirements

If you are using your own certificate, you must have a HTTPS certificate for the appropriate domains. The certificate and private key need to be packaged together and must be able to be referenced from a single thumbprint. The packaged certificate must be stored in the local machine personal folder.

Once you have the certificate imported on the machine, you can then use this certificate to configure HTTPS.

To do this during install, see Step 7 in the Install the Master Server topic.

To do this after you have completed the installation, see HTTPS Configuration.

Who can do this

To install Resource Monitoring Tool, you must have all the following:

  • Administrator permissions on the machine you are installing Resource Monitoring Tool.
  • Tableau Server Administrator site role.
  • Resource Monitoring Tool Administrator account.

Next Step

Install the Master Server

Thanks for your feedback! There was an error submitting your feedback. Please try again.