tsm configuration set 選項

以下是您可以使用 tsm configuration set 命令進行設定之組態選項或金鑰的清單。在許多情況下,您可以使用 tsm configuration get 命令找出組態金鑰目前的值。

此清單並非 Tableau Server 組態設定的完整清單。其中僅顯示伺服器管理員可設定的部分組態金鑰。最終,Tableau Server 內部使用的某些金鑰並未顯示在此清單中。

附註: 組態金鑰區分大小寫。

使用 tsm CLI

您可在初始節點(安裝 TSM 的所在節點),或是叢集中的任何其他節點上執行 tsm 命令。

若要執行 tsm 命令,您必須開啟 Windows 命令提示字元。請勿使用 PowerShell 執行 tsm 命令。使用 PowerShell 可能會出現非預期的行為。

  1. 使用屬於叢集中節點上的「管理員」群組成員的帳戶開啟 Windows 命令提示字元。

  2. 執行您要的命令。如果您透過非初始節點執行命令,請加入 -s 選項以按照名稱(而非 IP 位址)指定初始節點的 URL,以及加入 TSM 連接埠 8850。

    若要從初始節點查看 TSM 和 Tableau Server 的版本:

    tsm version

    若要從其他節點查看 TSM 和 Tableau Server 的版本:

    tsm version -s https://<inital_node_name>:8850

    例如:

    tsm version -s https://myTableauHost:8850

tsm 組態金鑰的基本用途

設定組態金鑰

tsm configuration set -k <config.key> -v <config_value>

在某些情況下,必須加入 --force-keys 選項才能針對先前尚未設定之金鑰的組態值進行設定。有關詳情,請參閱 「不明金鑰」回應

設定組態金鑰值之後,您必須使用 tsm pending-changes apply 套用待定組態變更。在您執行該操作之前,新值將不會由 Tableau 使用或顯示在 tsm configuration get 命令的結果中。您可以使用 tsm pending-changes list 檢視待定變更。有關詳情,請參閱 tsm pending-changes

將組態金鑰重設為預設值

若要將設定鍵重設回其預設值,請使用 -d 選項:

tsm configuration set -k <config.key> -d

檢視組態金鑰目前的值

若要檢視組態機碼目前的設定,請使用 configuration get 命令:

tsm configuration get -k <config.key>

在以下兩種特殊情況下,不會為金鑰傳回有用的目前值:

  • 在某些情況下,無法取得未明確設定之金鑰的組態值。系統會改以 tsm configuration get 命令傳回「不明金鑰」反應。有關詳情,請參閱 「不明金鑰」回應

  • 對於具有預定義預設值的某些金鑰, tsm configuration get 命令會傳回「Null」回應。有關更多資訊,請參閱 「Null」值回應

組態金鑰

adminviews.disabled

預設值: false

停用 Tableau 管理檢視存取。預設情況下,檢視存取為啟用狀態(此選項設定為「false」)。

api.server.enabled

版本: 在版本 2023.1 中已棄用。無法在版本 2023.1 及更高版本中停用 REST API。

預設值: true

允許存取 Tableau Server REST API (連結在新視窗開啟)

預設情況下,此功能已啟用。我們強烈建議您保持此設定。停用 REST API 會破壞 Tableau 的大量功能,不會提高效能或增強安全性。若選擇在安裝 Tableau Server 時停用 REST API,請仔細測試需要的功能。

停用 REST API 影響的功能包括:

  • 搜尋
  • 我的最愛
  • 集合
  • 內容管理工具 (CMT)
  • Resource Monitoring Tool (RMT)
  • 個人空間

auditing.enabled

預設值: true

允許存取 PostgreSQL(Tableau Server 自己的資料庫)歷史審計表。

backgrounder.default_run_now_priority

預設值(整數):0

此設定控制指派哪個工作優先順序來執行目前的工作,其中 0 為最高工作優先順序。應指定的值應在 0 到 100 之間。

backgrounder.enable_parallel_adsync

版本: 2018.3.6 版本中新增

預設值: false

控制在有多個背景程式時是否允許並行處理外部目錄群組同步作業。預設情況下,是由單一背景程式串列處理外部目錄群組排程同步作業。將此設定為 true 在多個背景程式執行個體上啟用並行處理。

backgrounder.externalquerycachewarmup.enabled

版本: 在版本 2023.1 中已棄用。要縮短 Tableau Server 工作簿的檢視載入時間,請改為在站台上允許 檢視加速

預設值: false

在排程的擷取重新整理任務之後控制工作簿查詢結果緩存。

backgrounder.externalquerycachewarmup.view_threshold

版本: 在版本 2023.1 中已棄用。要縮短 Tableau Server 工作簿的檢視載入時間,請改為在站台上允許 檢視加速

預設值: 2.0

用於在排程擷取重新整理任務之後緩存工作簿查詢結果的閾值。此閾值等於工作簿在過去七天內收到的檢視數除以未來七天內排程的重新整理次數。

下列兩個 backgrounder 命令選項決定流程工作在取消流程背景工作之前可以執行的時間。這兩個命令共同決定流程工作的總逾時值。

backgrounder.extra_timeout_in_seconds

預設值: 1800

取消幕後工作之前超出 backgrounder.querylimit 中的設定的秒數。此設定可確保停止的工作不會阻止後續工作。此設定適用於 backgrounder.timeout_tasks 中列出的處理序。1800 秒是 30 分鐘。

