Tableau Server Topology Changes

This article will help you understand what you need to do when you make certain topology changes to Tableau Server. The changes include: adding or removing a node, adding or removing a process from a node, and changing the number of processes on a node.

Adding a Node

When you add a new node to Tableau Server, you must install the agent on this node. For more information on installing Agent on Tableau Server cluster, see Install the Tableau Resource Monitoring Tool. Until you install the agent, information about this node will not be included in the reports.

Removing a Node

When you remove an existing node from Tableau Server cluster, you must update the environment on the RMT Server.

Use the following steps to update the environment:

  1. Log into the RMT Server web interface.
  2. From the Admin menu, choose Environments. Select the environment that should reflect this change.

  3. Choose Edit Environment. This opens more detailed information about the environment.

  4. From the Servers tab, select the node that was removed from Tableau Server, and choose Delete.

    Note: The host name should match the name or the IP address of the node.

Adding or Removing a Tableau Server Process

When you add or remove a process, or change the number of processes on a node, you must manually update the information on the RMT Server. Until then the data reported may not be up to date or data may be missing.

Use the following steps to update the process information on RMT Server:

  1. Log into the RMT Server web interface.
  2. From the Admin menu, choose Environments. Select the Environment.

  3. Select Edit Environment. This opens more detailed information about the environment.

  4. From the Servers tab, choose the node where the change was made, and select Edit Server.

  5. Choose Tableau Processes. Add or remove processes to align with the changes that were made on Tableau Server.

Re-registering an Agent

There can be situations when you might want to re-register an Agent. One such use case might be when you want to point one node or the entire Tableau Cluster to a different environment. Another example might be if you had to re-image a Tableau Server node and need to install and re-register the Agent. Use the following instructions to re-register the Agent.

There are two ways of re-registering the Agent depending on whether you want to preserve historical monitoring data:

  1. On the RMT Server web interface, navigate to Admin -> Environments. Select the environment. From the Servers tab, click to edit the node you want to re-register the Agent on. This brings up the Server Details page. Select De-register which removes the Agent registration for this node on this environment. You can now run the rmtadmin register command and register the Agent on this node. This method preserves the monitoring history that has been collected from this node.
  2. On the RMT Server web interface, navigate to Admin -> Environments. Select the environment. From the Servers tab, click delete to completely remove the Agent registration for this node on this environment. This also removes historical monitoring data that has been collected on this node. Use this for scenarios where you are ok with losing the history. For example, if you planning to point this node to a new environment, it might be acceptable to remove the historical data and start fresh.

Note: In the RMT Server web interface, each node in a Tableau Server is referred to as a Server. The entire Tableau Server constitutes an environment. For more information, see Concepts

 

Who can do this

To make topology changes, you must be both a Tableau Server Administrator and a Resource Monitoring Tool Administrator.

Thanks for your feedback!