RMT Server 配置文件
本主题介绍可通过配置文件使用的配置选项。若要使用 Web 界面执行此操作,请参见Resource Monitoring Tool 服务器配置。
为了与我们公司的平等价值观保持一致,我们在可能的情况下更改了非包容性术语。由于在某些地方更改术语可能会导致重大更改,因此我们保留现有术语:因此,您可能会继续在 CLI 命令和选项、安装文件夹、配置文件和其他实例中看到这些术语。有关详细信息,请参见“关于 Tableau 帮助”(链接在新窗口中打开)。
配置文件位于 /var/opt/tableau/tabrmt/master/config.json
。
注意:配置值保存在配置文件中。可以直接对此文件进行更改,但建议利用 UI 中的配置选项以及通过 rmtadmin
命令行实用工具进行更改。对配置文件的更改将需要重新启动才能应用。
对配置文件进行更改之后,您将需要重新启动 RMT Server。
数据保留
默认情况下,Resource Monitoring Tool 会存储两周的详细信息以及十年的聚合报告数据。
这是可配置的。以下是对数据保留设置进行定义的示例代码段:
SMTP 配置
下面是对 SMTP 信息进行定义的示例 config.json
代码段:
{
"smtp": {
"server": "localhost",
"port": 25,
"username": "my-username",
"password": "my-password",
"requireSSL": true
}
}
配置值的完整列表可在 smtp
配置部分中找到:
键 | 数据类型 | 是否必需? | 描述 |
---|---|---|---|
server | 字符串 | 可选 | 要使用的 SMTP 服务器。默认值:localhost |
port | 数字 | 可选 | SMTP 服务器的端口号。默认值:25 |
username | 字符串 | 可选 | 要在服务器需要进行身份验证的情况下使用的用户名。 |
password | 字符串 | 可选 | 要在服务器需要进行身份验证的情况下使用的密码。 |
requireSSL | 布尔值 | 可选 | 如果 SMTP 服务器需要 SSL,则为 true ,否则为 false 。默认值:false |
通知配置
下面是对通知信息进行定义的示例 config.json
代码段:
{
"notifications": {
"email": {
"from": "sender@domain.com",
"to": "recipient1@domain.com,recipient2@domain.com"
}
}
}
可以在 environments
部分中按环境覆盖全局通知信息(如上所示):
{
"environments": {
"Environment1": {
"notifications": {
"email": {
"from": "sender@domain.com",
"to": "recipient1@domain.com,recipient2@domain.com"
}
}
}
}
}
配置值的完整列表可在 notifications.email
配置部分中找到:
键 | 数据类型 | 是否必需? | 描述 |
---|---|---|---|
from | 字符串 | 必需 | 发件人的电子邮件地址。 |
to | 字符串 | 必需 | 收件人电子邮件地址。多个地址必须用逗号或分号分隔。 |
minimumIncidentSeverity | 字符串 | 可选 | 发送电子邮件的最低事件严重程度。默认值:critical 。另请参见Tableau Resource Monitoring Tool - 事件. |
直方图配置
用于在 Web 界面中生成直方图的边界是可配置的,并使用表示每个边界的值数组。
monitoring.histograms
部分中可配置直方图的完整列表:
键 | 数据类型 | 是否必需? | 描述 |
---|---|---|---|
viewLoadDuration | 数字数组 | 可选 | 视图加载的直方图边界。值以毫秒为单位。默认值:[1000, 3000, 6000, 10000] |
externalDataRequestDuration | 数字数组 | 可选 | 外部数据请求的直方图边界。值以毫秒为单位。默认值:[1000, 3000, 6000, 10000] |
backgroundTaskDuration | 数字数组 | 可选 | 后台任务的直方图边界。值以毫秒为单位。默认值:[60000, 300000, 600000, 1800000] |
例如,若要在全局级别为所有内容使用以下直方图数据桶:
- ≤1 秒
- > 1 秒并 ≤ 10 秒
- > 10 秒并 ≤ 30 秒
- > 30 秒
则配置将如下所示:
{
"monitoring": {
"histograms": {
"viewLoadDuration": [1000, 10000, 30000],
"externalDataRequestDuration": [1000, 10000, 30000],
"backgroundTaskDuration": [1000, 10000, 30000]
}
}
}
也可以为按环境设置直方图边界。例如,若要使其标识符为“staging-environment”的环境使用以下视图直方图数据桶:
- ≤ 2.5 秒
- > 2.5 秒并 ≤ 5 秒
- > 5 秒并 ≤ 30 秒
- > 30 秒并 ≤ 1 分钟
- > 1 分钟并 ≤ 10 分钟
- > 10 分钟
则配置将如下所示:
{
"environments": {
"staging-environment": {
"monitoring": {
"histograms": {
"viewLoadDuration": [2500, 5000, 30000, 60000, 600000]
}
}
}
}
}
对于后台任务,“staging-environment”将回退为使用全局直方图配置。
最低 TLS 版本
默认情况下,RMT 将使用安全版本的 TLS 来加密流量。默认最低版本为 1.2,但如果您有特定的安全要求,要求禁用旧版本的 TLS,则可以修改配置文件的 server.minimumTlsVersion
部分以强制使用最低 TLS 版本,如下面的示例代码片段所示,其中最低版本设置为 1.3。minimumTlsVersion
的有效值列表在 .Net Core 的 SslProtocols(链接在新窗口中打开) 中定义。
事件配置
请参见事件,了解有关哪些事件选项可用以及如何配置它们的信息。
RMT Server 日志记录
代理
代理服务的配置文件位于 /var/opt/tableau/tabrmt/master/config.json
对配置文件进行更改之后,您将需要重新启动代理服务。
Tableau Server 检测
在几乎所有情况下,代理都将自动检测 Tableau Server 安装,并且除了标准代理设置过程外,不需要进行任何配置。不过,在需要的情况下,您可以通过 config.json
文件手动配置 Tableau Server 信息。
下面是对运行代理所需的 Tableau Server 信息进行定义的示例 config.json
代码段:
{
"agent": {
"tableauServer": {
"override": true,
"productVersion": 2021.4,
"applicationDirectory": "/var/opt/tableau/tableau_server/2021.4"
}
}
}
配置值的完整列表可在 agent.tableauServer
配置部分中找到:
键 | 数据类型 | 是否必需? | 描述 |
---|---|---|---|
applicationDirectory | 字符串 | 必需 | Tableau Server 应用程序根目录。 |
dataDirectory | 字符串 | 可选 | 用于获取 Tableau Server 数据文件的目录。 |
override | 布尔值 | 可选 | 设置为 true 以使配置值优先于任何自动检测到的值。设置为 false 以使配置值充当自动检测到的值的后备。 |
productVersion | 数字 | 必需 | Tableau Server 的版本号。 |
代理日志记录
请参见Tableau Resource Monitoring Tool 日志文件。
通用值
RMT Server 和代理应用程序中都有一些通用配置值。有关查找配置文件的指引,请参见特定于应用程序的部分。
对配置文件进行更改之后,您将需要重新启动应用程序服务。
加密消息传递
若要实现加密消息传递,必须首先将 RabbitMQ 服务器配置为允许 TLS。有关更多详细信息,请参见加密数据集合管理员指南。
为加密消息传递配置 RMT Server 或代理时:
- 必须同时
enabled
标志和certificateHostName
才能启用加密。 certificateHostName
变量必须与服务器证书上的规范名称 (CN=) 匹配,否则连接将失败。- 将根据需要根据您为 RabbitMQ 配置的 TLS 端口更改
mq
部分中的port
设置。
配置值的完整列表可在 mq.tls
配置部分中找到:
键 | 数据类型 | 是否必需? | 描述 |
---|---|---|---|
enabled | 布尔值 | 可选 | 设置为 true 可为消息传递连接启用 TLS 加密。设置为 false 可为消息传递使用非加密连接。默认值:false |
certificateHostName | 字符串 | 可选 | certificateHostName 必须与服务器证书的规范名称 (CN=) 匹配,否则连接将失败。默认值:"" |
谁可以执行此操作
具有服务器/环境管理角色的Resource Monitoring Tool管理员或Resource Monitoring Tool用户。