Knowledge Base

Showing results for 
Search instead for 
Did you mean: 

How do I instrument the Tableau Server?


Tableau Server installer/startup spawns a number of processes. We need to identify which processes need to monitor based on the need.


For example, following processes if want to monitor: 

 (Refer tableau-status.png) tableau-status.png








Following commands need to be executed to attach the javaagent to the intended java processes.


We need to make sure that each java process (node) is associated to a different tier.  Example: -Dappdynamics.agent.tierName=vizportal


Step-1: Edit jvm options to attach java agent


tab-install-dir/bin>tabadmin set vizqlserver.vmopts "'-XX:+UseConcMarkSweepGC -XX:NewRatio=2 -XX:SurvivorRatio=6 -XX:+UseParNewGC -XX:+CMSParallelRemarkEnabled -XX:TargetSurvivorRatio=90 -XX:MaxTenuringThreshold=15 -javaagent:C:\vizqlserver\javaagent.jar -Dappdynamics.agent.tierName=vizqlserver'"


tab-install-dir/bin>tabadmin set vizportal.vmopts "'-XX:+UseConcMarkSweepGC -XX:+ExitOnOutOfMemoryError -javaagent:C:\vizportal\javaagent.jar -Dappdynamics.agent.tierName=vizportal'"



tab-install-dir/bin>tabadmin set backgrounder.vmopts "'-XX:+UseConcMarkSweepGC -Xmx512m -Xms256m -javaagent:C:\backgrounder\javaagent.jar -Dappdynamics.agent.tierName=backgrounder’”


tab-install-dir/bin>tabadmin set clustercontroller.vmopts "'-XX:+UseConcMarkSweepGC -Xmx512m -Xms64m -Djna.nosys=true -XX:+ExitOnOutOfMemoryError -javaagent:C:\Anka\4\ver4.3.0.2\javaagent.jar'"


tab-install-dir/bin>tabadmin set searchserver.vmopts "'-XX:+UseConcMarkSweepGC -Xmx512m -Xms256m -XX:+ExitOnOutOfMemoryError -javaagent:C:\Anka\1\ver4.3.0.2\javaagent.jar'"


For each set command execution, the result should be shown like below to indicate the successful update of arguments.


-- value for key <process-name>.vmopts has been set

Example: -- value for key vizportal.vmopts has been set


Step-2: Flush configuration to all the gateways of the tableau server


tab-install-dir/bin>tabadmin set config


Expected output with out any errors:


===== Wrote configuration files to C:/ProgramData/Tableau/Tableau Server/data/ta


   -- Web data connectors were distributed to all gateways.


Step-3: Restart the tableau server to affect the changes


tab-install-dir/bin>tabadmin restart


Expected output with out any errors:



Upon successful instrumentation of the 5 java processes listed in the beginning, the agents should collect and show the application flow map similiar to the attached (refer app-dashboard.png).app-dashboard.png



Potential issues while attaching the agent to the Java process.

Sometimes the java agent will not attach to the java process properly and this can lead to process startup failure.


For example:


tab-install-dir/bin>tabadmin set vizportal.vmopts “-javaagent:C:\app\4.3.5\ver4.3.5\vizportal\javaagent.jar’”


tab-install-dir/bin>tabadmin config

Execution shows something like


*** Configuration used: -XX:+UseConcMarkSweepGC -XX:+ExitOnOutOfMemoryError -j

avaagent:C:\app\4.3.5… -Xmx512m -Xms256m


In the above, it clearly shows that the java agent location is not properly taken by Tableau while updating the jvm arguments. So, as a fix, we need to make sure that the java agent location does not contain - (hyphen), .(dot), _ (underscore).


The example command should work properly if formated correctly:(refer sample-cmd.png)










tab-install-dir/bin>tabadmin set vizportal.vmopts "-javaagent:C:\vizportal\javaagent.jar'"

tab-install-dir/bin>tabadmin config


Execution should show something like:

*** Configuration used: -XX:+UseConcMarkSweepGC -XX:+ExitOnOutOfMemoryError -j

avaagent:C:\vizportal\javaagent.jar -Xmx512m -Xms256m

Version history
Revision #:
9 of 9
Last update:
‎02-04-2019 04:09 PM
Updated by:
Labels (1)

Found this article helpful? Click the Thumbs Up button.
Have an additional comment? Post it below.


how can we remove the instrumentation?



Hi Hurshid,


You can perform the following to remove the instrumentation.


tab-install-dir/bin>tabadmin set vizportal.vmopts

tab-install-dir/bin>tabadmin config

tab-install-dir/bin>tabadmin restart


Set the default .vmopts for all the instrumented processes by removing "-javaagent:C:\vizportal\javaagent.jar'" from the command.