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

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

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

  1. ゲートウェイ構成ファイル Microsoft.PowerBI.EnterpriseGateway.exe.configを開きます。 既定では、このファイルは \Program Files\On-premises data gateway にあります。
  2. 後で復元する必要がある場合は、このファイルのコピーを作成します。
  3. ApplicationFileTraceListenerの下にあるリスナー system.diagnosticsを見つけます。

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

年齢ベースのリテンション

2023 年 2 月から、ゲートウェイでは新しい年齢ベースの保持の概念が導入されています。 このコンセプトは、新しいゲートウェイ インストールの既定の保持タイプです。

この保持の種類では、次の 2 つの主な側面 (優先順位順) を考慮してください。

  • ゲートウェイ ログの最大ディスク領域 (GatewayInfo*.log、GatewayError*.log、GatewayNetwork*.log)、既定値は 5 GB です。
  • 保持期間 (日数)。既定値は 30 日です。

この新しいロジックでは、ゲートウェイは新しい日ごとに新しいログ ファイルを作成することを保証します。 このプロビジョニングにより、ファイル名がログ エントリの日付と一致するログ ファイルに、特定の日の情報が確実に存在します。 また、個々の最大ファイル サイズ (既定値は 100 MB) に達した場合、ゲートウェイは 1 日以内にファイルのパーティション分割を実行します。

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

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

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

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

ゲートウェイ診断の管理者の同意は、管理者がオンプレミス データ ゲートウェイからの診断データを収集してクラウドに送信するかどうかを明示的に制御するために使用する機能です。

ゲートウェイ診断機能では、マッシュアップ ログなどの潜在的に機密性の高いデータが管理承認後にのみ送信されるように、同意ドリブン モデルが導入されています。 また、将来の監視と診断の機能も有効になります。 現時点では、この機能は Dataflows Gen2 成果物にのみ適用されます。 詳細については、「 詳細な更新ログのダウンロード」を参照してください。

注

ゲートウェイ診断は、Microsoft Fabricでの接続とゲートウェイの管理エクスペリエンスから有効になります。 この機能を有効にするオンプレミス データ ゲートウェイ アプリケーションには設定がありません。

どのように機能するのか

ゲートウェイ管理者は、ゲートウェイ設定でゲートウェイ診断を有効にすることができます。 この設定を有効にすると、ゲートウェイは診断データの収集とクラウドへの送信を開始します。

ゲートウェイ管理者診断の同意のスクリーンショット。

テナント管理者は、診断に対する組織全体の同意を制御することで、ガバナンスの追加レイヤーを提供します。 既定では、ゲートウェイ管理者は、テナント レベルの承認を必要とせずに診断を有効にすることができます。 ただし、テナント管理者はいつでも同意を取り消して、組織内のすべてのゲートウェイの診断データ収集を停止できます。

テナント レベルの同意が取り消されると、すべてのゲートウェイが診断データの送信を直ちに停止し、進行中のデータ転送は終了します。

テナント管理者診断の同意オプションのスクリーンショット。

テナント管理者診断の同意スイッチのスクリーンショット。

直ちに適用するために、オンプレミス データ ゲートウェイを再起動すると、進行中の診断アップロードが終了します。

サービスは、サービスによって管理されるAzure Data Lake Storageにゲートウェイ診断データを 24 時間格納します。 24 時間後、データはダウンロードできなくなります。

Tip

現時点では、ゲートウェイ診断機能は Dataflow Gen2 成果物にのみ適用されます。

アップロードの動作

ゲートウェイ診断を有効にすると、ゲートウェイは診断ファイルを定期的なバッチでアップロードします。 アップロードは継続的ストリーミングではなく、リアルタイムではありません。 ゲートウェイは、アップロード可能な診断ファイルを約 60 秒ごとにチェックするため、通常、トレースの生成からMicrosoftマネージド ストレージでの可用性までの遅延は約 1 ~ 2 分です。

各アップロードは、ゲートウェイ マシンからの有効期間が短い送信 HTTPS 要求です。 診断ファイルが正常にアップロードされると、ゲートウェイは直ちにローカル ステージング コピーを削除します。

ネットワークの要件

ネットワーク要件テーブルに次の行を追加します。

エンドポイント Port 方向 Purpose
*.dfs.core.windows.net 443 送信 ゲートウェイ診断をMicrosoftマネージド Azure Data Lake Storageにアップロードする場合に必要です。

診断のアップロードに使用されるストレージ アカウントはMicrosoft管理されており、リージョンによって異なる場合があります。 アカウント名はリージョンに依存するため、*.dfs.core.windows.net への送信 HTTPS トラフィックを許可するか、Azure Storage サービス タグを使用します。

環境で TLS 検査プロキシを使用している場合は、SAS クエリ文字列を含む完全な要求 URL がプロキシに保持されていることを確認します。 SAS トークンは、ゲートウェイが診断ファイルをアップロードするために必要です。

ゲートウェイ診断を有効にする

ゲートウェイ診断は、Power BI サービスまたはMicrosoft Fabricの接続とゲートウェイの管理からクラウドでのみ有効にすることができます。 オンプレミス データ ゲートウェイ アプリケーションには、この機能を有効にする設定がありません。

ゲートウェイ診断を有効にする前に、次の前提条件を確認します。

  • ゲートウェイは標準モードで実行されます。 個人用モード ゲートウェイはサポートされていません。
  • ETW トレースはゲートウェイで有効になっています。
  • ゲートウェイ クラスターの場合、各クラスター メンバーは個別に診断をアップロードします。 クラスター内のすべてのゲートウェイ ノードに対して送信ファイアウォールとプロキシ規則が構成されていることを確認します。

ディスク領域と記憶域のフットプリント

