次の方法で共有


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

オンプレミス データ ゲートウェイのサービス ログには、情報、エラー、ネットワークの 3 つのカテゴリがあります。 この分類により、エラーまたは問題の特定の領域に集中できるトラブルシューティング エクスペリエンスが提供されます。

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

  1. ゲートウェイ構成ファイル Microsoft.PowerBI.EnterpriseGateway.exe.configを開きます。既定では、\Program Files\On-premises データ ゲートウェイの下にあります。
  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)。 制限に達するたびに、新しいファイルが作成され、順次番号が追加されます。

ゲートウェイ ログでは 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.logGatewayErrors.logGatewayNetwork.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 データ ゲートウェイにあります。 保持するログ ファイルの数を設定するには、ファイルの initializeData 値の最初の数を変更します。 各ログ ファイルのサイズを構成するには、2 番目の番号を変更します。

次の例では、サイズが 50 MB 以下の各カテゴリ内のすべてのファイルの合計である 20 個のログ ファイルを保持することを指定します。 GatewayInfo.log,GatewayErrors.log,GatewayNetwork.log,20,50

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

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

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