ロギング レベルの変更


既定では、Tableau サービス マネージャー (TSM) と Tableau Server は情報レベルでイベントのログを記録しています。さらに多くの情報を収集する必要がある場合 (たとえば、Tableauサポートと連絡している場合)、これを変更することができます。

ベスト プラクティスとして、問題のトラブルシューティングを行っている場合以外は、ロギング レベルを引き上げないことをお勧めします。ロギング レベルをデバッグに設定する必要があるのは、特定の問題を調査する場合のみです。ログレベルを変更すると、次のような影響を受ける可能性があります。

  • ロギング レベルを debug または trace に引き上げると、ログに記録される情報量が増加するため、パフォーマンスに大きく影響する可能性があります。問題を再現したら、ロギング レベルをリセットし、情報に戻してください。
  • ロギング レベルを warn または error に設定すると、情報量が大幅に減ってしまうため、Tableau サポートに役立てることができません。

注: DEBUG レベルでログを記録する場合、Tableau の起動時に完全な環境情報が収集されます。これは、環境変数に機密情報がある場合、その機密情報がログに含まれる可能性があることを意味します。デフォルトの INFO レベルでログを記録する場合は、安全な環境情報のみが収集されます。

ロギング レベル

以下のロギング レベルは、ログに記録される情報量が増加する順に列挙されています。

  • オフ
  • fatal (致命的)
  • error (エラー)
  • warn (警告)
  • info (the default) (情報 (既定))
  • debug (デバッグ)
  • trace (追跡)

ロギング レベルの変更

TSM と Tableau Server プロセスのロギング レベルを、tsm configuration set コンフィギュレーション キーを使用して設定します。使用するキーは、TSM や Tableau Server のどのコンポーネントのロギング レベルを変更するかによって異なります。

動的ログ レベルの構成

動的構成は、バージョン 2020.2 で導入されました。この機能は、それ以降のリリースで拡張されています。1 つまたは複数のコンポーネントに対してログ レベルのみを変更する場合は、Tableau Server を再起動せずに変更できます。

各ログ レベルを動的に設定できるのは以下のバージョンからです。

  • 2020.2 - tsm サービス (tsm.log.level) および制御アプリケーション サービス (tsm.controllerapp.log.level)。
  • 2020.3 - バックグラウンダー (backgrounder.log.level)、クラスタ コントローラー (clustercontroller.log.level)、データ サーバー (dataserver.log.level)、ファイル ストア (filestore.log.level)、データ ソース プロパティ (tdsservice.log.level) および VizQL サーバー (vizqlserver.log.level)。
  • 2020.4 - インタラクティブなマイクロサービス コンテナ (tomcatcontainer.log.level) およびアプリケーション サーバー (vizportal.log.level)。

 

ロギング レベルを変更するための設定キー

この表には、動的に設定できるキーとできないキーの両方が含まれています。

構成キー影響するログの場所

(C:\ProgramData\Tableau\Tableau Server\data\tabsvc\logs\ で始まるパス)

tsm.log.level

Tableau サービス マネージャーのロギング レベルの変更: clientfileservice、licenseservice、tabadminagent、tabadmincontroller、tabsvc

\<service>\<service>_node<n>-<instance>.log

例: \clientfileservice\clientservice_node1-0.log

tsm.controlapp.log.level

TSM ロギング レベルの変更: 制御アプリケーション

\<service>\control_<service>_node<n>-<instance>.log

例: \clientfileservice\control_clientservice_node1-0.log

\filestore\control_filestore_node1-0.log

<process>.native_api.log.level

有効なプロセス名: backgrounder、vizportal、vizqlserver、dataserver

注: これらは動的に構成することはできません。

\vizqlserver\*.txt

backgrounder.log.level

ロギング レベルの変更: バックグラウンダー

\backgrounder\*.log

clustercontroller.log.level

ロギング レベルの変更: クラスタ コントローラー

\clustercontroller\*.log

dataserver.log.level

ロギング レベルの変更: データ サーバー

\dataserver\*.log

filestore.log.level

ロギング レベルの変更: ファイル ストア

\filestore\*.log

gateway.log.level

ロギング レベルの変更: ゲートウェイ コントロール プロセス

\gateway\*.log

gateway.httpd.loglevel

注: バージョン 2021.3.0 での追加

ロギング レベルの変更: ゲートウェイ

\gateway\*.log

hyper.log.level

ロギング レベルの変更: Hyper

\hyper\*.log

tdsservice.log.level

ロギング レベルの変更: データ ソース プロパティ サービス

\tdsservice\*.log

tomcatcontainer.log.level

マイクロサービスのロギング レベルの変更: インタラクティブなマイクロサービス コンテナーとインタラクティブでないマイクロサービス コンテナー

\tomcatcontainer\*.log

vizportal.log.level

ロギング レベルの変更: アプリケーション サーバー

\vizportal\*.log

vizqlserver.log.level

ロギング レベルの変更: VizQL サーバー

\vizqlserver\*.log

詳細については、tsm configuration set のオプションを参照してください。

動的に構成可能なロギング レベルのみを変更する場合は、サーバーを停止または起動する必要はありません (詳細については、上記の動的ログ レベルの構成を参照してください)。その他のロギング レベルを変更する場合は、Tableau Server を停止してからロギング レベルを変更し、その後サーバーを再起動する必要がある場合があります。この場合、プロンプトが表示されます。

Tableau Server の分散インストールを実行している場合、最初のノードからロギング レベルの設定を行います。

ロギング レベルを変更するには、次の手順を実行します。

  1. (2020.2.0 以降で動的に構成可能なロギングのオプション) コマンド プロンプトを開き、次のように入力して Tableau Server を停止します。

    tsm stop

  2. 「tsm configuration set -k <config.key> -v <config_value>」と入力し、ロギング レベルを設定します。

    ここで、<config.key> は上記の表に含まれるキーの 1 つで、<config_value> は有効なロギング レベルです。

    例:

    • tsm configuration set -k backgrounder.native_api.log.level -v debug                    
    • tsm configuration set -k tsm.log.level -v debug
    • tsm configuration set -k tsm.controlapp.log.level -v debug
  3. 保留中の変更を適用するには、tsm pending-changes apply コマンドを実行します。

  4. (サーバーが停止している場合のみオプション) 次のコマンドを実行して Tableau Server を起動します。

    tsm start

ロギング レベルのリセット

問題を再現し、問題に関連する情報を収集したら、パフォーマンスに影響が残らず、追加のディスク領域も使い切らないようにロギング レベルをリセットします。

適切なコマンドに -d オプションを使用して、ロギングレベルを既定 (情報) に戻します。レベルをリセットした後に保留中の変更を適用する必要があります。Tableau Server プロセスのロギング レベルをリセットする場合は、変更を行う前にサーバーを停止し、保留中の変更を適用してからサーバーを起動する必要がある場合があります。

例:

  • tsm configuration set -k backgrounder.native_api.log.level -d
  • tsm configuration set -k tsm.log.level -d
一番上に戻る
フィードバックをお送りいただき、ありがとうございます。フィードバックは正常に送信されました。ありがとうございます!