RMT サーバー構成ファイル
このトピックでは、構成ファイルを使用して使用可能な構成オプションについて説明します。Web インターフェイスを使用してこれを行うには、Resource Monitoring Tool サーバー構成を参照してください。
当社の企業価値である「平等」に合致させるため、包括的ではない用語を可能な限り変更しました。場面に応じて用語を変更すると重大な影響につながる可能性があるため、既存の用語を維持します。そのため、CLI コマンドとオプション、インストール フォルダー、構成ファイル、その他のインスタンスには、これらの用語が引き続き使用されます。詳細については、「Tableau ヘルプについて」(新しいウィンドウでリンクが開く)を参照してください。
構成ファイルは %PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\master\config\config.json
にあります。このパスはインストールによって異なる場合もあります。
注: 構成値は、構成ファイルに保存されます。このファイルには直接変更を加えることができますが、構成オプションは、UI で rmtadmin
コマンド ライン ユーティリティを介して利用することをお勧めします。構成ファイルへの変更を適用するには、再起動する必要があります。
構成ファイルに変更を加えた後は、RMT サーバーを再起動する必要があります。
データ保持
デフォルトでは、Resource Monitoring Tool に 2 週間分の詳細データと、10 年分の集計済みレポート データが格納されます。
これは構成可能です。データ保持設定を定義するスニペット例を次に示します。
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 ServerLogging
Tableau Resource Monitoring Tool ログ ファイルを参照してください。
エージェント
エージェント サービスの構成ファイルは %PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\agent\config\config.json
にあります。このパスはインストールによって異なる場合もあります。
構成ファイルに変更を加えた後は、エージェント サービスを再起動する必要があります。
Tableau Server の検出
ほぼすべての状況で エージェントは Tableau Server インストールを自動的に検出するため、標準のエージェント セットアップ プロセス以外の構成は必要ありません。ただし、必要に応じて config.json
ファイルを使用して Tableau Server 情報を手動で設定することもできます。
エージェントの実行に必要な Tableau Server 情報を定義する config.json
のスニペット例を次に示します。
{
"agent": {
"tableauServer": {
"override": true,
"productVersion": 2021.4,
"applicationDirectory": "C:\\Tableau\\Tableau Server\\2021.4"
}
}
}
JSON 書式では、円マークを上記のようにエスケープする必要があります。
agent.tableauServer
構成セクションで使用できる構成値の完全なリストを次に示します。
キー | データ型 | 必須か? | 説明 |
---|---|---|---|
applicationDirectory | 文字列 | 必須 | Tableau Server アプリケーション ルート ディレクトリ。 |
dataDirectory | 文字列 | オプション | Tableau Server データ ファイルを保持するディレクトリ。 |
override | ブール値 | オプション | true の場合、自動的に検出された値より構成値が優先されます。false の場合、構成値が自動的に検出された値のフォールバックとして機能します。 |
productVersion | 数値 | 必須 | Tableau Server のバージョン番号。 |
エージェント ログ
Tableau Resource Monitoring Tool ログ ファイルを参照してください。
共通
共通の構成値は、RMT サーバー アプリケーションとエージェント アプリケーションの両方で使用できます。構成ファイルを見つける方法については、アプリケーション固有のセクションを参照してください。
構成ファイルに変更を加えた後は、アプリケーション サービスを再起動する必要があります。
暗号化されたメッセージング
暗号化されたメッセージングを有効にするには、まず、TLS を許可するように RabbitMQ サーバーを構成する必要があります。詳細については、「暗号化されたデータの収集」管理ガイドを参照してください。
RMT サーバーやエージェントを構成して、暗号化されたメッセージングを有効にする場合は、次のことに注意してください。
- 暗号化を有効にするには、
enabled
フラグとcertificateHostName
の両方が構成されている必要があります。 certificateHostName
変数は、サーバー証明書上の正規名 (CN=) と一致する必要があります。そうでないと接続に失敗します。mq
セクションのport
設定は、RabbitMQ を構成した TLS ポートに基づいて変更しなければならない可能性があります。
mq.tls
構成セクションで使用できる構成値の完全なリストを次に示します。
キー | データ型 | 必須か? | 説明 |
---|---|---|---|
enabled | ブール値 | オプション | true の場合、メッセージング接続用に TLS 暗号化が有効になります。false の場合、メッセージング用に暗号化されていない接続が使用されます。既定値: false |
certificateHostName | 文字列 | オプション | certificateHostName は、サーバー証明書の正規名 (CN=) と一致する必要があります。そうでないと接続に失敗します。既定値: "" |
実行可能なユーザー
"Server/Environment Management (サーバー/環境管理)" の役割を持つ Resource Monitoring Tool 管理者や Resource Monitoring Tool ユーザー。