tsm configuration set 选项

下面是可以使用 tsm configuration set 命令设置的配置选项或键的列表。在许多情况下,您可以使用 tsm configuration get 命令找出配置键的当前值。

此列表并非 Tableau Server 配置设置的详尽列表。它表示可由服务器管理员设置的配置键的子集。最后,Tableau Server 内部使用的某些键不会出现在此列表中。

注意:配置键区分大小写。

tsm configuration keys 的基本用法

设置配置键

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 命令将返回“未知键”响应。有关详细信息,请参见“未知键”响应

配置键

adminviews.disabled

默认值:false

禁用对 Tableau 管理视图的访问权限。默认情况,已启用对视图的访问权限(此选项设置为“false”)。

api.server.enabled

默认值:true

允许访问 Tableau Server REST API(Link opens in a new window)。默认情况下,此功能已启用。

auditing.enabled

默认值:true

允许访问 PostgreSQL(Tableau Server 自己的数据库)历史审计表。

backgrounder.enable_parallel_adsync

注意:版本 2018.3.6 中新增

默认值:false

控制在有多个后台程序时是否允许并行处理外部目录组同步作业。默认情况下,外部目录组计划同步由单个后台程序串行处理。将此项设置为 true 以在多个后台实例上启用并行处理。

backgrounder.externalquerycachewarmup.enabled

默认值:true

在计划的数据提取刷新任务之后控制工作簿查询结果缓存。

backgrounder.externalquerycachewarmup.view_threshold

默认值: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.log.level

注意:版本 2020.3.0 中新增

默认值:info

后台程序进程日志记录级别。此设置是动态配置的,因此,如果您只是更改此设置,则不必重新启动 Tableau Server。有关详细信息,请参见更改日志记录级别

backgrounder.querylimit

默认值:7200

完成一次数据提取刷新任务或订阅任务允许的最长时间,以秒为单位。7200 秒 = 2小时。

注意: 如果后台任务达到此时间限制,则在被取消的同时,它可以继续额外运行几分钟。

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 时,通知会在订阅连续失败五次后挂起。值 -1 将允许通知电子邮件无限期继续。此阈值是服务器范围设置,因此适用于服务器上定义的所有订阅。

backgrounder.subscription_image_caching

默认值:true

控制后台程序是否缓存为订阅生成的图像。不必每次重新生成缓存的图像,因此缓存可提高订阅性能。默认情况下已启用图像缓存。若要为服务器上的所有站点禁用图像缓存,请将此项设置为 false

backgrounder.timeout_tasks

默认值:refresh_extracts,
increment_extracts,
subscription_notify,
single_subscription_notify,
check_data_alert,
run_flow,
encrypt_extracts,
decrypt_extracts,
rekey_extracts,
extract_encryption_maintenance

运行时间比 backgrounder.querylimitbackgrounder.extra_timeout_in_seconds 中的组合值长时可取消的任务的列表。此任务列表用逗号分隔。默认列表表示此设置的所有可能的值。

basefilepath.backuprestore

默认值:C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\

tsm maintenance backup 命令在其中创建备份的位置。这也是使用 tsm maintenance restore 命令或 tsm maintenance send-logs 命令还原时备份文件时必须位于的位置。有关详细信息,请参见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

群集控制器在确定需要故障转移之前将等待协调服务的时间长度(以毫秒为单位)。

dataAlerts.checkIntervalInMinutes

默认值:60

Tableau Server 进行检查以确定数据通知条件是否为真的频率(分钟)。

(每当刷新与数据通知相关的数据提取时,服务器也会进行检查。)

dataAlerts.retryFailedAlertsAfterCheckInterval

默认值:true

确定 Tableau Server 重新检查失败数据通知的频率。如果设置为 true,服务器将按 dataAlerts.checkIntervalInMinutes 定义的频率重新检查失败通知。如果设置为 false,服务器将每隔五分钟重新检查失败通知,从而能在数据状况发生更改时更快地向通知收件人发出通知,但会降低服务器性能。

(每当刷新与数据通知相关的数据提取时,服务器也会进行检查。)

dataAlerts.SuspendFailureThreshold

Default value: 350

确定在某个条件的通知挂起之前必须发生的数据通知连续失败次数。设置为默认值 350 时,通知操作显示大约两周的通知后挂起。此阈值是服务器范围设置,因此适用于服务器上定义的任何数据通知。

dataserver.log.level

注意:版本 2020.3.0 中新增

默认值:info

数据服务器的日志记录级别。此设置是动态配置的,因此,如果您只是更改此设置,则不必重新启动 Tableau Server。有关详细信息,请参见更改日志记录级别

dataengine.port

默认值:27042

数据引擎在其中运行的端口。

dataserver.port

默认值:9700

数据服务器在其中运行的端口。

DataServerRefreshMetadataPerSession

默认值:false

当基础架构结构发生更改时,确定 Tableau Server 是否将进行附加查询来获取已发布数据源的更新架构数据。出于性能原因,此参数默认情况下已禁用,并且在显示架构更改时存在延迟。如果希望快速反映出实时已发布数据源中的架构更改,或者看到错误(例如,“与数据源通信时出错:无效的列名。无法准备语句。”),请将此参数设置为 true。设置为 true 时,Tableau Server 将进行附加查询来更新架构。

elasticserver.vmopts

默认值因系统内存量而异。使用下表确定默认值:

系统内存 默认值
29 GB 或更少 -Xmx256m -Xms256m (256 MB)
30 GB 至 45 GB -Xmx1g -Xms1g (1 GB)
46 GB 至 58 GB -Xmx2g -Xms2g (2 GB)
59 GB 至 100 GB -Xmx4g -Xms4g (4 GB)
大于 100 GB -Xmx8g -Xms8g (8 GB)

控制弹性服务器堆大小。使堆大小增加到超出默认值可能会提高“数据问答”(Ask Data) 功能的性能。堆大小通常应小于整个计算机内存的一半。将字母“k”附加到值以指明千字节,附加“m”以指明兆字节,附加“g”以指明千兆字节。一般情况下,将初始堆大小 (-Xms) 设置为等于最大堆大小 (-Xmx),以最大限度地减少垃圾回收。

以下是根据数据源数量和可用内容分配多少内存的建议。实际性能将因服务器、数据源中的字段数以及其他因素而异。

  • 1 到 100 个数据源:256 MB(最小值)
  • 100 到 500 个数据源:1 GB(推荐值)
  • 500 到 1,000 个数据源:2 GB
  • 1,000 到 2,000 个数据源:4 GB
  • 2,000 到 4,000 个数据源:8 GB
  • 4,000 到 8,000 个数据源:16 GB
  • 8,000 或更多数据源:32 GB

此选项是从 Tableau Server 版本 2019.1 开始添加的。

excel.shadow_copy_all_remote.enabled

默认值:false

