EC2に Tableau Resource Monitoring Tool をインストールする

EC2(Windows Server)にTableau Resource Monitoring Tool をインストールし、Tableau Server の監視をはじめるまでの手順です。
2022.11.24

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

EC2(Windows Server)に Tableau Resource Monitoring Tool をインストールする手順を残すために記事にしました。こちらは 2022/11/22 時点の情報であることにご注意ください。  

Tableau Resource Monitoring Toolとは

概要
Tableau Resource Monitoring Tool(以下、RMT)は、2019.3以降のTableau Serverで利用可能なアドオンの一つです。
Tableau Serverの正常性・パフォーマンスを監視することで、その運用効率化を支援するツールとなっており、利用にはライセンス認証が必要です。

Tableau Resource Monitoring Tool について 高度な管理のライセンス要件

構成
インストールにあたり、RMTの基本的な構成を確認します。
下記は、ドキュメン記載の概要図です。ここで、
Master Server:RMTがインストールされるサーバー
Node:監視対象となる Tableau Server がインストールされたサーバー
となります。

Nodeにエージェントをインストールすると、Tableau Serverのパフォーマンスやアクティビティが取得され、RMTサーバーに情報が送信されます。
RMTの導入には、上述の両サーバーでの作業が必要となります。

前提条件

下記の前提条件のもと、RMTのインストールを試みます。
・Tableau Server 2022.1.8 が稼働済みのサーバー(Window Server 2019)がすでに存在している
 ※Tableau Serverのインストールはこちらを参照ください。
・RMTをインストールするサーバー(RMTサーバー)をローンチするためのVPC、サブネットは構築済み
・RMTサーバーのシステムには、Microsoft Windows Server(2019)を使用

こちらの条件のもと、下記の構成を目指します。

アカウント情報
事前に、下記のアカウント権限について確認しておきます。

アカウント 用途
Tableau Server 管理者アカウント RMTからのAPI接続に必要
Tableau Server の実行サービスアカウント RMTエージェントの実行サービスアカウントは
左記と同一な必要があるため
RMTサーバーの管理者グループユーザー 左記のユーザーでRMTのインストール作業を実施するため

Tableau Server 側の作業
Tableau Server側でも事前に下記の作業を実施しておく必要があります。

・Tableau Server リポジトリへのアクセス有効化、読み取り専用ユーザーの作成
リポジトリへのアクセス有効化、読み取り専用ユーザーの作成は、Tableau Server 側で下記のコマンド実行により設定可能です。
※コマンド実行により Tableau Server が再起動されます。

tsm data-access repository-access enable --repository-username readonly --repository-password <PASSWORD>

RMT設定時に、このユーザー名パスワードが必要になります。

Tableau Server リポジトリへのアクセスを有効にする

・RMTからのインバウンドトラフィックの許可
RMTとTableau Serverとの通信のために、Tableau Server をインストールしたEC2のセキュリティグループのインバウンドルールに下記を追加します。
いずれもRMTサーバーからTableau Serverへの接続に使用されます。ポート8060はTableau Server リポジトリへの接続(既定値)に必要です。

タイプ ポート範囲 ソース
HTTP 80 RMTサーバー セキュリティグループ
HTTPS 443 同上
カスタム 8060 同上

要件

互換性

RMTとTableau Serverとの互換性
RMTとTableau Server間の対応は下記の通りです。Tableau ServerのバージョンにあったRMTのインストールが必要です。
本記事では、Tableau Server 2022.1.8 を使用するため、RMTは 2022.3をインストールします。

Tableau Server との製品互換性

RMTとエージェントの互換性
エージェントとRMTのバージョンで互換性がない場合、重要なインシデントとしてログに記録されます。原則として、RMTとエージェントは同じバージョンの使用が推奨されています。


RMTサーバーの要件

ハードウェア
RMTは、独自のマシンにインストールする必要があり、下記の推奨事項を満たすか、上回っている必要があります。

・8 個の物理 CPU コア (16 個の vCPU)
・CPU は SSE4.2 および POPCNT 命令セットをサポートする必要がある
・64GB RAM
・RMT サーバー用の 500 GB のディスク空き容量
・パフォーマンス用の SSD ドライブまたは同等のもの

Tableau Resource Monitoring Tool の最小ハードウェア要件と推奨事項

OS
Windows Serverの場合、下記に対応しています。
・Windows Server 2012 R2
・Windows Server 2016
・Windows Server 2019


用意したインスタンス

上述の要件を踏まえ、ここでは下記のEC2インスタンスを使用することとします。また、EC2には静的なIPアドレスを関連付けておきます。

項目 設定
OS Windows Server 2019
インスタンスタイプ m5.4xlarge
vCPU 16
メモリ 64 GB
ルートボリューム 汎用SSD(gp2)50 GB
追加ボリューム(Ddrive) 汎用SSD(gp2)500 GB

RMTサーバーのセキュリティグループ
EC2のセキュリティグループ(インバウンドルール)は、下記の通り設定しました。

