Tableau Catalog の有効化

Tableau Catalog は、ワークブック、データ ソース、シート、フローなど、Tableau Online サイトや Tableau Server のすべてのコンテンツを検出してインデックスを作成します。コンテンツ (またはメタデータ)、およびコンテンツのスキーマと系列についての情報を収集するために、インデックス作成が使用されます。その後メタデータより、Catalog は Tableau Online サイトまたは Tableau Server 上のコンテンツが使用するすべてのデータベース、ファイル、表を特定します。

Catalog は Data Management アドオン で入手可能です。詳細については、Data Management アドオンの使用を参照してください。

Catalog に加え、メタデータ メソッドを使用して Tableau メタデータ API や Tableau Server REST API からコンテンツについてのメタデータにアクセスすることもできます。

Tableau Online の Catalog

Tableau Online が Data Management アドオン でライセンスされると、Catalog は自動的に有効になります。

Tableau Online サイトに Data Management アドオン を使用してライセンスが付与されると、Tableau Online サイトに既に存在するコンテンツのインデックスが直ちに作成されます。コンテンツのインデックス作成にかかる時間は、持っているコンテンツの量によって異なります。コンテンツが最初にインデックス化された後、Catalog は新しくパブリッシュされたコンテンツや資産に対する他の変更を監視し、バックグラウンドで引き続きインデックス化します。

Tableau Server の Catalog

Tableau Server 管理者は、Tableau Server 環境で Catalog の最適なパフォーマンスを確保するために、Catalog を有効にする前および有効化の実行中に考慮する必要がある事項がいくつかあります。

Catalog を有効にする前

Catalog を初めてオンにすると、Tableau Server に既に存在するコンテンツのインデックスが直ちに作成されます。Catalog は、インタラクティブでないマイクロサービス コンテナーを使用して、Tableau Server 上のすべてのコンテンツでインデックスを作成します。インデックス作成プロセスは、主に最初の取り込み時とイベントの監視時に危険にさらされることがあります。

Catalog でコンテンツのインデックス作成にかかる時間は、次の 2 つの要素によって異なります。

  • Tableau Server 上のコンテンツの量: コンテンツの量は、ワークブック、パブリッシュされたデータ ソース、および Tableau Server にパブリッシュされたフローの合計数によって測定されます。
  • インタラクティブでないコンテナーで使用できるリソース: 具体的には、インタラクティブでないマイクロサービス コンテナーをサポートするために使用できるスレッド、プロセス、およびメモリの数。インタラクティブでないマイクロサービス コンテナーの詳細については、「Tableau Server マイクロサービス コンテナー」トピックを参照してください。

Catalog の取り込みに影響を与える要因について理解した後で、Catalog を有効にする前に調整が必要になる場合があります。Catalog の有効化をサポートするための推奨プロセスと調整について、以下で説明します。

ステップ 1: Tableau Server 上のコンテンツ量を決定する

Tableau Server 上のコンテンツ量を決定するには、次の手順を実行します。

  1. 管理者の認証資格情報を使用して Tableau Server にサインインします。
  2. [探索] ページに移動します。
  3. [Top-Level Project (トップレベル プロジェクト)] ドロップダウン メニューをクリックし、[すべてのワークブック][すべてのデータ ソース]、および [すべてのフロー] の横にまとめて数値を追加します。これが、Tableau Server 上にあるコンテンツの合計量となります。

ステップ 2: 取り込みにかかる時間を見積もる

Catalog が Tableau Server で初めてコンテンツを取り込むのにかかる時間を見積もるには、お使いの Tableau Server の設定をベースラインの Tableau Server 設定と比較します。

次の設定が含まれる Tableau Server では、最初の取り込みが完了するまでに約 6 時間かかる場合があります。

コンポーネント ベースライン値
コンテンツ 12,000 個のワークブック、パブリッシュされたデータ ソース、およびフロー
スレッド

2

JVM ヒープ サイズ (メモリ) 64 MB (最小) ~ 4 GB (最大)
取り込み 最大 6 時間

お使いの Tableau Server 環境に含まれているコンテンツがだいたい半量程度の場合は、最初の取り込みが完了するまでにかかる時間も半分程度となる見込みです。

たとえば、6,000 (ワークブック、パブリッシュされたデータ ソース、フロー) + 2 (スレッド) = 最大 3 時間 (取り込み)

