Anzeigen, Speichern und Konfigurieren von Buildprotokolldateien

Nachdem Sie ein Projekt in der interaktiven Entwicklungsumgebung (IDE) von Visual Studio erstellt haben, können Sie protokollierte Informationen zum Build im Visual Studio-Ausgabefenster anzeigen. Die Ausgabedaten können in Protokolldateien gespeichert werden, die Sie in Visual Studio und anderen Editoren anzeigen können.

Die Protokolle können Ihnen beim Beheben von Problemen im Build helfen. Sie können die genauen Befehlszeilen finden, die für alle Build-Tools verwendet werden, und vollständige Diagnosedaten über den gesamten Build-Prozess abrufen. Visual Studio bietet Optionen zum Angeben der Arten von Informationen, die in den Build-Ausgabe- und Protokolldateien angezeigt werden sollen.

In diesem Artikel wird beschrieben, wie Sie Build-Protokolldateien in Visual Studio generieren, konfigurieren und anzeigen.

Generieren und Anzeigen von Build-Protokolldateien

Verwenden Sie die folgenden Verfahren, um Build-Protokolldateien für Ihr Szenario zu generieren und anzuzeigen.

• C++-Projekte:

  Visual Studio speichert die Protokolldateien für Sie, wenn Sie Ihr Projekt erstellen. Allgemeine Speicherorte für die Protokolldateien sind Release\<ProjectName>.log, Debug\<ProjectName>.log und <ProjectName>.txt. Alle Dateispeicherorte sind relativ zu Ihrem Projektstammordner und basieren auf Ihrer spezifischen Konfiguration.

  1. Verwenden Sie Windows-Explorer oder Explorer, um zur Protokolldatei zu navigieren.

  2. Öffnen Sie die Protokolldatei in Ihrem bevorzugten Editor.

• .NET-Projekt:

  Für .NET-Projekte weisen Sie Visual Studio an, die Protokolldateien zu speichern:

  1. Wählen Sie in Visual Studio Erstellen>Projektmappe erstellen.

  2. Markieren Sie im Ausgabefenster den Text, und verwenden Sie die Tastenkombination STRG+S.

  Visual Studio fordert Sie auf, einen Speicherort auszuwählen, an dem die Buildausgabe gespeichert werden soll. Anschließend können Sie die Protokolldateien von diesem Speicherort in Visual Studio oder einem anderen Editor öffnen.

• MSBuild:

  Sie können Buildprotokolle generieren, indem Sie MSBuild direkt von der Befehlszeile ausführen. Verwenden Sie dabei die Befehlszeilenoption -fileLogger (-fl). Weitere Informationen finden Sie unter Erhalten von Buildprotokollen mit MSBuild.

  Mit MSBuild können Sie auch binäre Protokolle (-binaryLogger oder -bl Befehlszeilenoption) generieren. Sie können Binärprotokolle im Strukturierten Protokoll-Viewer anzeigen. Der strukturierte Protokoll-Viewer bietet eine umfangreichere Benutzeroberfläche, die das Verständnis komplexer Buildprozesse erleichtern kann.

Sie können Umgebungsvariablen festlegen, um Visual Studio so zu konfigurieren, dass ein binäres Protokoll in das Dateisystem geschrieben wird. Legen Sie MSBuildDebugEngine auf 1 und MSBUILDDEBUGPATH auf den gewünschten Speicherort der Buildprotokolldatei fest. Die Variablen müssen in der Umgebung festgelegt werden, in der Visual Studio gestartet wird. Diese Einstellungen wirken sich auf alle Visual Studio-Builds aus, daher ist dies möglicherweise keine gute Option, wenn Sie nur Protokolle für einen bestimmten Aufruf des Builds verwenden möchten.

Für erweiterte UI-Unterstützung für die Buildprotokollierung in .NET-Projekten sollten Sie die Project System Tools-Erweiterung installieren. Wenn die Erweiterung installiert ist, können Sie die binäre Protokollierung in der Benutzeroberfläche aktivieren und deaktivieren und aus einer Liste der Protokolle auswählen. Aufgrund der Integration in das Visual Studio-Buildsystem unterscheiden sich die Protokolle jedoch etwas von den Protokollen, die Sie aus dem Fenster Ausgabe oder mit den Umgebungsvariablen erhalten würden.

Angeben der Ausführlichkeit von Daten für Buildprotokolle

Sie können angeben, wie viele Informationen in die Build-Protokolldateien aufgenommen werden sollen. Die Datenmenge in den Protokolldateispalten wird als Logger-Ausführlichkeit gemessen. Die Anzahl der Protokolldateizeilen stellt die erfassten Nachrichten dar. Die Ausführlichkeit des Protokolls (Spaltenwerte) wirkt sich auf die Typen der protokollierten Nachrichten (Zeilenwerte) aus. Stille Ausführlichkeit erzeugt minimale Protokollierung in der Buildausgabe. Diagnose ist die ausführlichste Einstellung und generiert Protokolldateien mit allen möglichen Daten.

Die folgende Tabelle zeigt, welche Arten von Nachrichten basierend auf der Ausführlichkeit des Loggers gesammelt werden:

Nachrichtentyp/Ausführlichkeit	Quiet	Minimal	Normal	Detailliert	Diagnose
Fehler	✅	✅	✅	✅	✅
Warnungen	✅	✅	✅	✅	✅
Nachrichten mit hoher Priorität		✅	✅	✅	✅
Nachrichten mit normaler Priorität			✅	✅	✅
Nachrichten mit niedriger Priorität				✅	✅
Weitere MSBuild-Engine-Informationen					✅

Sie können die Ausführlichkeit des Loggers mit den folgenden Schritten konfigurieren:

1. Wählen Sie in Visual Studio Extras>Optionen, um den Dialog Optionen zu öffnen.

2. Erweitern Sie im Dialogfeld den Abschnitt Projekte und Lösungen, und wählen Sie die Registerkarte Erstellen und Ausführen aus.

3. Verwenden Sie die Dropdownliste MSBuild-Projektbuildausgabe und wählen Sie Ihre Buildausgabeeinstellung aus.

4. Verwenden Sie die Dropdownliste der Ausführlichkeit der Protokolldatei des MSBuild-Projektbuilds und wählen Sie Ihre Logger-Ausführlichkeitseinstellung aus.

   Tipp

   Wenn Sie die für den Compiler und andere Tools verwendeten Befehlszeilen anzeigen möchten, wählen Sie mindestens die Ausführlichkeitsebene Detailliert aus.

5. Wählen Sie OK, um Ihre Änderungen zu übernehmen.

Wichtig

Sie müssen das Projekt neu erstellen, damit die Änderungen im Ausgabefenster wirksam werden. Bei C++-Projekten stellt das Projektneuaufbau außerdem sicher, dass die Änderungen in der <ProjectName>.txt-Datei widerspiegelt werden.

Weitere Informationen finden Sie unter Optionen (Dialogfeld), Projekte und Projektmappen, Erstellen und Ausführen und LoggerVerbosity.

Verwenden von binären Protokollen für große Protokolldateien

Binärprotokolle sind ein optionales Feature für .NET-Projekte, mit dem das Suchen von Informationen in umfangreichen Protokollen benutzerfreundlicher und einfacher wird. Um Binärprotokolle zu verwenden, installieren Sie Project System Tools 2022. Weitere Informationen finden Sie unter https://msbuildlog.com und Binärprotokoll.

Zugehöriger Inhalt

• Erstellen und Bereinigen von Projekten und Projektmappen in Visual Studio
• Kompilieren und Erstellen
• Erhalten von Buildprotokollen mit MSBuild