控制 Tableau Server 是否创建用作实时数据源的共享 Excel 电子表格spreadsheet(.xlxs.xlxm)的“卷影副本”。如果启用,此选项将防止 Excel 用户查看“共享验证错误”和指明文件“当前已正使用”的消息。对于大型 Excel 文件,此选项可能会对性能产生影响。如果 Excel 用户不需要编辑共享文件,则无需启用此选项。

注意:Tableau Server 会始终尝试创建 .xls 文件的卷影副本。此选项不会更改该行为。

此选项是从以下 Tableau Server 版本开始添加的:2019.1.5、2019.2.1。

features.ActiveMQ

默认值:true

控制 Tableau Server 是否使用 Apache ActiveMQ 服务(Tableau Server 消息服务)作为内部消息机制。

此选项是从以下 Tableau Server 版本开始添加的:2019.4。

features.DesktopReporting

默认值:false

控制是否在服务器上启用桌面许可证报告。设置为 false(默认值)时,与桌面许可证相关的管理视图不可用。将此选项设置为 true 以启用许可证报告,并使许可证使用量及过期管理视图在“服务器状态”页上可见。

features.MessageBusEnabled

默认值:true

控制 Tableau Server 是否使用新的内部消息机制。

此选项是从以下 Tableau Server 版本开始添加的:2019.4。

features.PasswordlessBootstrapInit

默认值:true

控制 Tableau Server 是否允许引导文件中的嵌入式凭据。如果启用(默认值),引导文件中将包括嵌入式凭据,除非您指定不应包括它们。如果决不应在生成的任何引导程序文件中包括凭据,请将此选项设置为 false。有关生成引导程序文件的详细信息,请参见tsm topology nodes get-bootstrap-file

此选项是从以下 Tableau Server 版本 2019.3 开始添加的。

features.PasswordReset

默认值:false

仅适用于使用本地身份验证的服务器。设置为 true 可让用户在登录页面上使用“忘记密码”选项重置密码。

filestore.log.level

注意:版本 2020.3.0 中新增

默认值:info

文件存储的日志记录级别。此设置是动态配置的,因此,如果您只是更改此设置,则不必重新启动 Tableau Server。有关详细信息,请参见更改日志记录级别

gateway.http.cachecontrol.updated

默认值:false

Cache-Control HTTP 标头指定客户端浏览器是否应缓存从 Tableau Server 发送的内容。若要在客户端上禁用 Tableau Server 数据缓存,请将此项设置为 true

gateway.http.hsts

默认值:false

HTTP 严格传输安全性 (HSTS) 头强制浏览器在启用它的域上使用 HTTPS。

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 配置为使用代理服务器或外部负载平衡器,则它是在浏览器地址栏中输入的用于访问 Tableau Server 的名称。例如,如果通过输入 tableau.example.com 来访问 Tableau Server,则 gateway.public.host 的名称是 tableau.example.com

gateway.public.port