お使いの Tableau Server 環境に含まれているコンテンツがだいたい 2 倍程度の場合は、最初の取り込みが完了するまでにかかる時間も 2 倍程度となる見込みです。

たとえば、24,000 (ワークブック、パブリッシュされたデータ ソース、およびフロー) + 2 (スレッド) = 最大 12 時間 (取り込み)

ステップ 3 (オプション): 取り込み時間を短縮し、メモリを増やす

初期取り込み速度を上げて取り込み時間を短縮する場合は、インタラクティブでないマイクロサービス コンテナーに割り当てられたスレッドの数を増やすことができます。スレッドの数を増やす場合は、メモリも同様に増やす必要があります。

スレッド

一般に、Catalog での初期取り込みにかかる時間は、割り当てられたスレッドの数に相関します。したがって、見積もられた取り込み時間を半分に減らす場合は、割り当てるスレッド数を 2 倍にします。

スレッドを増やすには、tsm configuration set – k graphletingestor.providerEventIngestorClient.connectionPool.maxConnectionPerInstance コマンドを使用します。詳細については、「tsm configuration」トピックおよび「tsm configuration set のオプション」トピックを参照してください。

メモリ

取り込みに割り当てられるスレッドの数を増やす場合は、JVM ヒープ サイズ (メモリ) も増やして Catalog に関連付けられたサービスをサポートする必要があります。Tableau では、スレッド数を増やすごとに 2 GB 未満のメモリを追加することをお勧めします。

メモリを増やすには、tsm configuration set -k noninteractive.vmopts コマンドを使用します。詳細については、「tsm configuration」トピックおよび「tsm configuration set のオプション」トピックを参照してください。

重要: スレッドとメモリを増やす前に、以下の点を考慮してください。

  • 上記の推奨事項は、インタラクティブでないコンテナーのノードごとやインスタンスごとではなく、すべてのノードの合計スレッド数を対象としています。
  • 一度に 2 つずつのみですがスレッド数を徐々に増やしながら、Tableau Server の環境を細かく監視して Tableau Server リポジトリ (PostgreSQL データベース) の CPU 使用率に関する問題を回避することをお勧めします。
  • 初期取り込みに割り当てられたスレッドが多すぎると、PostgreSQL データベースの CPU 使用率が急増してフェールオーバーする可能性がありますのでご注意ください。監視する必要がある現象には、vizportal ログの SQLException エラーなどがあります。詳細については、「リポジトリ フェールオーバー」トピックを参照してください。

ステップ 4: Data Management アドオン をアクティブ化する

まだ完了していない場合は、最適な Catalog の取り込みをサポートするために必要な調整を行った後で Data Management アドオン をアクティブ化できます。詳細については、Data Management アドオンのライセンスを参照してください。

ステップ 5 (オプション): Catalog の機能をオフにする

Data Management アドオン のアクティブ化の一部として、Catalog の機能は既定で有効になっています。インデックス作成プロセスと完了までにかかる推定時間のため、Catalog を一時的にオフにして、Catalog の機能が完全な状態で提供でき、正確な結果が得られるようになるまで Tableau Server ユーザーがこれらの機能にアクセスできないようにすることを検討してもよいでしょう。

Catalog をオフにするには、以下の手順に従います。

  1. Tableau Server 管理者の認証資格情報を使用して Tableau Server にサインインします。
  2. 左のナビゲーション ペインで、[設定] をクリックします。
  3. [全般] タブで、[Tableau Catalog] の下にある [Tableau カタログをオンにする] チェック ボックスをオフにします。

カタログの有効化

Tableau Server で Catalog を有効にするには、以下の手順に従います。

ステップ 1: tsm maintenance metadata-services enable コマンドを実行する

tsm maintenance metadata-services enable コマンドを実行して、Tableau メタデータ API を有効にします。メタデータ API を有効にした後、Tableau Server が Data Management アドオンでライセンスされると Catalog が自動的にオンになります。tsm コマンドの実行の詳細については、「tsm maintenance」を参照してください。

  1. クラスタの最初のノード (TSM がインストールされているノード) で管理者としてコマンド プロンプトを開きます。
  2. tsm maintenance metadata-services enable コマンドを実行します。

