オンプレミス データ ゲートウェイのログ ファイルの構成

オンプレミス データ ゲートウェイのサービス ログには、情報、エラー、ネットワークの 3 つのカテゴリがあります。 この分類により、エラーや問題をトラブルシューティングするとき、特定の領域に重点的に取り組むことが可能になります。

ログ記録の構成を確認するには、次の手順を実行します。

1. ゲートウェイ構成ファイル Microsoft.PowerBI.EnterpriseGateway.exe.config を開きます。このファイルは既定では、\Program Files\オンプレミス データ ゲートウェイの下にあります。
2. 先に進む前に、後で復元する必要がある場合に備えて、このファイルのコピーを作成します。
3. system.diagnostics の下にあるリスナー ApplicationFileTraceListener を探します。

次のセクションでは、データ保持の種類ごとの構成の詳細を示します。これは、ゲートウェイのバージョンによって異なります。

年齢ベースのデータ保持

2023 年 2 月から、ゲートウェイ内に年齢ベースの新しいデータ保持の概念が導入されました。 この概念は、新しいゲートウェイのインストールにおける既定のデータ保持の種類です。

このデータ保持の種類では、(優先順位に従って) 考慮すべき主な側面が 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 日の値)。
• 3 種類のログ ファイルで使用できる最大合計サイズ (MB)。
• 各ログ ファイルが個別に保持できる最大サイズ (MB)。 制限に達するたびに、連番が付加された新しいファイルが作成されます。

Note

ゲートウェイのログでは UTC ベースのタイムスタンプが使用され、毎日のログ ファイルのローテーションは 00:00 UTC に行われます。

ファイル数ベースのデータ保持

これは、2022 年 12 月以前のバージョンのゲートウェイ内の既定のログ データ保持ロジックでした。 このロジックには、次の 2 つの主要な概念があります。

• ログの種類ごとに保持されるファイルの数 (GatewayInfo*.log、GatewayError*.log、GatewayNetwork*.log)。
• ログの種類 (GatewayInfo*.log、GatewayError*.log、GatewayNetwork*.log) ごとに使用される最大ディスク領域。

ファイルは、前述の基準に従ってパーティション分割されるため、ファイルの最大数に達するたびに、通常はディスク領域も最大か、それに近い状態になります。

ゲートウェイ構成ファイル Microsoft.PowerBI.EnterpriseGateway.exe.config からの以下の抜粋には、GatewayInfo.log、GatewayErrors.log、GatewayNetwork.log という 3 つのカテゴリーが含まれています。

  <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 値の最初の数を変更します。 各ログ ファイルのサイズを構成するには、2 番目の数値を変更します。

次の例である GatewayInfo.log,GatewayErrors.log,GatewayNetwork.log,20,50 では、各カテゴリのすべてのファイルのうち、合計サイズが 50 MB を超えない 20 個のログ ファイルが保持されるよう指定されています。

新しい年齢ベースのデータ保持ロジックは、既存のオンプレミス データ ゲートウェイのインストールに既定で適用されますか?

不正解です。 現時点では、このデータ保持ロジックは、完全に新しいゲートウェイのインストールに適用されます。 既存のゲートウェイを 2023 年 2 月以降のバージョンへのアップグレードする場合は、現在のログ データ保持ロジック (ファイル数ベースのデータ保持) を維持する必要があります。

次のステップ

トラブルシューティングのためにゲートウェイ ログをエクスポートする方法については、「トラブルシューティング ツール」を参照してください。