Wenn Ihre Protokolle nicht detailliert genug sind, um ein Problem zu beheben, gibt es mehrere Schritte, die Sie ausführen können, um zusätzliche Informationen zu erhalten und Protokolle nützlicher zu machen.
Schritt-für-Schritt-Debugging-Protokollierung aktivieren
Sie können die Schritt-Debugprotokollierung in GitHub Actions aktivieren, um die Ausführlichkeit der Protokolle eines Auftrags während seiner Ausführung zu erhöhen. Weitere Informationen finden Sie unter Aktivieren der Debugprotokollierung.
Erstellen von CodeQL-Debugartefakten
Warnung
CodeQL-Debugartefakte enthalten eine Kopie des Quellcodes, der von CodeQL analysiert wird. Daher wird empfohlen, diese Pakete nur für Personen freizugeben, die für den Zugriff auf diesen Quellcode autorisiert sind.
Du kannst Artefakte abrufen, um CodeQL zu debuggen.
Die Debugartefakte werden in die Workflowausführung hochgeladen, als Artefakte mit Namen, die mit debug-artifacts beginnen. Wenn CodeQL mehrere Sprachen gleichzeitig während einer Workflowausführung analysiert, gibt es für jede Sprache ein solches Artefakt. Die Daten umfassen die CodeQL Logs, CodeQL Datenbanken, extrahierte Quellcodedateien sowie sämtliche durch den Workflow erzeugten SARIF-Dateien. Weitere Informationen zum Herunterladen von CodeQL-Artefakten findest du unter Herunterladen von Workflowartefakten.
Diese Artefakte helfen beim Debuggen von Problemen mit CodeQL code scanning. Wenn du den GitHub-Support kontaktierst, kannst du diese Daten anfordern.
Erstellen von CodeQL Debugging-Artefakten für CodeQL Standard-Setup
Sie können CodeQL-Debug-Artefakte erstellen, indem Sie die Debugprotokollierung für GitHub Actions aktivieren und eine neue CodeQL-Analyse auslösen, indem Sie zum Beispiel einen neuen Commit in einen Pull-Request-Zweig pushen. Informationen zum Aktivieren der Schritt-Debugprotokollierung von GitHub Actions finden Sie in Aktivieren der Debugprotokollierung.
Wenn Sie CodeQL Zugriff auf private Registries erteilt haben, stehen zusätzliche Artefakte, deren Namen mit proxy-log-file beginnen, zur Verfügung. Diese enthalten Protokolle des Authentifizierungsproxys, der vom Standardsetup von CodeQL zum Authentifizieren von Anfragen an private Registrierungen verwendet wird und zur Behebung von Problemen bei privaten Registrierungs-Konfigurationen genutzt werden kann. Weitere Informationen findest du unter Gewähren des Zugriffs auf private Registrierungen für Sicherheitsfeatures.
Erstellen von CodeQL Debugging-Artefakten für die CodeQL erweiterte Einrichtung
Das Debuggen von Artefakten für CodeQL erweiterte Einrichtung kann auf mehrere verschiedene Arten bezogen werden.
Erneute Ausführung von Aufträgen mit aktivierter Debugprotokollierung
Die einfachste Option zum Erstellen von Debug-Artefakten für CodeQL erweitertes Setup ist die Ausführung der Jobs erneut mit aktiviertem Debug-Logging. Weitere Informationen zum erneuten Ausführen von GitHub Actions-Workflows und -Aufträgen findest du unter Erneutes Ausführen von Workflows und Jobs.
Du musst sicherstellen, dass du Debugprotokollierung aktivieren auswählst. Dadurch werden die Runnerdiagnoseprotokollierung und die schrittweise Debugprotokollierung für die Ausführung aktiviert. Anschließend können Sie die Debugging-Artefakte von CodeQL herunterladen, um weiter zu untersuchen. Du musst die Workflowdatei nicht ändern, wenn du CodeQL-Debugartefakte durch erneutes Ausführen von Aufträgen erstellst.
Verwenden eines Workflow-Kennzeichens
Du kannst CodeQL-Debugartefakte mithilfe eines Flags in deinem Workflow erstellen. Ändere dazu den init-Schritt deiner CodeQL-Analyseworkflow-Datei, und lege debug: true fest.
- name: Initialize CodeQL
uses: github/codeql-action/init@v4
with:
debug: true
Verwendung der Schritt-Debugprotokollierung von GitHub Actions
Wenn Sie die GitHub Actions-Schritt-Debugprotokollierung aktiviert haben, erzeugt CodeQL auch Debuggingartefakte und lädt sie hoch. Weitere Informationen findest du unter Aktivieren der Debugprotokollierung.