注: このコマンドを実行するときは、次の点に留意してください。

  • このコマンドは、Tableau Server で使用されているいくつかのサービスが停止してから起動します。これによって推奨事項などの一部の機能を一時的に使用できなくなります。
  • この時点で、メタデータの新しいインデックスが作成されます。このコマンドをそれ以降の時間で実行すると、以前のインデックスが作成され、置き換えられます。

ステップ 2: 取り込み状況を監視する

最初の取り込みプロセスが円滑に進むよう、Tableau では、以下の一連の手順を使用して Tableau Server 経由で進行状況を監視することをお勧めします。以下の手順を使用すると、コンテンツ タイプごとに初期取り込みのステータスを取得できます。

ステップ 1: インタラクティブでないマイクロサービス コンテナーのポート番号を取得する

  1. クラスタの最初のノード (TSM がインストールされているノード) で管理者としてコマンド プロンプトを開きます。
  2. tsm topology list-ports コマンドを実行して、インタラクティブでないマイクロサービス コンテナーのポート番号を取得します。
  3. 結果で、noninteractive:primary を検索し、最後の列に記載されたポート番号を書き留めます。ポート番号は、以下のステップ 3 セクションで使用します。

ステップ 2: ブラウザから認証 Cookie を取得する

  1. Google Chrome などのブラウザを開き、Tableau Server 管理者の認証資格情報を使用して Tableau Server にサインインします。
  2. 開発者ツール オプション (またはそれに類似するもの) を使用して [Cookie] セクションに移動し、次の Cookie の値を書き留めておきます: XSFF-TOKEN および workgroup_session_id

    ブラウザ ウィンドウは閉じないでください。

ステップ 3: 取り込みステータスを取得する

上記のステップ 2 セクションと同じブラウザ ウィンドウを使用して、次の操作を実行します。

  • 上記の URI をコピーして、ブラウザのアドレス バーに貼り付ける
  • <your-server> をお使いの Tableau Server のコンピューター名に置き換える
  • <port> を上記のステップ 1 の最後にメモしたポート番号に置き換える

http://<your-server>:<port>/relationship-service-war/control/backfill/status

たとえば、http://10.100.00.0.00:8850/relationship-service-war/control/backfill/status となります。

注: または、上記の URI と要求ヘッダーの次の必須キーを使用して http の GET リクエストを作成し、Postman を使用して取り込みステータスを取得することもできます。

キー
Cookie XSRF-TOKEN=<cookie-value>; workgroup_session_id=<cookie-value>
Content-Type application/json

ステップ 4: 結果を確認する

上記のステップ 3 のエンドポイントから、コンテンツおよびアセットのタイプごとに取り込みステータスを詳細に説明した JSON ブロブが返されます。結果を確認する際は、次の点に注意してください。

  • backfillComplete ステータスが true と表示されている場合は、最初の取り込みが完了したことを示します
  • backfillComplete ステータスが false と表示されている場合は、最初の取り込みがまだ進行中であることを示します

例:

[
{"type":"PublishedDatasource","currentId":{"contentId":null,"pageToken":null},"processedCount":0,"durationSeconds":0,"backfillComplete":true},
{"type":"Database","currentId":{"contentId":null,"pageToken":null},"processedCount":0,"durationSeconds":0,"backfillComplete":true},
{"type":"DatabaseTable","currentId":{"contentId":null,"pageToken":null},"processedCount":0,"durationSeconds":0,"backfillComplete":true},
{"type":"Workbook","currentId":{"contentId":null,"pageToken":null},"processedCount":0,"durationSeconds":0,"backfillComplete":true},
{"type":"Flow","currentId":{"contentId":null,"pageToken":null},"processedCount":0,"durationSeconds":0,"backfillComplete":true}
]

ステップ 3: SMTP セットアップを構成する

Tableau Server でまだ設定していない場合は、SMTP セットアップを構成してください。SMTP は、データの変更に関する連絡が必要な所有者へのメール送信をサポートしています。SMTP の構成の詳細については、「SMTP セットアップの構成」を参照してください。

ステップ 4 (オプション): Catalog 機能をオンにする

上記のいずれかの手順で Catalog を有効にする前に Catalog 機能をオフにした場合は、Catalog をオンにして、ユーザーがその機能にアクセスできるようにする必要があります。

Catalog をオンにするには、次の手順に従います。

  1. Tableau Server 管理者の認証資格情報を使用して Tableau Server にサインインします。
  2. 左のナビゲーション ペインで、[設定] をクリックします。
  3. [全般] タブで、[Tableau Catalog] の下にある [Tableau カタログをオンにする] チェック ボックスをオフにします。

