BIツール
ThoughtSpot
データアナリティクス

【ThoughtSpot CS Tools】searchableについて

8分31秒
【ThoughtSpot CS Tools】searchableについて

ThoughtSpot CS Toolsのsearchableについてご紹介します

ThoughtSpot CS Toolsの概要のご紹介のページはこちらとなります。

ThoughtSpot CS Toolsのご紹介
ThoughtSpot CS Toolsのご紹介
2025.10.28
ThoughtSpot CS Toolsのご紹介 ThoughtSpotのCS Tools はThoughtSpot社のカスタマーサクセスチームチームが作成したツールで、REST...

ThoughtSpotのCS Toolsは以下の機能があります。今回はこのうち「searchable」についてご説明します。

  • archiver　・・・　プラットフォーム内の古い回答とライブボードを管理する
  • bulk-deleter　・・・　プラットフォームからメタデータオブジェクトを一括削除する
  • bulk-sharing　・・・　ブラウザ内でテーブルおよび列レベルのセキュリティをスケーラブルに管理する
  • extractor　・・・　ワークシート、ビュー、またはテーブルからデータを抽出する
  • git　・・・　開発者にとって使いやすい方法でvsc/git APIエンドポイントを使用する
  • scriptability　・・・　ThoughtSpot環境間でTMLをメンテナンスする
  • searchable　・・・　ThoughtSpotでThoughtSpotメタデータを探索する
  • usermanagement　・・・　ユーザーを一括管理する（現在ユーザー削除と所有オブジェクトの移転のみが行えます）

CS Tools「searchable」とは？

CS Toolsのsearchable機能は、検索可能性、とでも訳すのでしょうか？メタデータ、監査ログ、環境のスナップショット、などを取ることができる機能です。これにより、様々なものを外部で検索することがなどができるようになります。

 

全体（機能問わず）で共通のオプション

以下は、各機能共通のオプションになります（すべての機能で有効になるわけではないのでご注意ください）。

--config：コマンドの対象となるThoughtSpotのクラスタの接続先の設定ファイルを指定します。ほぼすべてのコマンドで必須です。

--temp-dir：一時ファイルが作成されるフォルダを指定します

--verbose：「cs_tools logs report」で出力することのできるログファイルについて、このオプションを設定するとより詳しいログを得ることが可能になります。

scriptabilityについて

audit-logsオプション

ThoughtSpotの監査ログを取得する機能です。注意ポイントとして、ログの保持期間は30日までとなります。ログを手元に残したい場合は、30日以内に取得する必要があります。

 

オプション

--last-k-days：1~30の間で設定が可能です。これは、監査ログを過去何日取得するか、というオプションです。デフォルトは1。

--window-end：どの時点までのログを取得するかを選択します。デフォルトはNOWです。それ以外にTODAY_START_UTC、TODAY_START_LOCALの二種類のオプションが選択可能です。が、TODAY_START_LOCALは現在うまく動かないようです。

 

使用例：

cs_tools tools searchable audit-logs --last-k-days 5 --window-end TODAY_START_UTC --syncer "csv://directory=.&delimiter=," --config mysetting

上のコマンドにより、以下のような画面がでてきます。

bi-serverオプション

ThoughtSpotの利用状況の統計データを取得します。取得できるデータは以下のとおりです。

  • cluster_guid
  • sk_dummy
  • org_id
  • incident_id
  • timestamp
  • url
  • http_response_code
  • browser_type
  • browser_version
  • client_type
  • client_id
  • answer_book_guid
  • viz_id
  • user_id
  • user_action
  • query_text
  • response_size
  • latency_us
  • impressions

 

オプション

各設定は以下のとおりです。

--from-date：取得開始日

--to-date：取得終了日

--org：対象Org

--compact/--full：デフォルトでは「--compact」ですが、この場合User ActionがNullではないものだけを出力します。

 

使用例：

cs_tools tools searchable bi-server --from-date 2025-10-15 --to-date 2025-10-17 --syncer "csv://directory=.&delimiter=," --config mysetting

以下のように出力されます。

 

metadataオプション

ThoughtSpotのメタデータ（Orgの情報やグループやその権限、ユーザーやデータソース情報などの設定情報）を出力する機能です。

 

オプション

--include-column-access：オンにすると、列レベルセキュリティのデータも出力します

--org：対象となるOrg

 

使用例：

cs_tools tools searchable metadata --syncer "csv://directory=.&delimiter=," --config mysetting

 

上のコマンドで以下のような画面がでてきます。

実際に出力されたファイル群は以下のとおりです。今回はSyncerでCSVファイルを選んでいるためCSVで出力されていますが、DBに保存することも可能です。

 

tmlオプション

TMLで対象のThoughtSpotのOrgに登録されているモデルもしくはライブボードのスナップショットを取る機能です。

オプション

--org：対象のORGです。

--metadata-type：出力するタイプを選択します。MODELかLIVEBOARDが選択可能です。

--strategy：DELTAとSNAPSHOTが選択できます。Syncersでデータベースを保存先に指定している場合はDELTAが利用できます。DELTAは前回のスナップショットからの変更したところのみが保存されます。

--tml-format：保存するTMLのフォーマットを指定できます。JSONとYAMLから選択できますが、デフォルトではYAMLです。普段見てるのはYAMLなので、基本的にはYAMLを選択することが多そうです。

--directory：TMLファイルの出力先

 

使用例：

cs_tools tools searchable tml --metadata-type MODEL --directory c:\\temp --syncer "csv://directory=.&delimiter=," --config mysetting

 

このサンプルで以下のような画面になります。

エラーが大量に出ていますが、システムのモデルがエクスポートできなくてエラーになっているようです。

 

※2025/12/11時点の情報です

おすすめの記事