为本地数据网关配置日志文件

  • 项目

本地数据网关的服务日志分为三个类别：信息、错误和网络。 此分类提供故障排除体验，使你可以专注于特定区域的某个错误或问题。

若要检查日志记录配置，请执行以下步骤：

  1. 打开网关配置文件 Microsoft.PowerBI.EnterpriseGateway.exe.config，默认情况下，该文件应位于 \Program Files\On-premises data gateway 下。
  2. 在继续下一步之前，请复制此文件的副本，以防稍后需要还原该文件。
  3. 在 system.diagnostics 下找到侦听器 ApplicationFileTraceListener。

以下部分提供每种保留类型（具体取决于网关版本）的配置详细信息。

基于期限的保留

从 2023 年 2 月开始，在网关中引入了基于期限的保留概念。 此概念是新网关安装的默认保留类型。

对于这种保留类型，需要考虑两个主要方面（按优先顺序排列）：

  • 网关日志（GatewayInfo*.log、GatewayError*.log、GatewayNetwork*.log）占用的最大磁盘空间，默认值为 5 GB。
  • 保留期（以天为单位），默认值为 30 天。

在此新逻辑中，我们确保为每一天预配一个新的日志文件。 此预配可确保给定日期的信息存在于日志文件中，文件名与日志条目日期相匹配。 如果达到单个文件的最大大小（默认为 100 MB），则还会执行当天的文件分区。

  <system.diagnostics>
    <trace autoflush="true" indentsize="4">
      <listeners>
        <remove name="Default" />
        <add name="ApplicationFileTraceListener" type="Microsoft.PowerBI.DataMovement.Pipeline.Common.Diagnostics.AgeBasedRetentionRotatableFilesManagerTraceListener, Microsoft.PowerBI.DataMovement.Pipeline.Common" initializeData="%LOCALAPPDATA%\Microsoft\On-premises data gateway\,30,5120,100" />
      </listeners>
    </trace>
  </system.diagnostics>

如果你要更改默认的保留参数值，应在 initializeData 值中调整它们。 以下列表描述了每个参数：

  • 以天为单位的保留期（值为 1 到 365 天）。
  • 三种日志文件类型可以占用的最大总大小（以 MB 为单位）。
  • 每个日志文件可以单独占用的最大大小（以 MB 为单位）。 每次达到限制时，都会创建新文件并追加一个序列号。

注意

网关日志使用基于 UTC 的时间戳，每日日志文件轮换将在 00:00 UTC 进行。

基于文件计数的保留

这是 2022 年 12 月及更低版本的网关中的默认日志保留逻辑。 此逻辑有两个主要概念：

  • 为每种日志类型保留的文件数（GatewayInfo*.log、GatewayError*.log、GatewayNetwork*.log）。
  • 每种日志类型占用的最大磁盘空间（GatewayInfo*.log、GatewayError*.log、GatewayNetwork*.log）。

文件根据前面列出的条件进行分区，因此，每当达到最大文件数时，通常也会达到或接近最大磁盘空间限制。

以下摘自网关配置文件 Microsoft.PowerBI.EnterpriseGateway.exe.config 的摘录包含三个类别：GatewayInfo.log、GatewayErrors.log 和 GatewayNetwork.log。

  <system.diagnostics>
    <trace autoflush="true" indentsize="4">
      <listeners>
        <remove name="Default" />
        <add name="ApplicationFileTraceListener"
             type="Microsoft.PowerBI.DataMovement.Pipeline.Common.Diagnostics.RotatableFilesManagerTraceListener, Microsoft.PowerBI.DataMovement.Pipeline.Common"
             initializeData="%LOCALAPPDATA%\Microsoft\On-premises data gateway\,GatewayInfo.log,GatewayErrors.log,GatewayNetwork.log,20,50" />
      </listeners>
    </trace>
  </system.diagnostics>

默认情况下，网关配置文件位于目录 \Program Files\On-premises data gateway 中。 要设置要保留的日志文件数，请更改文件的 initializeData 值中的第一个数字。 要配置每个日志文件的大小，请更改第二个数字。

以下示例指定将保留 20 个日志文件，每个类别中所有文件的总大小不超过 50 MB：GatewayInfo.log,GatewayErrors.log,GatewayNetwork.log,20,50

默认情况下，新的基于期限的保留逻辑是否会应用于我现有的本地数据网关安装？

不是。 目前，这种保留逻辑应用于全新的网关安装。 现有网关在升级到 2023 年 2 月或更高版本时应保留其当前日志保留逻辑（基于文件计数的保留）。

后续步骤

有关如何导出网关日志以进行故障排除的信息，请转到故障排除工具。