backgrounder.default_timeout.run_flow

預設值: 14400

取消流程執行任務前的秒數。14,400 秒是 4 小時。

backgrounder.failure_threshold_for_run_prevention

預設值: 5

訂閱或擷取作業掛起前連續失敗的次數。暫停連線失敗的作業有助於為其他作業保留背景程式資源。若要停用掛起失敗的幕後工作,請將其設定為 -1

backgrounder.flow_failure_threshold_for_run_prevention

預設值: 5

流程執行作業在暫停前連續失敗的次數。暫停連線失敗的作業有助於為其他作業保留背景程式資源。若要停用掛起失敗的幕後工作,請將其設定為 -1

backgrounder.log.level

版本: 在版本 2020.3.0 中新增。

預設值: info

背景程式流程的記錄層級。這是可動態設定的,因此,如果您只是加以變更,不必重新啟動 Tableau Server。有關詳情,請參閱 變更記錄層級

backgrounder.querylimit

預設值: 7200

完成一次擷取重新整理工作允許的最長時間,以秒為單位。7200 秒 = 2小時。

附註: 如果幕後工作達到此時間限制,則在被取消的同時,它可以繼續額外執行幾分鐘。

backgrounder.restrict_serial_collections_to_site_level

預設值: false

在 Tableau Server 中,可以將擷取重新整理、訂閱或流程排程為定期執行。這些排程項目稱為「工作」。背景程式處理序會在排定的時間啟動這些工作的唯一執行個體以執行它們。因此,所啟動工作的唯一執行個體稱為「作業」。

此設定會影響設定為串列執行的排程。預設情況下,當排程設定為串列執行時,使用該排程的所有工作都將串列執行。當此設定設為 true ,在不同站台上執行的工作可以並行執行。同一站台上排程任務的工作將繼續串列執行。

下面的範例說明了這種情況:

Tableau Server 包含一個名為「每日」的排程,用於每天早上七點執行工作。「每日」排程設定為串列執行。站台「人資」和站台「工資單」各有多個使用排程「每日」的排程任務。當此設定設為 true ,站台「人資」上這些排程任務的工作可以與站台「工資單」上的工作並列執行,而同一站台上的工作依然只能串列執行。

backgrounder.notifications_enabled

預設值: true

控制是否為伺服器上的所有網站啟用擷取重新整理和流程執行警示。預設情況下啟用了通知。若要為伺服器上的所有網站禁用警示,請將此項設定為 false

網站管理員可以在網站設定中按網站或在使用者設定中的使用者層級啟用或禁用擷取通知。

backgrounder.sort_jobs_by_type_schedule_boundary_heuristics_milliSeconds

預設值: 60000

控制時間視窗,此時間視窗標識被確定為具有相同排程開始時間的幕後程式作業。

幕後程式處理序會對按作業類型排程在同一時間執行的工作進行排序,首先執行最快類別的作業:訂閱,然後是增量擷取,最後是完整擷取。

系統會對作業進行批次處理以確定「同時」安排的作業。值 60,000 毫秒(預設值)表示在 1 分鐘時間視窗內啟動的排程作業應歸類為同一批,因此應在該批內按類型進行排序。

backgrounder.subscription_failure_threshold_for_run_prevention

預設值: 5

決定在警示條件擱置前必須發生的連續訂閱失敗次數。設定為預設值 5 時,會在 5 次連續訂閱失敗後擱置警示。值 -1 將允許通知電子郵件無限期繼續。此閾值為全伺服器設定,因此適用於伺服器上定義的所有訂閱。

backgrounder.subscription_image_caching

預設值: true

控制幕後程式是否緩存為訂閱產生的影像。不必每次重新產生緩存的影像,因此緩存可提高訂閱性能。預設情況下已啟用影像緩存。若要為伺服器上的所有網站禁用影像緩存,請將此項設定為 false

backgrounder.timeout_tasks

預設值:預設值可能會有所不同,具體取決於您的 Tableau Server 版本。要查看 Tableau 版本預設值列表,請執行 tsm configuration get 命令:

tsm configuration get -k backgrounder.timeout_tasks

執行時間比 backgrounder.querylimit backgrounder.extra_timeout_in_seconds 中的組合值長時可取消的任務的清單。此任務清單用逗號分隔。預設清單表示此設定的所有可能的值。

backup.zstd.thread_count

版本: 在版本 2021.1.0 中新增。此金鑰可動態設定。有關詳情,請參閱 Tableau Server 動態拓撲變更

預設值: 2

建立備份時應使用的執行緒數。

增加此數字可以提高備份效能,但建議執行緒數不超過 Tableau Server 電腦上的邏輯處理器數字(最多四個)。

Backuprestore.use_custom_staging_dir.enabled

版本: 在版本 2026.2.0 中新增。

預設值: false

確定備份 流程是否應使用自訂暫存目錄來組合備份檔案 ( .tsbak )。

將備份檔案儲存到 basefilepath.backuprestore 變數指定的位置 之前, tsm maintenance backup 命令會使用資料目錄中的臨時暫存位置進行檔案動作(組合、擷取)。從版本 2026.2.0 開始,若將 TSM 設定為使用 basefilepath.backuprestore 指定的位置並啟用此設定,則備份會在 basefilepath.backuprestore 指定位置下的臨時子目錄中進行組合。對於 2026.2.0 之前的版本,變更 basefilepath 不會影響 tsm maintenance backup 命令組合備份檔案的位置。

