變更記錄層級

預設情況下,Tableau 服務管理員 (TSM) 和 Tableau Server 會記錄資訊層級的事件。如果您需要收集更多資訊,可以變更此層級(例如,如果您與 Tableau 支援人員合作)。

依照「支援部門」指示,最佳作法除非是為了排查問題,否則不應提高記錄層級。您只應在調查特定問題時將記錄層級設定為調試。變更記錄層級可能會產生以下影響:

  • 將記錄層級提高到 debug trace 會增加要記錄的資訊量,可能會對效能產生顯著影響。重現問題,然後將記錄層級重設回資訊。
  • 將記錄層級設定為 warnerror 可以大幅減少資訊量,以至於對 Tableau 支援部門沒有用處。

注意:DEBUG 等級登入時,Tableau 啟動會收集完整的環境資訊。這代表如果您在環境變數中有任何敏感資訊,它可能會包含在記錄中。在預設INFO 等級,記錄只收集安全環境資訊。

記錄層級

以下記錄層級是按照記錄的資訊量的遞增順序列出的:

  • off(關閉)
  • fatal(致命)
  • error(錯誤)
  • warn(警告)
  • info (the default)(資訊(預設值))
  • debug(調試)
  • trace(跟蹤)

變更記錄層級

使用 tsm configuration set 組態金鑰為 TSM 和 Tableau Server 程序設定記錄層級。您使用的金鑰取決於您要變更 TSM 或 Tableau Server 中哪個元件的記錄層級。

動態記錄層級組態

在版本 2020.2 中,我們引入了動態設定。在隨後的版本中擴展已擴展此功能。若僅變更其中一個或多個元件的記錄層次,且正在執行正確的 Tableau 版本,則無需重新啟動 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)。

 

用於變更記錄層次的設定鍵

此表包括可動態設定鍵和不可動態設定鍵。

設定鍵受影響的記錄的位置

(路徑以 /var/opt/tableau/tableau_server/data/tabsvc/logs/ 開頭)

tsm.log.level

變更以下項目的 TSM 記錄層級: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> 是上表的其中一組金鑰,<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 選項的適當命令將記錄層級重設回其預設值 (info)。需要在重設層級後套用暫止的變更,且若要重設 Tableau Server 處理序的記錄層級,可能需要在變更之前停止伺服器,然後在套用暫止的變更後啟動伺服器。

範例:

  • tsm configuration set -k backgrounder.native_api.log.level -d
  • tsm configuration set -k tsm.log.level -d
感謝您的意見反應!已成功提交您的意見回饋。謝謝!