默认值:80 (如果采用 SSL,则为 443

仅适用于代理服务器环境。代理服务器所侦听的外部端口。

gateway.slow_post_protection.enabled

默认值:false

通过启用此选项,将可使以极慢速率传输数据的 POST 请求超时,从而以防御慢速 POST(拒绝服务)攻击上提供一些帮助。

注意: 此选项无法消除此类攻击的威胁,并且可能会有终止慢速连接的意外影响。

gateway.slow_post_protection.request_read_timeout

默认值:header=15-20,MinRate=500 body=10,MinRate=500

当由前面的选项 gateway.slow_post_protection.enabled 启用时,此选项将设置 Apache httpd ReadRequestTimeout。关于 httpd 指令的相关信息可在 Apache Module mod_reqtimeout(Link opens in a new window) 中找到。此选项的主要用途是防御 Slowloris 攻击。请参阅维基百科条目 Slowloris(计算机安全)(Link opens in a new window)

gateway.timeout

默认值:1800

网关在请求失败前等待特定事件的最长时间,以秒为单位(1800 秒 = 30 分钟)。

gateway.trusted

默认值:代理服务器计算机的 IP 地址

仅适用于代理服务器环境。代理服务器的 IP 地址或主机名。

gateway.trusted_hosts

默认值:代理服务器的备用名称

仅适用于代理服务器环境。代理服务器的任何备用主机名。

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.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 使用的最大内存量。指定字节数。将字母“k”附加到值以指明千字节,附加“m”以指明兆字节,附加“g”以指明千兆字节,附加“t”以指明太字节。例如,hyper.memory_limit='7g'。或者,将内存限制指定为可用系统总内存的百分比。例如,hyper.memory_limit='90%'

hyper.memtracker_hard_reclaim_threshold

默认值:80%

此设置仅适用于 Windows。Hyper 将数据提取的已解压缩和解密部分保存在内存中,以便更快地进行后续访问。此设置控制工作线程何时开始将此数据写入磁盘缓存以降低内存压力。如果以百分比形式给出,则该值将解读为整个 hyper.memory_limit 设置的百分比。例如,hyper.memtracker_hard_reclaim_threshold='60%'。绝对值可以指定为“k”(千字节)、“m”(兆字节)、“g”(千兆字节)或“t”(太字节)。例如,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”附加到值以指明千字节,附加“m”以指明兆字节,附加“g”以指明千兆字节,附加“t”以指明太字节。或者,将该值指定为 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 日志中看到很长的“construct-protocol”到 Hyper 时间,请尝试增加此值。

hyper.objectstore_validate_checksums

默认值:false

在 Hyper 中控制文件完整性检查的布尔设置。设置为 true 时,Hyper 将在首次访问数据提取文件中检查数据。这样将可检测到无提示损坏和将导致 Hyper 崩溃的损坏。通常,建议打开此设置,但对于极慢磁盘速度的安装除外,因为这些安装可能会导致性能退化。

hyper.query_total_time_limit

默认值:0(表示无限制)

设置总线程时间上限,Hyper 中的单个查询可以使用该上限。将“s”附加到值以指明秒,附加“min”以指明分钟,或附加“h”以指明小时。例如,若要将所有查询限制为总线程时间的总时间用量 1500 秒:hyper.query_total_time_limit='1500s'

此设置允许您自动控制失控的查询,后者会使用过多的资源。Hyper 会并行执行查询。举例来说,如果查询执行 100 秒,并且在此期间在 30 个线程上运行,则总线程时间将为 3000 秒。Hyper 日志的“query-end”日志条目中的“total-time”字段中报告了每个查询的线程时间。

hyper.session_memory_limit

默认值:0(表示无限制)

控制单个查询可以具有的最大内存消耗。指定字节数。将字母“k”附加到值以指明千字节,附加“m”以指明兆字节,附加“g”以指明千兆字节,附加“t”以指明太字节。例如,hyper.session_memory_limit='900m'。或者,将会话内存限制指定为可用系统总内存的百分比。例如,hyper.session_memory_limit='90%'

当查询使用过多的内存并使其他查询长时间失败时,降低此值可能会有所帮助。通过降低限制,单个大型查询将失败(或采用假脱机,如果假脱机未关闭),并且对其他查询没有负面影响。

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% 时,可以使用所有可用的磁盘空间。

若要启动数据引擎,必须提供配置的磁盘空间量。如果没有足够的磁盘空间,您将看到一个指明“Disk limit for temporary files has been reached”(已达到临时文件的磁盘限制)的数据引擎日志条目。请在设备上释放磁盘空间。有关“No space left on device”(设备上没有剩余空间)的详细信息,请参见 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_limithyper.soft_concurrent_query_thread_limit 选项协同工作,为您提供了一些用于管理 CPU 使用率的选项,同时最大限度地提高可用 CPU 资源以便更快完成查询。如果您不希望数据引擎使用计算机上的所有可用 CPU,请将其更改最适合于您的环境的百分比(小于 100%)。软限制是一种限制 CPU 使用率的方法,但在必要时允许 CPU 使用率超过软限制(上限为硬限制)。

注意: hyper.hard_concurrent_query_thread_limithyper.soft_concurrent_query_thread_limit 选项替代了 Tableau Server 2018.3 及更低版本中提供的 hyper.num_job_worker_threads 和 hyper.num_task_worker_threads 选项,后者在当前版本中已弃用。有关 hyper.num_job_worker_threads 和 hyper.num_task_worker_threads 的信息,请参见 tsm configuration set 选项。(Link opens in a new window)

hyper.use_spooling_fallback

默认值:true

设置为 true 时,它允许在查询数据操作使用的 RAM 超过设定的使用量(已安装 RAM 的 80%)时假脱机到磁盘。换句话说,它允许 Hyper 在超过 RAM 使用量时使用磁盘执行查询。

Tableau 建议您使用默认设置。如果担心磁盘使用量,您可以通过将值设置为 false 来禁用此项。如果禁用此设置,使用了超过 80% 已安装 RAM 的查询将被取消。假脱机查询通常需要相当长的时间才能完成。

有关假脱机的详细信息,请参见Tableau Server 数据引擎中的“内存和 CPU 使用率”部分。

install.firewall.allowedprograms.manage

默认值:true

控制 Tableau Server 是否可添加防火墙规则。设置为 true(默认值)时,Tableau Server 将添加新的防火墙规则以允许其进程通过 Windows 防火墙进行连接。如果要自己管理所有防火墙规则,并且不希望 Tableau Server 添加新规则,请将此项更改为 false

java.heap.size

默认值:128m

Tomcat 堆(存储库和 solr)的大小。除非 Tableau 建议这么做,否则通常无需更改该值。

licensing.login_based_license_management.default_requested_duration_seconds

默认值:0

设置为在提示用户再次激活 Tableau 之前,用户基于登录名的许可证应持续的持续时间 (以秒为单位)。

licensing.login_based_license_management.enabled

默认值:false

设置为 true 以启用 基于登录名的许可证管理。设置为 false 以禁用 基于登录名的许可证管理

注意:为了使用 基于登录名的许可证管理,必须激活为 基于登录名的许可证管理 启用的产品密钥。您可以使用 tsm licenses list 查看已启用 基于登录名的许可证管理 的产品密钥。

licensing.login_based_license_management.max_requested_duration_seconds

默认值:15552000

设置为在提示用户再次激活 Tableau 之前,用户基于登录名的许可证应持续的最长持续时间 (以秒为单位)。最大值为 15552000 秒(180 天)。

maestro.input.allowed_paths

默认值:""

默认情况下将拒绝对任何目录的访问,并且只允许将 tflx 文件中包含的内容发布到 Tableau Server。

允许为流程输入连接使用的网络目录的列表。必须启用 Tableau Prep Conductor 才能在 Tableau Server 上运行流程。有关详细信息,请参见Tableau Prep Conductor

以下规则适用,在配置此设置时必须加以考虑:

  • Tableau Server 应可访问的路径。在服务器启动和流程运行时会验证这些路径。

  • 网络目录路径必须是绝对路径,并且不能包含通配符或其他路径遍历符号。例如,\\myhost\myShare\*\\myhost\myShare* 是无效路径,会导致所有路径被拒绝。将 myShare 下的任何文件夹放入安全列表的正确方法是 \\myhost\myShare or \\myhost\\myShare\

    注意: \\myhost\myShare 配置将不允许 \\myhost\myShare1。为了将这两个文件夹都放入安全列表,请将它们以 \\myhost\myShare; \\myhost\myShare1 的形式放入安全列表。

  • 值可以是 * 以允许任何网络目录,或者是网络目录路径的列表(以“;”分隔)。

  • 即使将值设置为 *,也不允许使用本地目录路径。

重要信息:
此命令将覆盖现有信息,并将其替换为您提供的新信息。如果要向现有列表中添加新位置,您必须提供要添加的所有位置(现有位置和新位置)的列表。使用以下命令可查看输入和输出位置的当前列表:

tsm configuration get -k maestro.input.allowed_paths
tsm configuration get -k maestro.output.allowed_paths

有关为流程输入和输出连接配置允许的目录的详细信息,请参见将输入和输出位置放入安全列表(Link opens in a new window)

maestro.output.allowed_paths

默认值:""

默认情况下将拒绝对任何目录的访问。

允许为流程输出连接使用的网络目录的列表。必须启用 Tableau Prep Conductor 才能在 Tableau Server 上运行流程。有关详细信息,请参见Tableau Prep Conductor

以下规则适用,在配置此设置时必须加以考虑:

  • Tableau Server 应可访问的路径。在服务器启动和流程运行时会验证这些路径。

  • 网络目录路径必须是绝对路径,并且不能包含通配符或其他路径遍历符号。例如,\\myhost\myShare\*\\myhost\myShare* 是无效路径,会导致所有路径被拒绝。将 myShare 下的任何文件夹放入安全列表的正确方法是 \\myhost\myShare or \\myhost\\myShare\

    注意: \\myhost\myShare 配置将不允许 \\myhost\myShare1。为了将这两个文件夹都放入安全列表,请将它们以 \\myhost\myShare; \\myhost\myShare1 的形式放入安全列表。

  • 值可以是 * 以允许任何网络目录,或者是网络目录路径的列表(以“;”分隔)。

  • 即使将值设置为 *,也不允许使用本地目录路径。

  • 注意:如果路径同时位于流程允许的列表和 internal_disasslowed 列表中,则 internal_disallowed 优先。

有关为流程输入和输出连接配置允许的目录的详细信息,请参见将输入和输出位置放入安全列表(Link opens in a new window)

metadata.query.limits.time

默认值:20

这是 Catalog 或元数据 API 查询在发生超时和取消查询之前运行的最长允许时间(以秒为单位)。Tableau 建议使用以下命令逐步将超时限制增加到不超过 60 秒:

tsm configuration set -k metadata.query.limits.time –v PT30S --force-keys

重要信息:仅当看到此处描述的错误超时限制和超过节点限制消息时,才应更改此选项。 增加超时限制可以延长使用更多 CPU 的时间,这可能会影响整个 Tableau Server 的任务性能。增加超时限制还可能导致更高的内存使用率,从而可能导致在查询并行运行时交互式微服务容器出现问题。

metadata.query.limits.count

默认值:2000

这是 Catalog 在超出节点限制和取消查询之前可以返回的对象数(可以松散地映射到查询结果数)。Tableau 建议使用以下命令逐步将超时限制增加到不超过 100000:

tsm configuration set -k metadata.query.limits.count –v 3000 --force-keys

重要信息:仅当看到此处描述的错误超时限制和超过节点限制消息时,才应更改此选项。增加节点限制可能导致更高的内存使用率,从而可能导致在查询并行运行时交互式微服务容器出现问题。

metricsservices.checkIntervalInMinutes

默认值:60

控制依赖于实时数据源的指标刷新之间的间隔(以分钟为单位)。当服务器通过指标的连接视图检查是否有新数据时,指标将刷新。

metricsservices.failureCountToWarnUser

默认值:10

控制在警告指标所有者之前必须发生的连续刷新失败次数。当设置为默认值 10 时,指标刷新必须连续失败 10 次,然后才会向所有者发送有关失败的通知。

metricsservices.maxFailedRefreshAttempts

默认值:175

控制在中止指标刷新之前必须发生的连续刷新失败次数。

mobile.deep_linking.on_prem.enabled

默认值:true

控制 Tableau Mobile 应用软件是否将指向 Tableau Server 的链接视为深度链接。设置为 true 时,指向支持的内容类型的链接将在应用软件中打开。设置为 false 时,链接将在移动浏览器中打开。有关详细信息,请参见控制 Tableau Mobile 的深度链接

monitoring.dataengine.connection_timeout

默认值:30000

群集控制器在确定发生连接超时之前将等待数据引擎的时间长度(以毫秒为单位)。默认值为 30,000 毫秒(30 秒)。

native_api.connection.limit.<连接类>

设置指定数据源(连接类)的并行查询限制。此选项优先于数据源的全局限制。

native_api.connection.globallimit

默认值:16

并行查询的全局限制。除了 Amazon Redshift 的默认值为 8 之外,其他的默认值均为 16。

native_api.force_alternative_federation_engine

默认值:false

联接单个文件连接和单个 SQL 数据库连接中数据时覆盖操作限制。将此选项设置为 True 以强制 Tableau 使用实时数据库连接处理联接。

native_api.ProtocolTransitionLegacyFormat

默认值:false

为约束委派使用旧名称格式。

版本 10.1 中的名称格式已更改,以允许跨域协议转换 (S4U)。如果这导致现有配置出现问题,并且您不需要跨域协议转换,请通过将此参数设置为 true,将 Tableau Server 配置为使用旧行为。

nlp.concepts_shards_count

默认值:1

注意:对于大多数 Tableau Server 安装,默认分片计数值已经足够。

控制存储字段名称、字段同义词和分析词的弹性搜索概念索引的数据分片数。分片计数对搜索索引进行分区,以减少总索引大小,这可能会提高“数据问答”(Ask Data)功能的语义解析器的性能。调整分片计数是您可以随通过 elasticserver.vmopts 增加堆大小而采取的另一种性能增强措施。

Tableau 建议每 50 GB 将分片计数增加 1。若要减少调整分片计数的次数,请通过向当前索引添加 50% 来计算总索引大小。举例来说,如果总索引大小小于 50 GB,则 1 个分片就足够了。实际性能将因服务器、索引大小增长速率以及其他因素而异。

  • 0 到 50 GB:1
  • 50 GB 到 100 GB:2
  • 100 GB 到 150 GB:3

可以使用以下命令将概念索引分片大小从默认值增加到 2:

tsm configuration set -k nlp.concepts_shards_count -v 2

nlp.values_shards_count

默认值:1

控制存储值、值同义词和别名的弹性搜索值索引的数据分片数。分片计数对搜索索引进行分区,以减少总索引大小,这可能会提高“数据问答”(Ask Data)功能的语义解析器的性能。调整分片计数是您可以随通过 elasticserver.vmopts 增加堆大小而采取的另一种性能增强措施。

Tableau 建议每 50 GB 将分片计数增加 1。若要减少调整分片计数的次数,请通过向当前索引添加 50% 来计算总索引大小。举例来说,如果总索引大小小于 50 GB,则 1 个分片就足够了。实际性能将因服务器、索引大小增长速率以及其他因素而异。

  • 0 到 50 GB:1
  • 50 GB 到 100 GB:2
  • 100 GB 到 150 GB:3

可以使用以下命令将值索引分片计数从默认值增加到 2:

tsm configuration set -k nlp.values_shards_count -v 2

nlp.defaultNewSiteAskDataMode

默认值:enabled_by_default

使用此选项在创建站点时设置“数据问答模式”的初始值。有关详细信息,请参见为站点启用或禁用“数据问答”(Ask Data) 功能

有效选项包括 enabled_by_default(默认值)、disabled_by_defaultdisabled_always

此选项是从以下 Tableau Server 版本开始添加的:2019.4.5、2020.1.3。

noninteractivecontainer.vmopts

默认值:Xmx64m –Xms4g

使用此选项可增加 Tableau Catalog 摄取的 JVM 堆大小。

可以使用以下命令将最大堆大小从默认值增加到 16 GB:

tsm configuration set -k noninteractive.vmopts -v "-XX:+UseConcMarkSweepGC -Xmx16g -Xms64m -XX:+ExitOnOutOfMemoryError"

有关详细信息,请参见用于非交互式微服务容器的内存

pgsql.port

默认值:8060

PostgreSQL 所侦听的端口。

pgsql.preferred_host

指定安装了首选存储库的节点的计算机名称。如果随 tsm topology failover-repository 命令一起指定了 --preferred-r 选项,则使用此值。

示例:

tsm configuration set -k pgsql.preferred_host -v "<host_name>"

注意: host_name 区分大小写,并且必须与 tsm status -v 的输出中显示的节点名称匹配。

pgsql.verify_restore.port

默认值:8061

用于验证 PosgreSQL 数据库完整性的端口。有关详细信息,请参见tsm maintenance backup

recommendations.enabled

默认值:true

控制建议功能,该功能为数据源和表(针对 Tableau Desktop)的建议以及视图的建议(针对 Tableau Server)提供支持。建议基于内容的受欢迎程度,以及确定为与当前用户相似的其他用户使用的内容。

recommendations.vizrecs.enabled

默认值:true

针对 Tableau Server 用户控制适用于视图的建议。此选项是 recommendations.enabled 的子项,如果父选项设置为 false,则此选项将不起作用。当父选项设置为 true 且此选项设置为 false 时,系统仍会向 Tableau Desktop 用户推荐数据源和表,但将禁用 Tableau Server 上的视图的建议。

redis.max_memory_in_mb

默认值:1024

指定缓存服务器外部查询缓存的大小(以 MB 为单位)。

refresh_token.absolute_expiry_in_seconds

默认值:31536000

指定刷新和访问令牌的绝对过期秒数。在初始登录后,客户端(Tableau Mobile、Tableau Desktop、Tableau Prep 等)使用令牌向 Tableau Server 进行身份验证。此配置密钥还控制个人访问令牌过期。所有刷新和访问令牌都是 OAuth 令牌类型。删除设置为 -1 的限制。若要禁用 Oauth 令牌,请参见禁用自动客户端身份验证

refresh_token.idle_expiry_in_seconds

默认值:1209600

指定空闲 Oauth 令牌将过期时的秒数。在初始登录后,客户端使用 Oauth 令牌向 Tableau Server 进行身份验证。若要移除限制,请设置为 -1

refresh_token.max_count_per_user

默认值:24

指定可以为每个用户颁发的刷新令牌的最大数量。如果用户会话比预期更早过期,则可以增加此值或将其设置为 -1 以完全移除令牌限制。

rsync.timeout

默认值:600

完成文件同步所允许的最长时间(以秒为单位)(600 秒 = 10 分钟)。文件同步在配置高可用性或移动数据引擎和存储库的过程中发生。

schedules.display_schedule_description_as_name

默认值:false

控制在创建订阅或数据提取刷新时是显示计划名称(默认值),还是显示描述计划的时间和频率的“计划频率说明” 名称。若要将 Tableau Server 配置为显示计划的时区敏感名称,请将该值设置为 true

设置为 true 时,也会在计划列表页面上的计划名称之后显示“计划频率说明” 。

schedules.display_schedules_in_client_timezone

默认值:true

设置为 true 时,在用户的时区中显示“计划频率说明” (使用客户端浏览器时区计算“计划频率说明”)。

searchserver.connection_timeout_milliseconds

版本 2019.1 中新增。

默认值(以毫秒为单位):100000

指定“搜索和浏览”客户端等待建立与“搜索和浏览”服务器的连接的时间(以毫秒为单位)。

在特别繁忙的 Tableau Server 计算机上,或者如果您看到日志错误“Failed zookeeper health check.Refusing to start SOLR.” (zookeeper 运行状况检查失败。拒绝启动 SOLR。),请增大此值。

有关详细信息,请参见客户端会话超时

searchserver.javamemopts

版本 2019.1 中新增。

默认值:-Xmx512m -Xms512m -XX:+ExitOnOutOfMemoryError -XX:-UsePerfData

确定 SOLR 的 JVM 选项。

在所有可配置选项中,由 -Xmx 参数配置的最大堆内存是调整搜索服务器时最重要的。在大多数情况下,应根据 Tableau Server 计算机上的可用物理内存尽可能高设置此值,最高为 24 GB。若要仅更改最大堆内存,请指定整个默认字符串,但仅更改 -Xmx 的值。

-Xmx 的有效值取决于 Tableau Server 计算机上的可用内存,但不能大于 24 GB。有关详细信息,请参见“搜索和浏览”最大堆内存

searchserver.startup.zookeeper_healthcheck_timeout_ms

版本 2020.1 中新增。

默认值(以毫秒为单位):300000

指定 Tableau Server 在启动时应等待成功的 Zookeeper 运行状况检查的时间(以毫秒为单位)。

在特别繁忙的 Tableau Server 计算机上,或者如果您看到日志错误“Failed zookeeper health check.Refusing to start SOLR.” (zookeeper 运行状况检查失败。拒绝启动 SOLR。),请增大此值。

有关详细信息,请参见Zookeeper 连接运行状况检查在启动时超时

searchserver.zookeeper_session_timeout_milliseconds

默认值(以毫秒为单位):100000

指定“搜索和浏览”客户端等待建立与协调服务 (Zookeeper) 的连接的时间(以毫秒为单位)。

有关详细信息,请参见客户端会话超时

ServerExportCSVMaxRowsByCols

版本 2020.3 中新增。

默认值:0(无限制)

指定可以从“视图数据”下载到 CSV 文件中的最大数据单元格数。默认情况下,没有限制。指定单元格数。例如,设置 300 万的限制: 

tsm configuration set -k ServerExportCSVMaxRowsByCols -v 3000000 
tsm pending-changes apply

service.jmx_enabled

默认值:false

设置为 true 则可将 JMX 端口用于可选的监视和故障排除。

service.max_procs

默认值:<number>

最大服务器进程数。

service.port_remapping.enabled

默认值:true

确定在默认的或配置的端口不可用时 Tableau Server 是否尝试动态地重新映射端口。设置为 false 会禁用动态端口重新映射。

session.ipsticky

默认值:false

使客户端会话仅对用于登录的 IP 地址有效。如果发出请求的 IP 地址和与会话令牌关联的 IP 地址不同,则将会话令牌视为无效。

在某些情况下(例如,当具有已知静态 IP 地址的计算机访问 Tableau Server 时),此设置可提高安全性。

注意:请仔细考虑此设置是否能为您的服务器安全带来帮助。此设置要求客户端具有唯一 IP 地址以及在会话持续时间内保持相同的 IP 地址。例如,处于代理后面的不同用户看起来可能具有相同的 IP 地址(即代理的 IP 地址);在这种情况下,一个用户可能能够访问另一个用户的会话。在另一种情况下,用户可能具有动态 IP 地址,并且其地址可能会在会话过程中发生变化。如果是这样,用户必须要再次登录。

sheet_image.enabled

默认值:true

控制是否可以使用 REST API 获取视图的图像。有关详细信息,请参见 REST API 参考

solr.rebuild_index_timeout

默认值:7200

当升级 Tableau Server 或还原 .tsbak 文件时,后台任务重新生成搜索索引。此设置(以秒为单位)控制该任务的超时设置(7200 秒 = 120 分钟)。

ssl.ciphersuite

默认值:HIGH:MEDIUM:!aNULL:!MD5:!RC4:!3DES:!CAMELLIA:!IDEA:!SEED

指定 SSL 允许的密码算法。

有关可接受的值和格式要求,请参见 Apache 网站上的 SSLCipherSuite(Link opens in a new window)

storage.monitoring.email_enabled

默认值:false

控制是否为服务器磁盘空间监视启用电子邮件通知。默认情况下,电子邮件通知处于启用状态。若要为磁盘空间监视启用通知,请将此选项设置为 true

必须配置 SMTP 才能发送通知。有关详细信息,请参见配置 SMTP 设置

storage.monitoring.warning_percent

默认值:20

剩余磁盘空间的警告阈值,以占总磁盘空间的百分比形式表示。如果磁盘空间低于此阈值,则发送警告通知。

storage.monitoring.critical_percent

默认值:10

剩余磁盘空间的严重阈值,以占总磁盘空间的百分比形式表示。如果磁盘空间低于此阈值,则会发送一个严重通知。

storage.monitoring.email_interval_min

默认值:60

在启用磁盘空间监视且超出阈值时发送电子邮件通知的频率(以分钟为单位)。

storage.monitoring.record_history_enabled

默认值:true

确定是否保存可用磁盘空间历史记录,并可在管理视图中查看。若要为监视禁用历史记录存储,请将 storage.monitoring.record_history_enabled 设置为 false

subscriptions.enabled

默认值:false

控制是否可在系统范围内配置订阅。请参见 设置订阅站点

subscriptions.timeout

默认值:1800

在工作簿订阅任务超时之前允许该任务的单一视图呈现的时间长度,以秒为单位。如果在渲染视图时达到此时间限制,则渲染将继续, 但不会呈现工作簿中的任何后续视图,并且作业将结束并显示错误。在单视图工作簿的情况下,此值永远不会导致渲染由于超时而停止。

svcmonitor.notification.smtp.enabled

默认值:false

控制是否为服务器进程事件启用电子邮件通知。默认情况下,会在进程关闭、进行故障切换或重新启动发送通知。若要启用服务器进程通知,请将此选项设置为 true

必须配置 SMTP 才能发送通知。有关详细信息,请参见配置 SMTP 设置

tabadmincontroller.auth.expiration.minutes

默认值:120

控制会话 Cookie 的有效时间。默认情况下,此选项设置为 120 分钟。此值还确定节点引导程序文件中嵌入式凭据的有效时间。有关详细信息,请参见tsm topology nodes get-bootstrap-file

tdsservice.log.level

注意:版本 2020.3.0 中新增

默认值:info

数据源属性服务的日志记录级别。此设置是动态配置的,因此,如果您只是更改此设置,则不必重新启动 Tableau Server。有关详细信息,请参见更改日志记录级别

tomcat.http.maxrequestsize

默认值:16380

允许根据 HTTP 请求通过 Apache 网关传递的标头内容的最大大小(字节)。标头超过此选项上设置的值将导致浏览器错误,如 HTTP 错误 413(请求实体太大)或身份验证失败。

tomcat.http.maxrequestsize 的值较低可能会导致身份验证错误。与 Active Directory(SAML 和 Kerberos)集成的单点登录解决方案在 HTTP 标头中经常需要大型身份验证令牌。一定要在部署到生产环境之前测试 HTTP 身份验证方案。

我们建议将 gateway.http.request_size_limit 选项设置为您为此选项设置的相同值。

tomcat.https.port

默认值:8443

Tomcat 的 SSL 端口(未使用)。

tomcat.server.port

默认值:8085

tomcat 侦听关机消息的端口。

tomcatcontainer.log.level

默认值:info

交互式微服务容器和非交互式微服务容器中的微服务的日志记录级别。 有关详细信息,请参见更改日志记录级别

tsm.log.level

默认值:info

TSM 服务的日志记录级别。这些日志包括在 TSM 服务出现问题时可能非常有用的信息:管理代理、管理控制器、客户端文件服务、群集控制器、服务管理器和许可证服务。此配置键不会更改协调服务或维护进程的日志记录级别。有关详细信息,请参见更改日志记录级别Tableau Server 进程

tsm.controlapp.log.level

默认值:info

control_<app> 服务的日志记录级别。这些日志包含在启动或重新配置 TSM 或 Tableau Server 进程时遇到问题的情况下可能非常有用的信息。有关详细信息,请参见更改日志记录级别

vizportal.adsync.update_system_user

默认值:false

指定在 Tableau Server 中同步 Active Directory 组时用户的电子邮件地址和显示名称是否更改(即使在 Active Directory 中更改)。为了确保用户电子邮件地址和显示名称在同步过程中更新,请将 vizportal.adsync.update_system_user 设置为 true,然后重新启动服务器。

vizportal.commenting.delete_enabled

默认值:true

设置为 true 时,允许用户删除视图上的注释。如果您是注释的创建者、内容所有者或具有相应站点角色的项目主管,或者是管理员,则可以删除注释。若要了解需要哪些站点角色才能获得完全项目主管访问权限,请参见项目级管理

vizportal.csv_user_mgmt.index_site_users

默认值:true

指定在使用 CSV 文件导入或删除用户时是否逐个用户地完成站点用户索引。如果设置为 true(默认值),则会在添加或删除每个用户时完成索引。若要将站点用户的索引延迟到处理完整个 CSV 文件之后,请将此项设置为 false

vizportal.log.level

默认值:info

vizportal Java 组件的日志记录级别。日志写入 C:\ProgramData\Tableau\Tableau Server\data\tabsvc\logs\vizportal\*.log

要获取更多信息,请设置为 debug。使用调试设置可能会显著影响性能,因此您应该仅当 Tableau 支持部门指示时才使用此设置。

vizportal.openid.client_authentication

指定 OpenID Connect 的自定义客户端身份验证方法。

若要将 Tableau Server 配置为使用需要 client_secret_post 的 IdP,请将此值设置为 client_secret_post

例如,连接到需要此项的 Salesforce IDP 时。

vizportal.rest_api.cors.allow_origin

指定当 vizportal.rest_api.cors.enabled 设置为 true 时经允许可以访问 Tableau Server 上的 REST API 端点的源(站点)。您可以用逗号 (,) 分隔每个条目来指定多个源。

tsm configuration set vizportal.rest_api.cors.allow_origin https://mysite, https://yoursite

如果 vizportal.rest_api.cors.enabledfalse,则此选项列出的源会被忽略。有关详细信息,请参见在 Tableau Server 上启用 CORS

注意: 您可以使用星号 (*) 作为通配符来匹配所有站点。不建议这样做,因为它允许从具有服务器访问权限的任何源进行访问,并且可能存在安全风险。不要使用星号 (*),除非您完全了解您的站点的影响和风险。

vizportal.rest_api.cors.enabled

默认值:false

控制 Tableau Server 是否允许进行跨源资源共享 (CORS)。设置为 true 时,服务器允许 Web 浏览器访问 Tableau REST API 端点。您可以使用此选项和 REST API 创建自定义门户。默认情况下,此功能未启用。若要指定具有访问权限的源(站点),请使用 vizportal.rest_api.cors.allow_origin 选项。只允许使用此选项指定的源向 Tableau Server REST API 发出请求。有关详细信息,请参见在 Tableau Server 上启用 CORS

vizqlserver.allow_insecure_scripts

默认值:false

允许通过 Tableau Desktop 将工作簿发布到服务器,以及从服务器中打开工作簿,即使该工作簿包含可能不安全的 SQL 或 R 表达式(例如,可能允许 SQL 注入的 SQL 表达式)。如果此设置为 false(默认值),则发布工作簿或从服务器中打开工作簿会导致出现错误消息,并且工作将被阻止。在将此值设置为 true 之前,请查看知识库文章在 Tableau Server 中阻止或允许不安全的脚本(Link opens in a new window)

vizqlserver.browser.render

默认值:true

低于由 vizqlserver.browser.render_thresholdvizqlserver.browser.render_threshold_mobile 设置的阈值的视图由客户端 Web 浏览器(而非服务器)呈现。有关详细信息,请参见 配置客户端呈现

vizqlserver.browser.render_threshold

默认值:100

默认值表示 PC 上显示的视图的高复杂度。复杂度因素包括标记数、标题数、参考线数和注释数。高于此复杂度的视图由服务器呈现,而不是在 PC 的 Web 浏览器中呈现。

vizqlserver.browser.render_threshold_mobile

默认值:60

默认值表示平板电脑上显示的视图的高复杂度。复杂度因素包括标记数、标题数、参考线数和注释数。高于此复杂度的视图由服务器呈现,而不是在平板电脑的 Web 浏览器中呈现。

vizqlserver.clear_session_on_unload

默认值:false

确定当用户离开视图或关闭其浏览器时是否将 VizQL 会话保留在内存中。默认值 (false) 会将会话保留在内存中。若在要离开视图或关闭浏览器时关闭 VizQL 会话,请将此项设置为 true

vizqlserver.geosearch_cache_size

默认值:5

设置可同时加载到服务器内存中的不同地理搜索区域设置/语言数据集的最大数量。如果服务器收到针对不在内存中的区域设置/语言数据集的地理搜索请求,则会将该集加载到内存中。如果加载数据集会超出指定限额,则会从内存中清除最近使用的区域设置/语言数据集,以便可加载请求的区域设置/语言数据集。最小值为 1。每个缓存在内存中占用大约 60 MB,因此,如果您将此项设置为 10,内存使用量将为 600 MB (60 * 10)。

vizqlserver.initialsql.disabled

默认值:false

指定是否忽略所有数据源的初始 SQL 语句。此此项设置为 true 以忽略初始 SQL:

tsm configuration set -k vizqlserver.initialsql.disabled -v true

vizqlserver.log.level

默认值:info

vizportal Java 组件的日志记录级别。日志写入 C:\ProgramData\Tableau\Tableau Server\data\tabsvc\logs\vizportal\*.log

要获取更多信息,请设置为 debug。使用调试设置可能会显著影响性能,因此您应该仅当 Tableau 支持部门指示时才使用它。

注意:从版本 2020.3.0 开始,此设置是动态配置的,因此,如果您只是更改此设置,则不必重新启动 Tableau Server。有关详细信息,请参见更改日志记录级别

vizqlserver.NumberOfWorkbookChangesBetweenAutoSaves

默认值:5

Web 制作的自动恢复配置。指定要触发自动保存用户必须进行的更改次数。更改此值时请小心。自动恢复功能可能影响 Web 制作和 Tableau Server 上其他可视化项相关操作的性能。我们建议随着时间的推移进行增量调整来调整此值。

vizqlserver.port

默认值:9100

VizQL 服务器的基本端口。

vizqlserver.protect_sessions

默认值:true

当设置为 true 时,可防止 VizQL 会话在原始用户退出后被重用。

vizqlserver.querylimit

默认值:1800

更新视图允许的最长时间,以秒为单位。1800 秒 = 30 分钟。

vizqlserver.RecoveryAttemptLimitPerSession

默认值:3

Web 制作的自动恢复配置。恢复同一会话的最大尝试次数。更改此值时请小心。自动恢复功能可能影响 Web 制作和 Tableau Server 上其他可视化项相关操作的性能。我们建议随着时间的推移进行增量调整来调整此值。

vizqlserver.session.expiry.minimum

默认值:5

当 VizQL 进程开始出现内存不足的情况时,允许丢弃 VizQL 会话前的空闲时间分钟数。

vizqlserver.session.expiry.timeout

默认值:30

丢弃 VizQL 会话前的空闲时间分钟数。

vizqlserver.sheet_image_api.max_age_floor

默认值:1

用于缓存由 REST API 的“查询视图图像”方法生成的图像的时间(以分钟为单位)。有关详细信息,请参见 REST API 帮助中的 REST API 参考(Link opens in a new window)

vizqlserver.showdownload

默认值:true

控制视图中“下载”菜单的“Tableau 工作簿”选项的显示。设置为 false 时,Tableau 工作簿选项不可用。

vizqlserver.showshare

默认值:true

控制视图中“共享”选项的显示。若要隐藏这些选项,请设置为“False”。

注意: 用户可以覆盖服务器默认值,方法是设置“showShareOptions”JavaScript 或 URL 参数。

vizqlserver.url_scheme_whitelist

指定在视图和仪表板上使用 URL 动作(Link opens in a new window)时要允许的一个或多个 URL 方案(安全列表)。默认情况下,允许 httphttpsgophermailtonewssmsteltsctsl(列入安全列表)。此命令可以包含多个逗号和空格分隔的值,如本示例中所示:

tsm configuration set -k vizqlserver.url_scheme_whitelist -v scheme1, scheme2

您指定的值将覆盖以前的设置。因此,您必须在 set 命令中包括完整的方案列表。(您无法通过重复运行 set 命令来修改方案列表。)

vizqlserver.WorkbookTooLargeToCheckpointSizeKiB

默认值:1024

Web 制作的自动恢复配置。工作簿将自动保存的大小限制 (KB)。将不会自动保存大于此值的工作簿。更改此值时请小心。自动恢复功能可能影响 Web 制作和 Tableau Server 上其他可视化项相关操作的性能。我们建议随着时间的推移进行增量调整来调整此值。

webdataconnector.refresh.enabled

已弃用。请改用 tsm data-access web-data-connectors allow

确定是否在 Tableau Server 中为 Web 数据连接器 (WDC) 启用数据提取刷新。要对所有 WDC 禁用刷新,请将此键的值设置为 false,如下所示:

tsm configuration set --key webdataconnector.refresh.enabled --value false

若要了解详细信息,请参见 Tableau Server 中的 Web 数据连接器

webdataconnector.whitelist.fixed

已弃用。请改用 tsm data-access web-data-connectors add

指定一个或多个可用于访问可通过 HTTP 或 HTTPS 访问的数据连接的 Web 数据连接器 (WDC)。该命令在单行上格式化为 JSON 数据,所有双引号 (") 都使用反斜线 (\) 转义。

例如,将旧金山影业地点 WDC 添加到安全列表中:

tsm configuration set --key webdataconnector.whitelist.fixed --value "'{\"https://tableau.data.world:443\": {\"properties\": { \"secondary_whitelist\": [\"(https://data.world/)(.*)\"] } } }'"

若要了解详细信息,请参见 Tableau Server 中的 Web 数据连接器

webdataconnector.enabled

已弃用。请改用 tsm data-access web-data-connectors allow

默认值:true

设置为 true 后,可以使用 tsm 命令来管理服务器上的 Web 数据连接器。

webdataconnector.whitelist.mode

默认值:mixed

确定 Tableau Server 如何运行 Web 数据连接器。支持的模式为:

  • mixed。用户可以运行位于 URL 的允许列表(安全列表)上的连接器。此模式最初还允许用户运行已导入的 WDC。已不再支持导入 WDC。
  • fixed。用户可以运行位于 URL 的允许列表(安全列表)上的连接器。
  • insecure。用户可以运行任何连接器。

重要信息: insecure 选项用于开发和测试。因为连接器会运行自定义代码,因此运行尚未审核的连接器可以会对安全构成威胁。

wgserver.audit_history_expiration_days

默认值:183

指定历史事件记录从 PostgreSQL 数据库(Tableau Server 数据库)删除后的天数。

wgserver.change_owner.enabled

默认值:true

控制工作簿、数据源或项目的所有权能否更改。其他选项包括 falseadminonly

wgserver.clickjack_defense.enabled

默认值:true

设置为 true 时,可帮助阻止恶意人员“单击劫持”Tableau Server 用户。在单击劫持攻击中,目标页面以透明方式显示在另一个页面之上,攻击者将诱使用户在目标页面中单击或输入信息,而用户会认为自己在与另一个页面交互。

有关详细信息,请参见单击劫持保护

wgserver.domain.fqdn

默认值:%USERDOMAIN% 的值

要使用的 Active Directory 服务器的完全限定域名。

wgserver.domain.whitelist

默认值:null

允许从 Tableau Server 连接到辅助 Active Directory 域。辅助域是 Tableau Server 连接到以进行用户同步的域,但也是未安装 Tableau Server 的域。Tableau Server 将尝试连接到辅助域以进行用户和组同步。在某些情况下,Tableau Server 可能无法连接到辅助域,这将导致错误“域不在白名单中(错误代码 = 101015)”。

需要设置 wgserver.domain.whitelist 选项才能修复安全漏洞[重要] ADV-2020-003:Tableau Server 强制身份验证(Link opens in a new window)。自 2020 年 2 月起,此漏洞的修复程序包含在 Tableau Server 的所有最新版本和维护版本中。

若要设置此选项,请输入引在双引号中的辅助域。多个域必须用逗号和空格分隔。例如,"example.org, domain.com"

不支持通配符功能。举例来说,如果 Tableau 连接到 sub1.example.orgsub2.example.org,则必须添加这两个域。

更新 wgserver.domain.whitelist 选项将覆盖现有值。因此,如果要将新域添加到存储在值中的一组现有域,请在设置选项时将所有现有域与新域包含在一起。您可以通过运行 tsm configuration get –k wgserver.domain.whitelist 来检索现有域的完整列表。

wgserver.extended_trusted_ip_checking

默认值:false

为受信任的票证请求强制实施 IP 客户端匹配。

wgserver.restrict_options_method

默认值:true

控制 Tableau Server 是否接受 HTTP OPTIONS 请求。如果此选项设置为 true,则服务器将为 HTTP OPTIONS 请求返回 HTTP 405(不允许的方法)。

wgserver.saml.idpattribute.username

指定 SAML IdP 存储用户名所用的属性的名称。默认情况下,这设置为 username。如果您的 IdP 使用的属性名称包含空格,请将其括在引号中。有关详细信息,请参见配置服务器范围 SAML配置特定于站点的 SAML

wgserver.saml.iframed_idp.enabled

默认值:false

默认值 false 意味着,当用户选择嵌入视图上的登录按钮时,IdP 的登录表单将在弹出窗口中打开。

当您将其设置为 true 时,已经登录的服务器 SAML 用户将导航到具有嵌入视图的网页,用户将无需登录即可查看该视图。

如果 IdP 支持在 iframe 内登录,则可以将其设置为 true。iframe 选项没有使用弹出窗口安全,所以并不是所有 IdP 都支持它。如果 IdP 登录页面实现点击劫持保护,大多数情况下,登录页面无法显示在 iframe 中,并且用户无法登录。

如果您的 IdP 确实支持通过 iframe 登录,您可能需要显式启用它。但是,即使您可以使用此选项,它也会针对 SAML 禁用 Tableau Server 点击劫持保护,因此它仍然有安全风险。

wgserver.saml.maxassertiontime

默认值:3000

指定自创建后 SAML 断言可用的最大秒数。

wgserver.saml.responseskew

默认值:180

设置 Tableau Server 时间与仍允许处理消息的断言创建时间(基于 IdP 服务器时间)相差的最大秒数。

wgserver.session.apply_lifetime_limit

默认值:false

控制服务器会话是否存在会话生命周期。将此值设置为 true可以配置服务器会话生命周期。

wgserver.session.idle_limit

默认值:240

登录 Web 应用程序发生超时前的空闲时间分钟数。

wgserver.session.lifetime_limit

默认值:1440

服务器会话持续的分钟数(如果设置了会话生命周期)。默认值为 1440 分钟(24 小时)。如果 wgserver.session.apply_lifetime_limitfalse(默认值),则会忽略此项。

wgserver.unrestricted_ticket

默认值:false

指定是否为通过受信任票证进行身份验证的用户将访问权限扩展到服务器资源。默认行为仅允许用户访问视图。将此项设置为 true 可允许具有有效受信任票证的用户访问服务器资源(项目、工作簿等),就好像他们已使用自己的凭据登录一样。

workerX.gateway.port

默认值:80 (如果采用 SSL,则为 443

Apache 侦听 workerX 所在的外部端口(其中“worker”是用于群集中后续服务器节点的术语)。worker0.gateway.port 是 Tableau Server 的外部端口。在分布式环境中,worker0 是初始 Tableau Server 节点。

workerX.vizqlserver.procs

默认值:<number>

VizQL 服务器数。

zookeeper.config.snapCount

指定导致协调服务创建日志快照所必需的事务数。默认情况下,此值为 100,000 个事务。如果协调服务未写入足够的事务来生成快照,则不会自动清理超过 5 天的快照,并且您可能需要额外的磁盘空间来存储事务日志。默认情况下,会在 Tableau 数据目录中创建事务日志和快照。

感谢您的反馈! 提交反馈时出错。请重试,或向我们发送消息