若要將其設定為 true (以使用自訂暫存目錄),請執行以下命令:

tsm configuration set -k backuprestore.use_custom_staging_dir.enabled -v true
tsm pending-changes apply

自訂暫存目錄透過設定 basefilepath.backuprestore 進行設定。

有關詳情,請參閱 tsm File Paths

basefilepath.backuprestore

預設值: C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\

tsm maintenance backup 命令建立備份的位置。這也是使用 tsm maintenance restore 命令 還原時備份檔案必須所在的位置。設定後,應該執行 tsm maintenance validate-backup-basefilepath 命令(在 2022.1 及更高版本中可用),驗證是否為該位置正確設定了權限。有關詳情,請參閱 tsm File Paths

basefilepath.log_archive

預設值: C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\log-archives\

tsm maintenance ziplogs 命令建立壓縮封存的位置。有關詳情,請參閱 tsm File Paths

basefilepath.site_export.exports

預設值: C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\siteexports\

tsm sites export 命令建立匯出檔案的位置。有關詳情,請參閱 tsm File Paths

basefilepath.site_import.exports

預設值: C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\siteimports\

tsm sites import 命令希望匯入檔案所在的位置。有關詳情,請參閱 tsm File Paths

clustercontroller.log.level

版本: 在版本 2020.3.0 中新增。

預設值: info

「叢集控制器」的記錄層級。這是可動態設定的,因此,如果您只是加以變更,不必重新啟動 Tableau Server。有關詳情,請參閱 變更記錄層級

clustercontroller.zk_session_timeout_ms

預設值: 300000

叢集控制器在確定需要容錯移轉之前將等待協調服務 (ZooKeeper) 的時間長度(以毫秒為單位)。

dataAlerts.checkIntervalInMinutes

預設值: 60

Tableau Server 進行檢查以判定資料警示條件是否為 True 的頻率,單位:分鐘。

(每當重新整理與資料警示相關的擷取時,伺服器也會進行檢查。)

dataAlerts.retryFailedAlertsAfterCheckInterval

預設值: true

決定 Tableau Server 重新檢查失敗資料警示的頻率。如果設定為 true ,伺服器將按 dataAlerts.checkIntervalInMinutes 定義的頻率重新檢查失敗通知。如果設定為 false ,伺服器將每隔五分鐘重新檢查失敗通知,從而能在資料狀況發生變更時更快地向通知收件人發出通知,但會降低伺服器性能。

(每當重新整理與資料警示相關的擷取時,伺服器也會進行檢查。)

dataAlerts.SuspendFailureThreshold

預設值: 350

判斷在條件擱置而發出警示前必須發生的連續資料警示失敗次數。預設值設為 350 時,警示大約會在為期 2 週的警示後擱置。此閾值為全伺服器設定,因此適用於伺服器上定義的所有資料警示。

dataserver.log.level

版本: 在版本 2020.3.0 中新增。

預設值: info

「資料伺服器」的記錄層級。這是可動態設定的,因此,如果您只是加以變更,不必重新啟動 Tableau Server。有關詳情,請參閱 變更記錄層級

dataserver_<n>.port

執行資料伺服器執行個體(由「<n>」指定)的連接埠。

elasticserver.vmopts

版本: 在版本 2019.1 中新增。已移除:2022.1

此配置選項對 Tableau Server 版本 2022.1 及更高版本無效。 對於 Tableau Server 版本 2022.1 及更高版本,請使用 indexandsearchserver.vmopts 組態選項

預設值:「 -Xmx<default_value> -Xms<default_value>

預設值會因系統記憶體數量而有所不同。JVM 的最大堆積大小已調整為系統總 RAM 的 3.125%。

控制彈性伺服器堆積大小。由於預設值會自動調整,因此僅在絕對必要時使用此選項覆寫預設值。將字母「k」附加到值表示 KB、附加「m」表示 MB,附加「g」表示 GB。一半情況下,將初始堆積大小 ( -Xms ) 設定為等於最大堆積大小 ( -Xmx ) 以最大程度地減小記憶體回收。

excel.shadow_copy_all_remote.enabled

版本: 在 2019.1.5、2019.2.1 版本中增加。

預設值: false

控制 Tableau Server是否會對用來做為即時資料來源的共用 Excel 試算表( .xlxs .xlxm ),建立「陰影複製」。啟用時,這個選項會防止 Excel 使用者看到「共用違規錯誤」,以及檔案「目前正在使用中」的訊息。這個選項對於大型的 Excel 檔案可能會有效能上的影響。如果 Excel 使用者不需要編輯共用檔案,則不需要啟用這個選項。

附註: Tableau Server 一律會嘗試建立 .xls 檔案的陰影複製。此選項不會變更該行為。

extractservice.command.execution.timeout

版本: 在版本 2021.4 中新增。

預設值: 7200

設定 VConn 資料擷取重新整理執行時間的逾時值。

範例: tsm configuration set -k extractservice.command.execution.timeout -v <timeout_in_seconds> --force-keys

請注意: 您必須使用 --force-keys 選項變更此值。

功能。ActiveMQ

版本: 在版本 2021.4 中新增。

預設值: true

控制 Tableau Server 是否使用 Apache ActiveMQ 服務(Tableau Server 傳訊服務)作為內部傳訊機制。

