Tableau Server on Windows Help

This topic describes the configuration options you can use using the configuration file. To do this using the web interface, see Resource Monitoring Tool Server Configuration .

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

The configuration file is located at %PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\master\config\config.json. This path may vary depending on your installation.

Note: Configuration values are saved in the configuration file. Changes can be made directly to this file, but it is advised to leverage the configuration options in the UI and through the rmtadmin command line utility. Changes to the config file will require a restart to be applied.

You will need to restart the RMT Server after making changes to the configuration file.

Data Retention

By default the Resource Monitoring Tool stores two weeks of detail data and ten years of aggregated reporting data.

This is configurable. Here is an example snippet defining the data retention settings:

{  
  "db":  {  
    "cleanup":  {  
      "afterDays":  14,  
      "aggregate":  {  
        "afterDays":  3650  
      }  
    }  
  }  
}

SMTP Configuration

An example config.json snippet defining the SMTP information:

{  
  "smtp":  {  
    "server":  "localhost",  
    "port":  25,  
    "username":  "my-username",  
    "password":  "my-password",  
    "requireSSL":  true  
  }  
}

The full list of configuration values available in the smtp configuration section:

Notification Configuration

An example config.json snippet defining the notification information:

{  
  "notifications":  {  
    "email":  {  
      "from":  "sender@domain.com",  
      "to":  "recipient1@domain.com,recipient2@domain.com"  
    }  
  }  
}

Global notification information (as shown above) can be overridden per environment in the environments section:

{  
  "environments":  {  
    "Environment1":  {  
      "notifications":  {  
        "email":  {  
          "from":  "sender@domain.com",  
          "to":  "recipient1@domain.com,recipient2@domain.com"  
        }  
      }  
    }  
  }  
}

The full list of configuration values available in the notifications.email configuration section:

Histogram Configuration

The boundaries used to generate histograms in the web interface are configurable, using an array of values that represent each boundary.

The full list of configurable histograms in the monitoring.histograms section:

As an example, to use the following histogram buckets for everything at a global level:

• ≤ 1 second
• > 1 second and ≤ 10 seconds
• > 10 seconds and ≤ 30 seconds
• > 30 seconds

The configuration would look like:

{  
  "monitoring":  {  
    "histograms":  {  
      "viewLoadDuration":  [1000,  10000,  30000],  
      "externalDataRequestDuration":  [1000,  10000,  30000],  
      "backgroundTaskDuration":    [1000,  10000,  30000]  
    }  
  }  
}

Histogram boundaries can also be set per environment. As an example, for an environment whose identifier is “staging-environment” to use the following view histogram buckets:

• ≤ 2.5 seconds
• > 2.5 seconds and ≤ 5 seconds
• > 5 seconds and ≤ 30 seconds
• > 30 seconds and ≤ 1 minute
• > 1 minute and ≤ 10 minutes
• > 10 minutes

The configuration would look like:

{  
  "environments":  {  
    "staging-environment":  {  
      "monitoring":  {  
        "histograms":  {  
          "viewLoadDuration":  [2500,  5000,  30000,  60000,  600000]  
        }  
      }  
    }  
  }  
}

The “staging-environment” would fall back to the global histogram configuration for background tasks.

Incident Configuration

See Incidents for information on what incident options are available and how to configure them.

RMT ServerLogging

See Tableau Resource Monitoring Tool Log Files.

Agent

The agent service’s configuration file is located at %PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\agent\config\config.json. This path may vary depending on your installation.

You will need to restart the agent service after making changes to the config file.

Tableau Server Detection

In almost all situations agents will automatically detect the Tableau Server installation and no configuration is needed beyond the standard agent setup process. If desired, you can however manually configure the Tableau Server information through the config.json file.

An example config.json snippet defining the Tableau Server information needed to run the agent:

{  
  "agent":  {  
    "tableauServer":  {  
      "override":  true,  
      "productVersion":  2021.4,  
      "applicationDirectory":  "C:\\Tableau\\Tableau Server\\2021.4"  
    }  
  }  
}

The full list of configuration values available in the agent.tableauServer configuration section:

Agent Logging

See Tableau Resource Monitoring Tool Log Files.

Common

Common configuration values are available in both RMT Server and Agent applications. See application-specific sections for guidance on locating the configuration file.

You will need to restart the application service after making changes to the config file.

Encrypted Messaging

To enable encrypted messaging, the RabbitMQ server must be first configured to allow TLS. See the Encrypted Data Collection administrator guide for more details.

When configuring the RMT Server or Agent(s) for encrypted messaging:

• Both the enabled flag and the certificateHostName must be configured for encryption to be enabled.
• The certificateHostName variable MUST match the canonical name (CN=) on the server certificate or the connection will fail.
• The port setting in the mq section will likely need to be changed based on the TLS port you configured RabbitMQ.

{  
  "mq":  {  
    "port":  5671,  
    "tls":  {  
      "enabled":  true,  
      "certificateHostName":  "foo"  
    }  
  }  
}

The full list of configuration values available in the mq.tls configuration section:

Who can do this

Resource Monitoring Tool Administrator or a Resource Monitoring Tool user with Server/Environment Management role.