These instructions are for upgrading an existing installation of Tableau Resource Monitoring Tool.
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.
Note: The Resource Monitoring Tool performs an in-place upgrade, upgrading your current installation to the newer version. Do not uninstall your existing installation before upgrading.
Consider the following before you start the upgrade process:
- You may need to reboot the machine during an upgrade. You might need to consider doing your upgrades during non-work hours.
- When upgrading Resource Monitoring Tool (Server and Agent) , if you run the installer as a different Windows user than the user who ran the original installation, any custom installation directory you used initially may not be detected by the upgrade and will result in the upgrade being installed into a different directory.
If you are upgrading from earlier than 2019.3.1, do one of the following to work around this issue:
- Use the original user account during upgrade
- Provide the custom installation directory path during upgrade.
Sometimes, the Resource Monitoring Tool will modify the database and in such cases, the upgrade process will include a database migration. In case of a database migration, you will see a message banner at the top of the RMT Server web page with a time estimate for completing the process. An example screen shot is shown below:
On expanding the banner you can review the details of the impact of the upgrade. Changes are unique to each release and the details shown are specific to the release.
The Resource Monitoring Tool is backward compatible with Tableau Server versions but not forward compatible. This means that Resource Monitoring Tool version should be equal to or greater than the Tableau Server version that you are monitoring.
Tableau recommends that you upgrade the Resource Monitoring Tool first and then follow with Tableau Server upgrade for compatibility reasons. For more information, see Product Compatibility with Tableau Server.
How to Upgrade the Resource Monitoring Tool
Log in to the Resource Monitoring Tool in the browser and confirm it is working before starting the upgrade.
Copy the Server setup program to the machine where you want to install the RMT Server.
- Copy the Agent setup program where you have Agents installed. Agents are installed on Tableau Server nodes that you are monitoring.
Stop the Tableau Resource Monitoring Tool Agent on all the Tableau Server nodes where Agent is installed by running the command
rmtadmin stop --agent
Stop the Tableau Resource Monitoring Tool RMT Server by running the following command.
Note: Once the services have been stopped, it is best practice to check for any Resource Monitoring Tool processes that are running after the services have been stopped: Any with tabrmt-agent or tabrmt-master. This does not include PostgreSQL or RabbitMQ.
- It can take a little time to fully stop all of the processes running on RMT Server, so in Task Manager, wait until there are not any running processes with Resource Monitoring Tool in the name before the next step.
Run the RMT Server setup program on the machine were RMT Server is installed. This installs or upgrades any required prerequisites and then upgrades the RMT Server.
Note: You cannot change the install location to a custom directory during upgrade if you are currently installed using default location.
Run the Agent setup program on all the Agents.
Click Next on the EULA page to confirm or specify the install location and set up the Run As User. Tableau recommends using \Tableau\Tableau Resource Monitoring Tool as the location for the installing the RMT Server . Example non-default location: D:\Tableau\Tableau Resource Monitoring Tool.
Starting in 2021.4, you must specify a Run As User account for Agent. This account is used to access Tableau Server for gathering monitoring information.
For the Run As User account, specify the same account that you currently use for the Tableau Server Run As User account. If this account was previously set to a custom user account and not the default account (NT AUTHORITY/Network Service), during the upgrade process, it will be reverted to use the default account. You can use the rmtadmin service-setup command post installation to change it to the original custom user account.
Confirm the Agent and RMT Server are running. Start the Agent and RMT Server if they do not automatically restart after the upgrade is complete.
Note: After the upgrade is complete, a browser window that includes the port information will be displayed. Some fields will display default values. Close this browser window and do not click Save unless you wish to revert to those defaults and restart the web server.
- Log in to Resource Monitoring Tool in the browser and confirm that it is working. If your installation is not working, it may be due to an issue with the user account that is used to run the upgrade. See second note in the upgrade notes section in the beginning of the topic about the user account to use for upgrade.
- You can verify the Agents that have been upgraded. From the Admin menu, select
Environmentand click edit to see the environment details. In the Server tab, you can see the version of the Agent. This can be useful to determine which Agents have been upgraded when you a multi-node Tableau Server cluster.
To upgrade Resource Monitoring Tool, you will need to have the following permissions:
- Administrator on the machine you are installing Resource Monitoring Tool.
- Tableau Server Administrator.
- Resource Monitoring Tool Administrator.