ビルド ログ ファイルを表示、保存、および構成する
Visual Studio 対話型開発環境 (IDE) でプロジェクトをビルドした後、Visual Studio の 出力 ウィンドウでビルドに関するログ情報を表示できます。 出力データはログ ファイルに保存でき、Visual Studio やその他のエディターで表示できます。
ログはビルドの問題のトラブルシューティングに役立ちます。 すべてのビルド ツールで使用される正確なコマンド ラインを見つけ、ビルド プロセス全体に関する完全な診断データを取得できます。 Visual Studio には、ビルド出力とビルド ログ ファイルに表示する情報の種類を指定するためのオプションが用意されています。
この記事では、Visual Studio でビルド ログ ファイルを生成、構成、表示する方法について説明します。
ビルドログファイルを生成して表示する
シナリオのビルド ログ ファイルを生成および表示するには、次の手順に従います。
C++ プロジェクト:
Visual Studio は、プロジェクトをビルドするときにログ ファイルを保存します。 ログ ファイルの一般的な場所には、 Release\<ProjectName>.log、 Debug\<ProjectName>.log、 <ProjectName>.txt などがあります。 すべてのファイルの場所はプロジェクトのルート フォルダーを基準とし、特定の構成に基づきます。
ログ ファイルを参照するには、 Windows Explorer または File Explorer を使用します。
好みのエディターでログ ファイルを開きます。
.NET プロジェクト:
.NET プロジェクトの場合、Visual Studio にログ ファイルを保存するように指示します。
Visual Studio で、 [構築]>[ソリューションのビルド]を選択します。
出力 ウィンドウでテキストを選択し、 Ctrl+S キーボードショートカットを使用します。
Visual Studio から、ビルド出力を保存する場所を指定することを求められます。 その後、その場所から Visual Studio または別のエディターでログ ファイルを開くことができます。
MSBuild:
-fileLogger
(-fl
) コマンドライン オプションを使用して、コマンドラインから直接 MSBuild を実行することで、ビルド ログを生成できます。 詳細については、「MSBuild を使用してビルド ログを取得する」を参照してください。MSBuild では、バイナリ ログ (
-binaryLogger
または-bl
コマンド ライン オプション) を生成することもできます。 バイナリ ログは、構造化ログ ビューアーで表示できます。 構造化ログ ビューアーには、複雑なビルド プロセスを理解しやすくする、より豊富な UI があります。
環境変数を設定して、バイナリ ログをファイルシステムに書き込むよう Visual Studio を構成できます。 MSBuildDebugEngine
を 1
に設定し、ビルド ログ ファイルの目的の場所に MSBUILDDEBUGPATH
を設定します。 変数は、Visual Studio が起動される環境で設定する必要があります。 これらの設定はすべての Visual Studio ビルドに影響するため、ビルドの特定の呼び出しに対してのみログが必要な場合は、適切なオプションではない場合があります。
.NET プロジェクトでのビルド ログ記録に関するより高度な UI サポートについては、プロジェクト システム ツール拡張機能のインストールを検討します。 拡張機能をインストールすると、UI でバイナリ ログのオンとオフを切り替え、ログの一覧から選択できます。 ただし、Visual Studio ビルド システムとの統合方法により、ログは、[出力] ウィンドウや環境変数から取得するログとは少し異なります。
ビルドログのデータの詳細度を指定する
ビルド ログ ファイルに含める情報の量を指定できます。 ログ ファイル列のデータ量は、 ロガーの詳細度として測定されます。 ログ ファイルの行数は、 収集されたメッセージを表します。 ログの詳細度 (列の値) は、ログに記録されるメッセージの種類 (行の値) に影響します。 Quiet 冗長性により、ビルド出力に最小限のログが生成されます。 診断 は最も詳細な設定であり、すべての可能なデータを含むログ ファイルを生成します。
次の表は、ロガーの詳細度に基づいて収集されるメッセージの種類を示しています。
メッセージの種類と詳細 | Quiet | 最小 | 標準 | 詳細 | 診断 |
---|---|---|---|---|---|
エラー | ✅ | ✅ | ✅ | ✅ | ✅ |
警告 | ✅ | ✅ | ✅ | ✅ | ✅ |
重要度の高いメッセージ | ✅ | ✅ | ✅ | ✅ | |
重要度が通常のメッセージ | ✅ | ✅ | ✅ | ||
重要度の低いメッセージ | ✅ | ✅ | |||
その他の MSBuild エンジン情報 | ✅ |
ロガーの詳細度は次の手順で設定できます。
Visual Studio で、 ツール>オプション を選択して、 オプション ダイアログを開きます。
ダイアログで、 プロジェクトとソリューション セクションを展開し、 ビルドと実行 タブを選択します。
MSBuild プロジェクト ビルド出力の詳細度 ドロップダウン リストを使用して、ビルド出力の設定を選択します。
MSBuild プロジェクト ビルド ログ ファイルの詳細度 ドロップダウン リストを使用して、ロガーの詳細度設定を選択します。
ヒント
コンパイラやその他のツールに使用されたコマンド ラインを表示する場合は、少なくとも [詳細] の詳細レベルを選択してください。
変更を適用するには、 [OK]を選択します。
重要
変更内容を 出力 ウィンドウで有効にするには、プロジェクトを再構築する必要があります。 C++ プロジェクトの場合、プロジェクトの再構築により、変更が <ProjectName>.txt ファイルにも反映されます。
詳細については、「[オプション] ダイアログ ボックス、[プロジェクトおよびソリューション]、[ビルド/実行]」および「LoggerVerbosity」を参照してください。
大きなログファイルにはバイナリログを使用する
バイナリ ログは .NET プロジェクトのオプション機能です。これにより、ログ参照のエクスペリエンスが向上し、大きなログで情報を見つけやすくなります。 バイナリ ログを使用するには、 Project System Toolsをインストールします。 詳細については、 https://msbuildlog.com
および バイナリ ログに関する記事を参照してください。
バイナリ ログは .NET プロジェクトのオプション機能です。これにより、ログ参照のエクスペリエンスが向上し、大きなログで情報を見つけやすくなります。 バイナリ ログを使用するには、 Project System Tools 2022をインストールします。 詳細については、 https://msbuildlog.com
および バイナリ ログに関する記事を参照してください。