features.DesktopReporting

預設值: false

控制是否在伺服器上啟用桌面授權報告。設定為 false (預設值)時,則沒有與桌面授權相關的管理檢視可用。將此選項設定為 true 可啟用授權報告,並讓授權使用情況及過期管理檢視在「伺服器狀態」頁面上可見。 附註: 必須在用戶端 (Tableau Desktop) 上啟用桌面授權報告,才能將資訊報告給 Tableau Server。

features.IdentityMigrationBackgroundJob

版本: 在版本 2022.1 中新增。

預設值: false 。從版本 2021.4.22、2022.1.18、2022.3.10、2023.1.6 和 2023.3 開始,預設值已變更為 false

控制執行身分移轉的處理序。設定為 true 後,將 Tableau Server 升級至版本 2022.1(或更高版本)並還原 Tableau Server 版本 2021.4(或更早版本)的備份後,立即在現有部署中執行身分移轉。設定為 false (預設)停用身分移轉。

例如,要開始身分移轉,請執行以下命令:

tsm configuration set -k features.IdentityMigrationBackgroundJob -v true

有關詳情,請參閱 關於身份識別遷移

附註: 如果停用身分移轉,Tableau Server 將無法使用身分服務儲存與管理使用者身分資訊。使用身分服務是某些功能的先決條件,例如 身分集區

功能。MessageBusEnabled

版本: 在版本 2019.4 中新增。

預設值: true

控制 Tableau Server 是否使用新的內部傳訊機制。

features.PasswordReset

版本: 在版本 2024.2 中已淘汰。對於版本 2024.2 及更高版本,請使用 vizportal.password_reset

預設值: false

僅適用於使用本地驗證的伺服器。設定為 true 可讓使用者在登入頁面上使用「忘記密碼」選項重設密碼。

features.VizDataServiceClientEnable

版本 :在版本 2024.2 中新增。

預設值: false

啟用對使用者屬性函數的完整支援,如 Tableau 內嵌 API v3 說明中的 使用使用者屬性自訂和控制資料存取 (連結在新視窗開啟) 中所述。

設定為 false 時,使用者屬性函數不支援已發佈資料來源。設定為 true 時,使用者屬性函數功能支援內嵌工作流程中的資料來源和已發佈資料來源。例如,執行以下命令: tsm configuration set -k features.VizDataServiceClientEnable -v true

附註: 此標幟不能用於啟用 OIDC 和 SAML 的使用者屬性。對於 OIDC 和 SAML 驗證工作流程中的使用者屬性,請改用 TMS UI。

features.VizqlDataServiceDeployWithTsm

版本: 已在版本 2025.1 中新增。

預設值: true

控制是否啟用 VizQL 資料服務。啟用(預設)後,該服務會公開 VizQL 資料服務 HTTP 端點,供使用者以程式設計方式進行互動。

若不打算使用 VizQL 資料服務進行以程式設計方式存取,則可以停用該功能。這會隱藏 TSM UI 中的服務。為此,必須先將服務的執行個體數設定為零 (0)。

例如:

tsm topology set-process --count 0 --process vizqldataservice --node <nodeName>
tsm configuration set -k features.VizqlDataServiceDeployWithTsm -v false
tsm pending-changes apply

VizQL 資料服務旨在透過 API 存取。無法在 Tableau Server UI 中利用它。有關該服務的詳細資訊,請參閱 Tableau Server VizQL 資料服務

有關 VizQL 資料服務 API 的資訊,請參閱 VizQL 資料服務 API 參考 (連結在新視窗開啟)

features.VizqlDataServicePermission

版本: 已在版本 2025.1 中新增。

預設值: true

啟用對資料來源權限規則「API 存取」的權限檢查。API 存取資料來源權限規則在群組或使用者的權限對話方塊中設定。關閉權限標幟將停用權限檢查,並且所有站台角色(未經授權的角色除外)都可以存取 VizQL 資料服務 API。請參閱 權限

要完全存取 VizQL 資料服務回應,還必須授予使用者資料來源檢視和連線權限才能完全存取完整資料來源。

VizQL 資料服務 API 存取的建議設定(有關更多詳細資料,請參閱 權限 ):

  • 保持權限標幟處於啟用狀態,並在 Tableau Server 權限對話方塊中為群組而不是使用者設定 API 存取功能權限規則。

  • 在專案層級管理 API 存取功能權限,而不是對個別資料來源內容設定權限。

  • 確保所有使用者群組的 API 存取功能權限設定為

VizQL 資料服務旨在透過 API 存取。無法在 Tableau Server UI 中利用它。有關該服務的詳細資訊,請參閱 Tableau Server VizQL 資料服務

有關 VizQL 資料服務 API 的資訊,請參閱 VizQL 資料服務 API 參考 (連結在新視窗開啟)

filestore.empty_folders_reaper.enabled

版本 在 2020.x(2020.1.14、2020.2.11、2020.3.6、2020.4.2)和 2021.1.x 中新增。在 2021.2 中,預設值已變更為 true

預設值: true

啟用「收穫」(移除)清空檔案存儲資料夾的工作。

filestore_empty_folders_reap.frequency_s

版本: 在 2020.x(2020.1.14、2020.2.11、2020.3.6、2020.4.2)中新增。

預設值: 86400 (24 小時)