Catalog またはメタデータ API のトラブルシューティング

「Timeout limit and node limit exceeded (タイムアウト制限およびノード制限を超過しました)」メッセージ

大量の結果を返す必要がある Catalog のタスクまたはメタデータ API のクエリが Tableau Sever のすべてのシステム リソースを消費してしまわないようにするため、Catalog ではタイムアウトとノードの両方に制限を設けています。

タイムアウト制限

Catalog 内のタスクまたはメタデータ API のクエリがタイムアウト制限に達すると、管理者およびユーザーに次のメッセージが表示されます。

「Showing partial results, Request time limit exceeded.Try again later. (結果の一部を表示しています。要求時間の制限を超過しました。後でもう一度やり直してください。)」または TIME_LIMIT_EXCEEDED

この問題を解決するには、Tableau Server 管理者として、tsm configuration set –k metadata.query.limits.time コマンドを使用してタイムアウト制限を増やすことができます。詳細については、「tsm configuration」トピックおよび「tsm configuration set のオプション」トピックを参照してください。

重要: タイムアウト制限を増やすと、より多くの CPU をより長く使用でき、Tableau Server 上の他のプロセスのパフォーマンスに影響を与える可能性があります。

ノード制限

Catalog 内のタスクまたはメタデータ API のクエリがノード制限に達すると、管理者およびユーザーに次のメッセージが表示されます。

NODE_LIMIT_EXCEEDED

この問題を解決するには、Tableau Server 管理者として、tsm configuration set –k metadata.query.limits.count コマンドを使用してノード制限を増やすことができます。詳細については、「tsm configuration」トピックおよび「tsm configuration set のオプション」トピックを参照してください。

重要: タイムアウト制限を増やすと、システムのメモリに影響を与える可能性があります。

インデックス作成のパフォーマンス

Catalog で Tableau Server 上のコンテンツのインデックス作成に予想以上に時間がかかる場合は、インタラクティブでないマイクロサービス コンテナーに割り当てるスレッドの数を増やすことを検討してください。メタデータ API を一時的に無効にするには、tsm maintenance metadata-services disable コマンドを実行してから上記のTableau Catalog の有効化セクションで説明した手順に従います。

Tableau Online が Data Management アドオン でライセンスされると、Catalog は自動的に有効になります。

Tableau Online サイトに Data Management アドオン を使用してライセンスが付与されると、Tableau Online サイトに既に存在するコンテンツのインデックスが直ちに作成されます。コンテンツのインデックス作成にかかる時間は、持っているコンテンツの量によって異なります。コンテンツが最初にインデックス化された後、Catalog は新しくパブリッシュされたコンテンツや資産に対する他の変更を監視し、バックグラウンドで引き続きインデックス化します。

Tableau Catalog の無効化

Tableau Server 管理者または Tableau Online サイト管理者は、いつでも Catalog 機能をオフにすることができます。Catalog がオフになっている場合、Tableau Online または Tableau Server 自体から Catalog の機能にアクセスすることができません。この機能には、データ品質に関する警告の追加や、データベースや表の資産に対するパーミッションの明示的な管理などが含まれます。ただし、Catalog はパブリッシュ済みコンテンツのインデックス化を継続し、メタデータには Tableau メタデータ API から、また Tableau Server REST API のメタデータ メソッドからアクセスすることができます。

  1. Tableau Online にサイト管理者として、または Tableau Server にサーバー管理者としてサインインします。

  2. 左側のナビゲーション ペインで、[設定] をクリックします。

  3. [全般] タブで、[Tableau Catalog] の下にある [Tableau カタログをオンにする] チェック ボックスをオフにします。

Tableau Server でのメタデータのインデックス化の中止

Tableau Server でパブリッシュ済みコンテンツのインデックス化を中止するには、Tableau Server 管理者が Tableau メタデータ API を無効にします。メタデータ API を無効にするには、tsm maintenance metadata-services disable コマンドを実行します。詳細については、「tsm maintenance」を参照してください。

注: インデックス化は Tableau Online サイトでは中止できません。

フィードバックをくださりありがとうございます! フィードバックの送信中にエラが発生しました。もう一度やり直すか、メッセージをお送りください