タイプ ポート範囲 ソース
HTTP 80 MYIP
HTTPS 443 MYIP
Tableau Server セキュリティグループ
RDP 3389 MYIP
カスタム 5671(※) Tableau Server セキュリティグループ

Tableau Server をインストールしたEC2のセキュリティグループからの通信は、それぞれ下記の用途で使用します。
・ポート443
エージェントからRMTサーバーへの接続テスト時に使用。

・ポート5671
エージェントが収集したデータをRMTサーバーへ送信する際に使用。

※後述しますがこちらの5671ポートは、ドキュメントでは5672ポートを使用すると記載があります。
ただし、今回使用したRMTバージョンの設定画面では5671が既定値として設定されていたこと、エージェントからのデータ送信に5671ポートを使用していたことを確認したため、本記事では5671ポートを開いています。

マシン、ネットワーク、アカウントの要件

RMTのインストール

RMTのインストール・セットアップ手順は下記の通りです。 作業は Windows サーバーのローカル管理者グループのメンバーで行います。

1.サーバーソフトウェアのインストール
2.RMT サーバーの構成
3.新しい環境の作成


1.サーバーソフトウェアのインストール

インストールファイルのダウンロード

こちらから、インストーラーをダウンロードします。RMTは Advanced Management の一つで、ここには他のサービスのインストーラーも配置されています。この内、RMTは「Tabrmt-Master-」の名称が含まれるものとなります。ここでは、最新版の2022.3を使用します。
インストーラーをダウンロード後、インストールファイルをダブルクリックし、画面の手順に従ってインストール作業を進めていきます。

インストールパス
RMT既定のインストールパスは C:\Program Files\Tableau\Tableau Resource Monitoring Tool\ です。
既定以外にインストールする場合、下図の「規約に同意」にチェックを入れた後、customize をクリックすることで、インストール先を変更できます。 なお、既定以外の場合へインストールする場合は、\Tableau\Tableau Resource Monitoring Toolの使用が推奨されています。
今回は、追加したDドライブにインストールすることとし、インストール先を、D:\Tableau\Tableau Serverに変更します。

既定以外の場所へのインストール


2.RMT サーバーの構成

次に、サーバーの初期構成の設定画面が表示されます。

ここでは、下記の設定が可能です。
・Server URL
・HTTPS
・Password
・Authentification

Server URL
デフォルトでホスト名、既定のHTTPポートが入力されているはずです。変更の必要がない限り、更新の必要はありません。

HTTPS
既定では「Default」となっています。選択可能なオプションは下記の通りです。

オプション 概要
Default インストーラーによって提供される既定の自己署名証明書が使用されます。
Store Resource Monitoring Tool/config フォルダーにファイルベースの証明書を指定できます。
Local Windows 証明書ストアに証明書の指紋を入力できます。

オプションを決定後、[Test Server Configuration] で構成のテストを行います。
ここでは「Default」のままとしました。「Default」の場合、特に他の設定を行うことなくパスできまるはずです。

・Storeの設定画面

・Localの設定画面

Password
ユーザーアカウントや、後で作成する管理ユーザーアカウントのパスワード要件を設定できます。

Authentification
セッションのタイムアウト期間を設定できます。デフォルトでは、240 分に設定されています。

Test Database ConnectionとTest Message Queue Connection
RMTのインストーラーを起動すると、RMT実行に必要なプログラムとして、RabbitMQ、PostgreSQL データベース等がインストールされます。
ドキュメントには上述の設定の他、このデータベースとキューに対する接続テストの項目について記載があります。今回のバージョン2022.3ではこのテスト項目はありませんでした。

また、データベースとキューの設定変更にはコマンドラインでの作業が必要です。

上記の設定入力が完了したら、画面右下の「Save and Restart Server」をクリックします。RMTが再起動され、RMTの管理ユーザーとパスワード作成を求めるプロンプトが表示されます。


3.新しい環境の作成

管理者でログイン後、環境を作成します。
単一サーバ構成の場合、そのサーバーを、分散インストールの場合、複数のサーバー群を指します。環境の作成には、下記の入力が必要です。

・環境の詳細(環境の名称、任意の名称で可)
・Tableau Repository Configuration
・Tableau Server REST API

Tableau Server の REST API と Tableau Server Repository の構成は、Tableau Server との通信に使用されます。

環境の詳細(環境の名称、任意の名称で可)


Tableau Repository Configuration
RMT は、パフォーマンス上の理由からリポジトリ データベースに直接アクセスする仕様となっています。この動作のために、Tableau Sever 側で下記の作業を済ませておく必要があります。
・Tableau Serverがインストールされたサーバーで、RMTサーバーからのポート8060(既定値)へのインバウンドトラフィックを許可する
読み取り専用データベースユーザーにて、リポジトリへアクセスできるように設定を行う 

上記の設定内容を、RMT側のリポジトリ設定に記載し、接続テストを実施します。

ここで、SSL Modeはデフォルトの「Prefer」としています。オプションは下記の通りです。