以分鐘為單位,指定執行刪除空檔案存儲資料工作的頻率。

filestore.log.level

版本: 在版本 2020.3.0 中新增。

預設值: info

「檔案存放區」的記錄層級。這是可動態設定的,因此,如果您只是加以變更,不必重新啟動 Tableau Server。有關詳情,請參閱 變更記錄層級

filestore.reapemptyfoldersholdoffms

版本: 在 2020.x(2020.1.14、2020.2.11、2020.3.6、2020.4.2)中新增。這在 2021.1 中尚不可用。

預設值: 300000 (5分鐘)

以毫秒為單位,指定刪除空檔案存儲資料夾之前等待的時間。

floweditor.max_datafile_upload_size_in_kb

版本: 在版本 2020.4 中新增

預設值: 1048576

對於 Tableau Prep 流程 Web 製作,可以上傳到 Tableau Server 的分隔文字檔(例如 CSV 或 TXT)的最大大小。

gateway.http.cachecontrol.updated

預設值: false

快取控制 HTTP 標頭指定用戶端瀏覽器是否應該快取從 Tableau Server 傳送的內容。若要停用用戶端上的 Tableau Server 資料快取,請將此選項設定為 true

gateway.http.hsts_options

預設值: "max-age=31536000"

預設情況下,會為一年(31536000 秒)期間設定 HSTS 原則。此時間段指定瀏覽器將透過 HTTPS 存取伺服器的時間量。

gateway.http.request_size_limit

預設值: 16380

允許根據 HTTP 請求透過 Apache 閘道傳遞的標頭內容的大小上限(位元組)。標頭超過此選項上設定的值將導致瀏覽器錯誤,如 HTTP 錯誤 413(請求實體太大)或驗證失敗。

gateway.http.request_size_limit 的值較低可能會導致驗證錯誤。與 Active Directory(SAML 和 Kerberos)整合的單一登入解決方案在 HTTP 標頭中經常需要大型驗證權杖。一定要在部署到生產環境之前測試 HTTP 驗證方案。

我們建議將 tomcat.http.maxrequestsize 選項設定為您為此選項設定的相同值。

gateway.http.x_content_type_nosniff

預設值: true

X-Content-Type-Options 回應 HTTP 頭指定 Content-Type 頭中的 MIME 類型不應由瀏覽器變更。在某些情況下,如果未指定 MIME 類型,則瀏覽器可能會透過評估有效負載的特徵來嘗試確定 MIME 類型。然後瀏覽器將相應地顯示內容。這個過程被稱為「嗅探」。誤解 MIME 類型可能會導致安全性漏洞。預設情況下,系統使用此選項將 X-Content-Type-Options HTTP 頭設定為「nosniff」。

gateway.http.x_xss_protection

預設值: true

HTTP X-XSS-Protection 回應頭會傳送到瀏覽器以啟用跨網站指令碼 (XSS) 保護。在使用者在瀏覽器中停用XSS 保護的情況下,X-XSS-Protection 回應頭會覆蓋設定。預設情況下,系統使用此選項啟用了 X-XSS-Protection 回應頭。

gateway.log.level

版本: 在版本 2020.3.0 中新增。

預設值: info

閘道的記錄層級。這是可動態設定的,因此,如果您只是加以變更,不必重新啟動 Tableau Server。有關詳情,請參閱 變更記錄層級

gateway.public.host

預設值:<hostname>

伺服器的名稱 (URL),用於對 Tableau Server 進行外部存取。如果將 Tableau Server 設定為使用 Proxy 伺服器或外部負載平衡器,則它是在瀏覽器位址欄中輸入的用於存取 Tableau Server 的名稱。例如,如果透過輸入 tableau.example.com 來存取 Tableau Server,則 gateway.public.host 的名稱是 tableau.example.com

gateway.public.port