ゲートウェイ診断ステージング データは、ゲートウェイ のインストール ディレクトリではなく、ゲートウェイ サービス アカウントの LOCALAPPDATA パスの下に書き込まれます。 MSessions サブフォルダーには、診断のアップロードに使用されるローカル ステージング ファイルが含まれています。

安定した状態では、アップロードが成功した直後にファイルが削除されるため、通常、ローカルリテンション期間は約 1 ~ 2 分です。 障害または再試行のシナリオでは、ローカル ステージング データは最大で約 1 時間保持できます。

このストレージ フットプリントは、ゲートウェイ ログに関して文書化されている 5 GB のローカル ログ保持予算とは別の追加的な予算です。 開始点として、各ゲートウェイ マシンで約 5 ~ 10 GB の空きディスク ヘッドルームを計画し、環境内の実際の使用状況を監視し、必要に応じて調整します。

診断アップロードのセキュリティ体制

ゲートウェイ診断のアップロードでは、HTTPS 経由でディレクトリ スコープの短い SAS トークンが使用されます。 SAS トークンは、現在最大 9 時間の限られた期間有効であり、追加、書き込み、作成などの書き込み指向のアクセス許可のみを付与します。

ゲートウェイは診断ファイルをアップロードできますが、アップロードされた診断データを読み取ったり、一覧表示したり、列挙したりすることはできません。

Fabricのオンプレミス データ ゲートウェイのゲートウェイ診断に関する FAQ

オンプレミス データ ゲートウェイの診断設定は、Fabric Dataflow Gen2 の更新処理のトラブルシューティングに必要な詳細な診断ログを収集するのに役立ちます。 このセクションでは、アップロードされたログの格納場所、収集される情報、ログにアクセスできるユーザー、ストレージに追加コストがあるかどうかに関する一般的な質問に回答します。

ゲートウェイ診断には追加のログ記録が必要ですか?

ゲートウェイ診断と追加のログ記録は個別の機能です。 診断のアップロードには、追加のログ記録は必要ありません。

2 つの機能は、異なる宛先に書き込みます。追加のログは、より詳細なローカル ログを書き込みますが、ゲートウェイ診断では診断データがローカルでステージングされ、テナントの同意とゲートウェイ レベルの有効化後にMicrosoftマネージド ストレージにアップロードされます。

オンプレミス データ ゲートウェイの診断設定とデータフローの関係は何ですか?

現在、オンプレミス データ ゲートウェイの診断設定は、Fabric Dataflow Gen2 にのみ適用されます。データフロー Gen2 更新の実行時:

  • ゲートウェイは、トラブルシューティングに必要な診断情報を収集します。
  • 関連するマッシュアップ ログがMicrosoftマネージド ストレージにアップロードされます。
  • ログは更新の実行に関連付けられます。
  • ユーザーは、Dataflow Gen2 の更新履歴エクスペリエンスから詳細な診断をダウンロードできます。

この機能は、将来の診断シナリオにも対応している可能性があります。

収集およびアップロードされるログは何ですか?

現在、オンプレミス データ ゲートウェイの診断設定では、主に Fabric Dataflow Gen2 更新操作に関連付けられているマッシュアップ エンジン ログがアップロードされます。

収集される情報の例を次に示します。

  • Dataflow Gen2 の更新実行の詳細。

  • マッシュアップ エンジンの診断。

  • クエリ処理と実行トレース。

アップロードされたログはどこに保存されますか?

テナントのPower BIまたはFabricのサインアップ リージョンによって、ストレージの場所が決まります。 該当するテナント リージョンのMicrosoftマネージド ストレージには、アップロードされたログが格納されます。

この機能をサポートするAzureリージョンはどれですか?

マネージド ストレージ インフラストラクチャを提供するすべてのFabricサポートされているリージョンでは、オンプレミス データ ゲートウェイの診断設定がサポートされます。 この機能は、カタール地域では利用できません。

アップロードされたデータには機密情報が含まれていますか?

Yes. アップロードされた診断には、お客様が機密性の高いと見なす情報が含まれている場合があります。 機能は、デフォルトで無効になっています。 オンプレミス データ ゲートウェイの診断設定を選択する前に、組織のデータ処理とサポート ポリシーを確認します。

ログはどのくらいの期間保存されますか?

システムは診断データを 24 時間保持します。 この 24 時間Fabric Dataflow Gen2 の実行からデータをダウンロードできます。

アップロードされたログにアクセスできるユーザー

アクセスは厳密に制御されます。 Microsoft担当者は、アップロードされたログに定期的にアクセスしません。 アクセスは既定で制限され、承認された運用手順で必要な場合にのみ付与されます。

これらのログを格納するための追加コストはありますか。

いいえ。 現在、オンプレミス データ ゲートウェイの診断設定は追加料金なしで提供されています。

Troubleshooting

診断は有効ですが、ログは表示されません

診断が有効になっていても診断ログが表示されない場合は、次の項目を確認します。

  1. ポート 443 から *.dfs.core.windows.net への送信 HTTPS アクセスを確認します。

  2. ゲートウェイが標準モードで実行されていることを確認します。 個人用モード ゲートウェイはサポートされていません。

  3. ゲートウェイ診断のテナントの同意が取り消されていないことを確認します。

  4. DiagnosticsUploader および DiagnosticsStorageClient のトレース行がないか、GatewayInfo*.log を確認してください。 有用なトレース メッセージは次のとおりです。アップロード可能な N 個のファイルが見つかりました。AuthenticationFailed、最大エラー数に達しました

  5. 3 つの連続するアップロード エラーが発生した場合、アクセスが更新されるまで診断コレクションが停止します。 この動作により、根本原因がアップロードの繰り返し失敗であっても、診断が予期せずオフになったように見える場合があります。

関連コンテンツ

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

  • Last updated on