オプション 概要
Disabled Tableau Server リポジトリとの接続にSSLを使用しない
Prefer 最初に SSL による接続を試みて、失敗した場合は暗号化されていない接続を試む
Require SSL 接続が失敗した場合、Tableau Server リポジトリへの接続は失敗する(※)

※この場合、Tableau Server との接続には、後述するREST API による接続が用いられます。


Tableau Server REST API
下記の内容を入力します。

項目 概要
Gateway URL Tableau Server gateway へのアクセスに用いるURL
http:/ host名またはIPアドレス /
Tableau Version Tableau Server のバージョン ※APIのバージョン指定に必要
Tableau API Username APIに接続するユーザー。Tableau Serverの全サイトにアクセス可能かつ
管理者権限をもつユーザーである必要がある。
Tableau API Password APIに接続するユーザーのパスワード

ここでは、下記の通り設定し、接続テストを実施しました。

上述の設定・接続テストが完了したら、画面右下の「Save」を押下します。すると、環境設定画面に「Agent Configuration」が追加され、エージェントの設定ファイルをダウンロードできるようになります。

RMTサーバー側での作業はここまでです。
以降は、Tableau Server をインストールしたサーバー側で作業を行います。
※ダウンロードしたエージェントは24時間有効です。また、Tableau Server 側に送信する必要があります。

エージェントのインストール

Tableau Server 稼働中のRMTで監視対象となるサーバー(以下、エージェントサーバー)での作業です。
エージェントのインストール・セットアップ手順は下記の通りです。作業は Windows サーバーのローカル管理者グループのメンバーで行います。

1.サーバーソフトウェアのインストール
2.エージェントの登録


1.サーバーソフトウェアのインストール

こちらから、インストーラーをダウンロードします。RMTエージェントは、この内、「Tabrmt-Agent-」の名称が含まれるものとなります。ここでは、RMTマスターと同様の2022.3を使用します。

インストールパス
インストールファイルを起動したら、はじめにインストール先を指定します。既定ではC:\Program Files\Tableau\Tableau Resource Monitoring Tool\agentとなっています。ここでは、D:\Tableau\Tableau Resource Monitoring Tool\agentにインストールすることとしました。

実行サービスアカウントの指定
エージェントの実行ユーザーアカウントには、Tableau Server 実行ユーザーアカウントと同じアカウントを指定する必要があります。指定したアカウント情報が Tableau Server の実行アカウント情報と異なる場合、エージェントはそのノードの監視データを収集できないので注意します。
Tableau Server の実行アカウントとしてNetwork Serviceアカウントを指定していたので、デフォルトのまま進めます。


2.エージェントの登録

設定ファイルのインポート

次に、エージェント登録画面が表示されます。ここで、RMTサーバーで生成されたエージェントの設定ファイルを指定します。

サーバー情報の入力
設定ファイルのインポートが完了すると、サーバー情報の入力・テスト接続の画面が表示されます。

設定項目は下記の通りです。

項目 概要
Tableau Server Gateway URL 設定ファイルより入力済み
http:/ host名またはプライベートIPアドレス /
Tableau Server でSSLが有効になってる場合、https を使用。
RMT Server URL 設定ファイルより入力済み
https:/ host名またはIPアドレス /
RMT Server certificate thumbprint 設定ファイルより入力済み
RMT Server User name RMTの管理ユーザー名を入力
RMT Server password RMTの管理ユーザーのパスワードを入力

Tableau Server Gateway URLRMT Server URLについては、入力後にテスト接続を実施し、エージェントがそれぞれに到達できることを確認します。
上記の入力とテスト接続が完了したら、「Get Registration Options」を押下し、次の設定に進みます。

メッセージキューの接続確認
こちらも、設定ファイルより情報がすでに入力済みとなっています。テスト接続より、エージェントからRMTサーバーへのメッセージ キュー接続が動作していることを確認します。
項目「Server」はホスト名となっていますが、DNSサーバーが適切に設定されていない場合、エラーとなるので、IPアドレスに変更しても問題ありません。

ここで、項目Portに既定値として5671が入力されていました。
先に述べた通り、ドキュメントでは、エージェントサーバーからのデータ送信は、RMTサーバーのポート5672宛に行われると記載がありますが、既定値(5671)のままとするとこのポートがデータ送信に使用されるようです。ここでは、既定の5671から変更はしませんでした。

次の画面で、これまでの設定内容の確認画面が表示されます。単一のサーバ構成であればここでの追加設定の必要はありません。「Register Agent」を押下しエージェントのインストールと構成を完了します。


RMTサーバー側で確認
エージェントの登録完了後、RMTサーバー側でログインし、メニューの「Admin」 →「Environments」を確認すると、Agent Serviceにエージェントが追加されます。

モニタリングも開始しており、サーバーのパフォーマンス等を確認できます。

さいごに

以上が、RMTのインストールとTableau Server 監視開始までの手順となります。RMTには、2022/10にリリースされた2022.3を使用したためか、一部ドキュメントとの記載と異なる点があったので注意が必要と感じました。
今回は以上になります。この記事がどなたかの参考になれば幸いです。