預設值: 80 (如果採用 SSL,則為 443

僅適用於 Proxy 伺服器環境。 Proxy 伺服器所偵聽的外部埠。

gateway.slow_post_protection.enabled

預設值: true

啟用後,可以使極慢速率傳輸資料的 POST 請求逾時來防止慢速 POST(拒絕服務)攻擊。

附註: 此選項無法消除此類攻擊的威脅,並且可能會有終止慢速連線的意外影響。

gateway.slow_post_protection.request_read_timeout

預設值: header=10-30,MinRate=500 body=30,MinRate=500

透過前面的選項 gateway.slow_post_protection.enabled 啟用後,此選項會設定 Apache httpd ReadRequestTimeout。httpd 指示詞會記錄在 Apache 模組 mod_reqtimeout (連結在新視窗開啟) 。此選項的主要用途做為防禦 Slowloris 攻擊。請參閱 Wikipedia 條目 Slowloris (computer security) (連結在新視窗開啟)

附註: 舊版本使用預設值: header=15-20,MinRate=500 body=10,MinRate=500

gateway.timeout

預設值: 7200

閘道在請求失敗前等待某些事件的最長時間,以秒為單位(7200 秒= 2 小時)。

gateway.trusted

預設值:Proxy 伺服器機器的 IP 位址

僅適用於 Proxy 伺服器環境。 Proxy 伺服器的 IP 位址或主機名稱。

gateway.trusted_hosts

預設值: Proxy 伺服器的備用名稱

僅適用於 Proxy 伺服器環境。 Proxy 伺服器的任何備用主機名稱。

hyper.file_partition_size_limit

預設值: 0

設為 0 時,大小會設為不限制並將使用所有可用的磁碟空間。

此選項用於設定多工緩衝處理至磁碟之查詢的磁碟空間限制。如果 spool.<id>.tmp 檔案的磁碟空間使用量大於環境所需使用量,則意味著查詢正在進行多工緩衝處理並佔用磁碟空間。使用此選項可限制任一查詢可使用的磁碟空間量。spool.<id>.tmp 檔案可在執行 Tableau Server 的使用者帳戶的 temp 資料夾中找到。您可以以 K(KB)、M(MB)、G(GB) 或 T(TB) 為單位指定此值。例如,當您要將磁碟空間使用量限制為 100 GB 時,可將大小限制指定為 100G。

有關多工緩衝處理的詳情,請參閱 Tableau Server 資料引擎 中的〈記憶體與 CPU 使用量〉一節。

hyper.global_file_partition_size_limit

預設值: 0

設為 0 時,大小會設為不限制並將使用所有可用的磁碟空間。

此選項用於設定多工緩衝處理至磁碟之所有查詢的磁碟空間限制。如果 spool.<id>.tmp 檔案的磁碟空間使用量大於環境所需使用量,則意味著查詢正在進行多工緩衝處理並佔用磁碟空間。spool.<id>.tmp 檔案可在執行 Tableau Server 的使用者帳戶的 temp 資料夾中找到。使用此選項可限制多工緩衝處理至磁碟時所使用的所有查詢總量。您可以以 K(KB)、M(MB)、G(GB) 或 T(TB) 為單位指定此值。例如,當您要將磁碟空間使用量限制為 100 GB 時,可將大小限制指定為 100G。Tableau 建議您在微調多工緩衝處理限制時啟動此設定。

有關多工緩衝處理的詳情,請參閱 Tableau Server 資料引擎 中的〈記憶體與 CPU 使用量〉一節。

hyper.enable_accesspaths_symbolic_canonicalization

預設值: false

在 Windows 作業系統中,為了解析符號連結,Hyper 需要能夠存取存儲擷取的目錄及其所有上層目錄。如果不是這種情況,則可能會在 Hyper 記錄中看到一條錯誤消息,內容為: Unable to get canonical path for //dirA/subdir/myextract.hyper ... Access is denied .

在這種情況下,可以將其設定為 true ,以便 Data Engine(Hyper)在使用規範路徑時不會嘗試解析符號連結。

附註 將該值設定為 true 還意味著 Hyper 不再保證可以防止潛在的攻擊者,他們會設法放置符號連結以逸出 Hyper 設定為可以存取的允許目錄集。

hyper.log_queries

預設值: true

設定為 true 時,會記錄查詢資訊。

預設情況下會記錄查詢資訊。但如果您發現記錄檔對於磁碟空間可用容量而言太大,可以將其設定為 false 以停用記錄查詢資訊。Tableau 建議將此組態集保留為 true

hyper.log_query_cpu

預設值: false

使用此設定可記錄每個查詢所需的時間及 CPU 使用量。

hyper.log_timing

預設值: false

此設定有助於深入了解查詢的詳細資訊,例如編譯和剖析時間。預設情況下,此設定為停用狀態。您可以透過將該值設定為 true 開啟此選項以收集更多有關查詢的詳細資料。但這樣會增加資料引擎記錄檔 (\logs\hyper) 的大小。

hyper.log_troublesome_query_plans

預設值: true

設為 true 時,會記錄標識為有問題的查詢之查詢計劃。已取消、執行速度慢於 10 秒的查詢或如果查詢多工緩衝處理至磁碟的查詢屬於此類別。記錄檔中的資訊可能有助於疑難排解問題查詢。如果您擔心記錄檔大小,可將該設定變更為 false

hyper.memory_limit

預設值: 80%

控制 Hyper 使用的最大可用系統記憶體量。將記憶體限制指定為總可用系統記憶體的百分比。例如, hyper.memory_limit="90%"

或者,指定要使用的最大可用記憶體量(以位元組為單位)。將字母「k」附加到值表示 KB、附加「m」表示 MB、附加「g」表示 GB、附加「t」則表示 TB。例如, hyper.memory_limit="7g"

附註: 在 Tableau Server 下執行時,該值會套用至伺服器資源管理員 (SRM) 管理的記憶體上限,而不是總實體 RAM。SRM 上限約為實體 RAM 的 84%。因此,預設值 80% 會導致大約 67% 的總實體 RAM 可供 Hyper 使用。

hyper.memtracker_hard_reclaim_threshold

預設值: 80%

此設定僅適用於 Windows。Hyper 會將擷取中解壓縮和解密的部分保留在記憶體中,以便更快速進行後續存取。此設定會控制工作執行緒何時開始將此資料寫入磁片快取,以減少記憶體壓力。如果以百分比提供,該值將解讀為整體 hyper.memory_limit 設定的百分比。例如, hyper.memtracker_hard_reclaim_threshold="60%" 。您可以將絕對值指定為「k」(KB)、「m」(MB)、「g」(GB) 或「t」(TB)。例如, hyper.memtracker_hard_reclaim_threshold="10g" 。該值應大於 hyper.memtracker_soft_reclaim 閾值。

hyper.memtracker_soft_reclaim_threshold

預設值: 50%

此設定僅適用於 Windows。與 Hyper 檔案互動時,Hyper 會寫出一些資料,以便快取或保存資料。Windows 具有將新寫入之資料鎖定到記憶體中的特殊行為。為了避免交換,我們會在 Hyper 達到為回收閾值設定的限額時強制剔除資料。達到柔性回收閾值時,Hyper 會嘗試在背景回收快取的資料,以嘗試維持在回收閾值之下。在其他會發生交換的情況下,在 Hyper 中觸發回收可能會產生更好的結果。因此,如果您的 Tableau Server 安裝發生大量交換,就可以使用此設定來嘗試減少記憶體壓力。

指定位元組數量。將字母「k」附加到值表示 KB、附加「m」表示 MB、附加「g」表示 GB、附加「t」則表示 TB。或者,也可將該值指定為針對 Hyper 整體設定之記憶體的百分比。例如, hyper.memtracker_soft_reclaim_threshold="20%"

hyper.network_threads

預設值: 150%

控制 Hyper 使用的網路執行緒數量。指定網路執行緒數量(例如 hyper.network_threads=4 )或指定與邏輯核心計數相關的執行緒百分比(例如 hyper.network_threads="300%" )。

網路執行緒是用來接受新的連線,以及傳送或接收資料與查詢。Hyper 會使用非同步網路,因此可由單一執行緒提供多個連線。一般來說,在網路執行緒上完成的工作量非常低。有一個例外是在較慢的檔案系統上開啟資料庫;這可能會需要很長時間,而且會阻擋網路執行緒。您嘗試檢視或編輯使用擷取且有一段時間未使用的儀表板時,如果連線時間很慢,而且您在 Hyper 記錄中經常看到「asio-continuation-slow」訊息,且 Tableau 記錄中對 Hyper 的「construct-protocol」時間很長,請嘗試增加此值。

hyper.objectstore_validate_checksums

預設值: false

在 Hyper 中控制檔案完整性檢查的布林值設定。設定為 true 時,Hyper 會在首次存取時在擷取檔案中檢查資料。此設定可以偵測到無訊息損毀以及可能會讓 Hyper 當機的損毀。通常會建議開啟此設定,但磁碟速度很慢的安裝作業除外,因為這樣可能會導致效能退化。

hyper.query_total_time_limit

預設值: 0 (表示無限制)

設定可讓 Hyper 中個別查詢使用的總執行緒時間上限。將「s」附加到值表示秒,「min」表示分鐘,「h」則表示小時。

例如,若要將所有查詢的總時間限制為 1,500 秒,請執行以下命令:

tsm configuration set -k hyper.query_total_time_limit -v 1500s

如果查詢執行時間超過指定限制,則查詢將失敗並傳回錯誤。此設定可讓您自動控制失控的查詢,否則會使用過多的資源。

Hyper 會並行執行查詢。例如,如果查詢執行了 100 秒鐘,而且此期間是在 30 個執行緒上執行,則總執行緒時間會是 3,000 秒。每個查詢的執行緒時間會報告在 Hyper 記錄中「total-time」欄位的「query-end」記錄項目中。

hyper.session_memory_limit

預設值: 0 (表示無限制)

控制個別查詢可以擁有的記憶體消耗量上限。指定位元組數量。將字母「k」附加到值表示 KB、附加「m」表示 MB、附加「g」表示 GB、附加「t」則表示 TB。

例如,將內存限制上限設定為 900 MB,請執行以下命令:

tsm configuration set -k hyper.session_memory_limit -v 900m

或者,將工作階段記憶體上限指定為總可用系統記憶體的百分比,請執行以下命令:

tsm configuration set -k hyper.session_memory_limit -v 90%

某個查詢使用過多的記憶體且使其他查詢長時間失敗時,降低此值能夠有所幫助。透過降低限額,單一大型查詢可能會失敗(如果多工緩衝處理並未關閉,則會採用多工緩衝處理),而且對其他查詢不會有負面影響。

hyper.srm_cpu_limit_percentage

預設值(百分比): 75

指定 Hyper 允許的最大每小時平均 CPU 使用率。若超出,資料引擎將自行重新啟動,以盡量減少對電腦上其他流程的影響。

預設情況下,若在一小時內的平均 CPU 使用率超過 75%,資料引擎將自行重新啟動。除非與 Tableau 支援合作,或者若在專用伺服器節點上執行資料引擎,否則不應變更此值。若資料引擎在專用節點上執行,可以安全地將此值增加到 95%,以充分利用可用的電腦硬體。有關在專用節點上執行資料引擎的詳細資訊,請參閱 對擷取查詢密集型環境進行最佳化

要將其增加到 95%:

tsm configuration set -k hyper.srm_cpu_limit_percentage -v 95 --force-keys

tsm pending-changes apply

要將其重設為預設值 75%:

tsm configuration set -k hyper.srm_cpu_limit_percentage -v 75 --force-keys

tsm pending-changes apply

hyper_standalone.consistent_hashing.enabled

預設值: true

提高已快取查詢的擷取機會。如果已快取擷取的節點無法支援額外負載,會將您路由至新節點,而且擷取將載入新節點上的快取。這會提升系統使用率,因為只有在真正需要負載時,才會將擷取載入記憶體。

hyper_standalone.health.enabled

預設值: true

將負載平衡指標從隨機選擇切換至根據目前 Hyper 活動和系統資源使用情況組成的健康情況分數選擇「資料引擎 (Hyper)」節點。根據這些值,負載平衡器將選擇最能處理擷取查詢的節點。

hyper.temp_disk_space_limit

預設值: 100%

設定磁碟空間上限;Hyper 會在此上限停止為暫存檔案分配空間。此設定有助於防止硬碟填滿來自 Hyper 的暫存檔案且用盡磁碟空間的情形。如果磁碟空間達到此閾值,Hyper 會嘗試在沒有管理員介入的情況下自動復原。

請將其指定為要使用之整體可用磁碟空間的百分比。例如, hyper.temp_disk_space_limit="96%" 。設定為 100% 時,可以使用所有可用的磁碟空間。

若要啟動資料引擎,已設定的磁碟空間必須可用。如果沒有足夠的磁碟空間,您就會看到一個資料引擎記錄項目顯示「已達到暫存檔案的磁碟空間限制。請釋出裝置上的磁碟空間。請參閱 Hyper 記錄以瞭解詳情:裝置上已無剩餘空間。」

hyper.hard_concurrent_query_thread_limit

預設值:150%

使用此選項可設定 Hyper 應用於執行查詢的執行緒數量上限。您要對 CPU 使用量設定硬性限制時,請使用此選項。請指定執行緒數量或指定與邏輯核心計數相關的執行緒百分比。Hyper 使用的資源不太可能會超過此設定所配置的數量,但 Hyper 背景和網路執行緒不會受到此設定的影響(雖然它們通常不會佔用 CPU 資源)。

請務必考慮到此設定會控制可以執行的並行查詢數量。因此,如果您減少此設定,則查詢需要等待目前執行之查詢完成的機率就會提高,因此會影響工作簿載入時間。

hyper.soft_concurrent_query_thread_limit

預設值:100%

使用此選項可以指定單一查詢可跨執行緒平行執行的執行緒數量(假設 hard_concurrent_query_thread_limit 設定有足夠的執行緒可使用)。請指定執行緒數量或指定與邏輯核心計數相關的執行緒百分比。

為了說明這一點,下面是一個簡化的例子:

假設您將此值設定為 10 個執行緒,這意味著查詢最多可在 10 個執行緒上平行執行。如果只有 2 個查詢正在執行,則其餘 8 個執行緒會用於平行執行 2 個查詢。

hyper. hard_concurrent_query_thread_limit hyper.soft_concurrent_query_thread_limit 選項共同協作,為您提供一些管理 CPU 使用量的選項,可在最大程度增加可用 CPU 資源的同時更快完成查詢。如果您不希望資料引擎使用機器上的所有可用 CPU,請將其變更為最適合您的環境的小於 100% 的百分比。該柔性限制是您限制 CPU 使用量的一種方式,但同時又允許您在必要時超出柔性限制,達到硬性限制。

附註: hyper.hard_concurrent_query_thread_limit hyper.soft_concurrent_query_thread_limit 選項取代 Tableau Server 版本 2018.3 及更早版本的中提供的 hyper.num_job_worker_threads 與 hyper.num_task_worker_thread 選項,並已在目前版本中已淘汰。 有關 hyper.num_job_worker_threads 和hyper.num_task_worker_threads 的詳情,請參閱 tsm configuration set 選項 (連結在新視窗開啟)

hyper.use_spooling_fallback

預設值: true

設定為 true 時,其允許在查詢擷取超出設定 RAM 使用量(已安裝 RAM 的 80%)時多工緩衝處理至磁碟。換句話說,它會允許 Hyper 在超過 RAM 使用量時使用磁碟執行查詢。

Tableau 建議您使用預設設定。如果您擔心磁碟使用量,您可以透過將該值設定為 false 來關閉此設定。如果關閉此設定,將會取消使用超過已安裝 RAM 的 80% 的查詢。多工緩衝處理查詢通常需要相當長的時間才能完成。

有關多工緩衝處理的詳情,請參閱 Tableau Server 資料引擎 中的〈記憶體與 CPU 使用量〉一節。

jmx.security.enabled

版本 在版本 2022.1 中新增。

預設值: false

預設情況下停用 JMX,因此也停用了安全 JMX。如果要啟用 JMX,我們強烈建議啟用安全 JMX。

將其設定為 true ,並在執行 tsm maintenance jmx enable 命令時使用 SSL 和基本使用者名稱/密碼驗證唯讀存取時開啟安全 JMX,並在提示是否為 JMX 啟用安全功能時回答 y

tsm maintenance jmx enable
We do not recommend you enable JMX unsecured on a production environment. Would you like to enable security features for JMX?
(y/n): y

jmx.ssl.enabled

版本 在版本 2022.1 中新增。

預設值: true

為 JMX 強制執行 SSL。此選項預設為 true 但除非 jmx.security.enabled 也設定為 true ,否則沒有效果。要啟用 JMX 安全性,請執行 tsm maintenance jmx enable 命令。系統提示啟用 SSL 時回答 y ,或回答 n 停用 SSL:

tsm maintenance jmx enable
Would you like to enable SSL?
(y/n): n

jmx.ssl.require_client_auth

版本 在版本 2022.1 中新增。

預設值: false

執行 tsm maintenance jmx enable 命令時將其設定為 true ,並在提示要求客戶端身份驗證 (mTLS) 時回答 y

tsm maintenance jmx enable