更改日志记录级别


默认情况下，Tableau 服务管理器 (TSM) 和 Tableau Server 记录信息级别的事件。如果您需要收集更多信息，可以更改此级别（例如，如果您与 Tableau 支持人员合作）。

作为最佳做法，除非是按照支持人员的指示排查问题，否则不应提高日志记录级别。您只应在调查特定问题时将日志记录级别设置为调试。更改日志级别可能会产生以下影响：

  • 将日志级别提高到 debug 或 trace 会增加要记录的信息量，可能会对性能产生显著影响。重现问题，然后将日志记录级别重置回信息。
  • 将日志级别设置为 warn 或 error 可能会大大减少信息量，以至于对 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)。

 

用于更改日志记录级别的配置键

此表包括可动态配置的键和不可动态配置的键。

配置键受影响的日志的位置

（路径以 C:\ProgramData\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
回到顶部
感谢您的反馈!您的反馈已成功提交。谢谢!