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

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

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

1. 打开网关配置文件 Microsoft.PowerBI.EnterpriseGateway.exe.config，默认情况下，该文件应位于 \Program Files\On-premises 数据网关下。
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 为单位）。 每次达到限制时，都会创建一个新文件，并追加一个序列号。

基于文件计数的保留策略

此样式是 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 数据网关中。 若要设置要保留的日志文件数，请更改文件 initializeData 值中的第一个数字。 若要配置每个日志文件的大小，请更改第二个数字。

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

默认安装的本地数据网关是否会自动应用新的基于年龄的保留逻辑？

否。 此保留逻辑现已应用于全新的网关安装。 升级到 2023 年 2 月或更高版本的现有网关应保留其当前日志保留逻辑（基于文件个数的保留）。

相关内容

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