Upgrading Resource Monitoring Tool

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 cause 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(Link opens in a new window).

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.

Upgrade Notes

Consider the following before you start the upgrade process:

  1. If you are planning to move to use an external repository (PostgreSQL) or external message queue service (RabbitMQ), make sure you review the upgrade best practices section in the following topics:
  2. Starting in version 2022.3, Tableau Resource Monitoring Tool has built-in encrypted communications between RMT Server and Agents. However, you will need to run rmtadmin rotate-mq-certificates on all the Agents to enable TLS. This applies to RabbitMQ that is configured locally on the same machine as RMT Server. For more details on how to do this, see Upgrade steps with enabling TLS for RabbitMQ below.

  3. You may need to reboot the machine during an upgrade. This usually occurs if files are locked and cannot be updated by the installer. If necessary, you will be prompted by the installer. Because of this possibility, you may want to consider doing your upgrades during non-work hours.

  4. When upgrading Resource Monitoring Tool (Server and Agent), if you run the installer as a different Windows user from 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.

  5. 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.

  6. The Resource Monitoring Tool is backward compatible with Tableau Server versions, but not forward compatible. This means the Resource Monitoring Tool version should be equal to or greater than the Tableau Server version you are monitoring.

    For compatibility reasons, Tableau recommends you upgrade the Resource Monitoring Tool first and then follow with a Tableau Server upgrade. For more information, see Product Compatibility with Tableau Server.

How to Upgrade the Resource Monitoring Tool

We recommend you do an in-place upgrade of Resource Monitoring Tool. If you uninstall Resource Monitoring Tool and install a new version of the database, it may result in data corruption and you will be prompted to reinstall the previous version and redo the upgrade process.

  1. Log in to the Resource Monitoring Tool in a browser and confirm it is working before starting the upgrade.

  2. Copy the new version of the RMT Server setup program to the RMT Server machine.

  3. Copy the new version of the RMT Agent setup program to the machines where you have RMT Agents installed. RMT Agents are installed on Tableau Server nodes you are monitoring.

  4. On each Tableau Server node running the RMT Agent service, stop each RMT Agent by using the following command:

    rmtadmin stop

  5. On the machine running the RMT Server service, stop the RMT Server by using the following command:

    rmtadmin stop

  6. In Task Manager on RMT Server and Agent machines, wait until there are not any running processes with Resource Monitoring Tool, tabrmt-master or tabrmt-agent in the name before continuing to the next step.

  7. Run the RMT Server setup program on the machine where RMT Server is installed. This installs or upgrades any required prerequisites and then upgrades the RMT Server.

    You cannot change the install location to a custom directory during the upgrade if the Resource Monitoring Tool was already installed in the default location.

  8. Run the RMT Agent setup program on all the machines where RMT Agents are installed.

    Important: Starting in 2021.4, you must specify a Run As User account for RMT 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 revert to using the default account. You can use the rmtadmin service-setup command post installation to change it to the original custom user account.

  9. Confirm the RMT Server and Agents are running. Start the RMT Server and Agents if they do not automatically restart after the upgrade is complete.

  10. Log in to Resource Monitoring Tool in a 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 the upgrade notes section in the beginning of the topic about the user account to use for upgrade.

    To verify the RMT Agents have been upgraded, go to the Admin menu, select Environments and click the Edit Environment icon to see the environment details. In the Servers tab, you can see the version of the RMT Agent. This can be useful to determine which RMT Agents have been upgraded when you have a multi-node Tableau Server cluster.

Upgrade steps with enabling TLS for RabbitMQ

Since the agents in versions earlier than 2022.3 have been communicating using unencrypted connection to the RabbitMQ message queue service, when upgrading to version 2022.3 or later, those agents need to be updated to use the new secure connection details. The steps to do this are as follows:

  1. After completing the upgrade steps described in the above section, stop all agents by running the following command:

    rmtadmin stop --agent

  2. Download the bootstrap file for the environment by running the following command:

    rmtadmin bootstrap-file --env<myenvironment> --filename <The absolute or relative path including the file name>

  3. Run the following command on each of the machines where the Agent is installed:

    rmtadmin rotate-mq-certificate <BOOTSTRAP_FILE> --username=<RMT Server Username> --password-file=<RMT Server Password file name>

  4. Restart each Agent machine after successfully running the rmtadmin rotate-mq-certificate command.

Who can do this

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.
Thanks for your feedback!Your feedback has been successfully submitted. Thank you!