Tableau Serverのコマンドユーティリティ「tabadmin」入門 #tableau

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

はじめに

こんにちは。大阪オフィス唯一のDI部メンバー、tamaです。

本エントリは、Tableau Server Qualified Associateの試験ガイド「評価するスキル」に関連する内容となります。

  • ※2018年4月にバージョン2018.1がリリースされましたが、2018年5月現在のTableau Server Qualified Associateはバージョン10.5が対象のため、バージョンで異なる仕様や挙動については、バージョン10.5を対象にしています。

本エントリの概要

今回は「tabadmin」を見ていきたいと思います。

tabadminとは

Tableau Serverには、サーバーが処理するタスクを自動化(スクリプト化)するためのツールとして、2種類のWindowsベースコマンドラインユーティリティが組み込まれています。 そのうちの1つがtabadminです。

tabadminは、設定の変更やTableau Serverのカスタマイズなど、管理や設定に関係するタスク(システム全体を構成または影響を与えるもの)に使用されます。

ちなみにtabadminはリモートで実行することはできません。別のサーバーやクライアントPCから遠隔で実行させることはできない…ということです。プライマリーのTableau Serverから実行する必要があります。

tabadminの場所

Tabadminは、プライマリのTableau Serverの下記のパスに、あらかじめインストールされています。

C:\Program Files\Tableau\Tableau Server\<version>\bin

tabadminを実行する際は、このディレクトリに入って実行する必要があります。

tabadminを使用してできることの一例

  • Tableau Serverを起動する
  • Tableau Serverを停止する
  • Tableau Serverを再起動する
  • Tableau Serverの構成設定を変更する
  • 多様な目的に応じたTableau Serverの設定
    • プロキシサーバーとの連携
    • クライアントのIPマッチングを強制するデフォルトのポートを変更する
    • Tableau Serverのデータベースへの外部アクセスを有効にする
    • 高可用性を設定する(フェイルオーバー)
  • Tableau Serverをバックアップする
  • Tableau Serverを復元する
  • 圧縮されたログファイルを作成する
  • 古いログをクリーンアップする
  • Tableau Serverのバージョンを確認する
  • Tableau Serverとそのコンポーネントのステータスを確認する
  • Tableau Serverの開始ページ名とロゴを変更する
  • Tableau Serverサイトをエクスポートする
  • Tableau Serverサイトをインポートする

tabadminコマンドの基本構成

以下がtabadminの基本的なコマンドの形式です。

tabadmin <command> [options]

Tabadminには色々なコマンドがありますが、ヘルプ機能を使用して、使い方がわからないコマンドの確認等が行えるため、全てを丸暗記する必要はありません。

ヘルプ機能の例

  • tabadmin help
    • 一般的なヘルプを表示する
  • tabadmin help commands
    • 利用可能なすべてのコマンドを一覧表示する
  • tabadmin help <a command>
    • 記述したコマンドのヘルプを表示する

Tableau Serverの開始、停止、再起動

tabadminはTableau Serverの開始や停止を実施することができます。ここで大事なのは、サーバーの構成を変更するコマンド(例:tabadmin setコマンド)を発行する前は、必ずサーバーを停止してから…という事です。構成変更を行った後は、tabadmin configコマンドでサーバーの構成ファイルに変更をかけて、Tableau Serverを再起動します。

注意点としては、Windowsのコントロールパネルの「サービス」からTableau Serverを停止するのはNGです。tabadminまたはTableau ServerのGUIの方から停止する必要があります。

使用例

  • tabadmin start
    • Tableau Serverサービスを開始する
  • tabadmin stop
    • Tableau Serverサービスを停止する
  • tabadmin restart
    • Tableau Serverサービスを再起動する

Tableau Serverの設定及び構成の変更

Tableau Serverは、YAMLファイルに各種設定情報を保存します。重要なYMLファイルとしては次のものがあります。

  • tabsvc.yml
    • C:\ProgramData\Tableau\Tableau Server\config\tabsvc.yml
  • workgroup.yml
    • C:\ProgramData\Tableau\Tableau Server\data\tabsvc\config\workgroup.yml

YAMLはtabadminでの変更のみ受け付けます。 手動での変更(直接編集)はサポートされていません。

コマンド仕様

tabadmin setコマンドを使用すると、YAMLファイルの値が変更されます。 一般的な構文は次のとおりです。

  • tabadmin set [option-name] [value]
  • tabadmin configure

tabadminを使用してTableau Serverの構成を変更する場合は、tabadmin configure(またはtabadmin config)を実行してサーバーの構成に影響を与えるすべてのファイルを完全に更新する方がよい、というのがTableau側のオススメ方法です。ちなみに、変更した設定は、サーバーが再起動されるまで反映されません。

使用例

  • tabadmin set backgrounder.querylimit 3600
    • 抽出の更新にかかる最長許容時間を3600秒(1時間)に変更します。
  • tabadmin set dataserver.port 9750
    • Data Serverのポートを9750に変更します。
  • tabadmin configure
    • tabsvc.ymlファイルに記述されている全ての設定を、適切なYAMLファイルにコミットします。 変更はサーバーが再起動されるまで有効になりません。

Tableau Serverのカスタマイズ

tabadmin customizeコマンドで、Tableau Serverの見た目(名前とロゴ)を変更できます。変更を有効にするには、このコマンドの後にTableau Serverを再起動する必要があります。

使用例

  • tabadmin cutomize name “classmethod”
    • Tableauサーバー名をclassmethodに変更します。
  • tabadmin customize logo “C:\classmethod.jpg”
    • Tableau Serverロゴをlogo.jpgイメージに変更します。 (160 x 160 ピクセル以下が望ましい)
  • tabadmin customize logo -d
    • Tableau Serverのロゴをデフォルトに戻します。

実践

実際にtabadminを使用してみましょう。今回は内部設定の変更と見た目の変更をしてみたいと思います。

※バージョン2018.1でやってますが、10.5でも同じです。

tabadminの使用準備

コマンドプロンプトを管理者権限で実行します。

Tabadminを実行できる場所に移動します。

cd "C:\Program Files\Tableau\Tableau Server\2018.1\bin"

Tableau Serverを停止する

tabadmin stop

VizQLキャッシュのタイムアウトを変更する

ビューを更新するまでの最大許容時間 (秒)を変更してみます。

tabadmin set vizqlserver.querylimit 900

Tableau Serverの名前を変更する

tabadmin customize name “classmethod”

Tableau Serverのロゴを変更する

今回は弊社のロゴを使用してみます。

tabadmin customize logo C:\header_logo.png

Tableau Serverを開始する

tabadmin start

確認

ちょっとサイズの関係でロゴが見切れてますが、反映されました。

おわりに

今回はtabadminの基本的なところを見てきました。Tableau Serverにおける細かい調整はこちらのコマンドで行うので、是非チェックしておきましょう。

参考