Diagnoseexport

[Experimentell] Exportieren von Diagnoseinformationen für eine fehlgeschlagene Analyse

Wer kann dieses Feature verwenden?

CodeQL ist für die folgenden Repositorytypen verfügbar:

In diesem Artikel

Hinweis

In diesem Inhalt wird die neueste Version von CodeQL CLI beschrieben. Weitere Informationen zu diesem Thema findest du unter https://github.com/github/codeql-cli-binaries/releases.

Um Details zu den Optionen anzuzeigen, die für diesen Befehl in früheren Releases verfügbar sind, führe den Befehl mit der Option --help im Terminal aus.

Zusammenfassung

Shell
codeql diagnostic export --format=<format> [--output=<output>] <options>...

Description

          \[Experimentell] Exportiere Diagnoseinformationen für eine fehlgeschlagene Analyse.

Verfügbar seit v2.12.6.

Options

Primäre Optionen

--format=<format>

          \[Erforderlich] Das Format, in dem die Ergebnisse geschrieben werden sollen. Einer von:

          `raw`: Eine Liste von unbearbeiteten, uninterpretierten Diagnosenachrichten als JSON-Objekte.

          `sarif-latest`: Static Analysis Results Interchange Format (SARIF), ein JSON-basiertes Format zur Beschreibung von statischen Analyseergebnissen. Diese Formatoption basiert auf der neuesten unterstützten Version (v2.1.0). Sie eignet sich nicht für die Automatisierung, da sie zwischen verschiedenen CodeQL-Versionen unterschiedliche Versionen von SARIF erzeugt.

          `sarifv2.1.0`: SARIF v2.1.0.

          `text`: Eine Liste mit Aufzählungspunkten von Diagnosemeldungen.

-o, --output=<output>

Der Ausgabepfad, an den Diagnoseinformationen geschrieben werden sollen.

--sarif-exit-code=<sarifExitCode>

          \[Nur SARIF-Formate] Exit Code des fehlgeschlagenen Prozesses.

--sarif-exit-code-description=<sarifExitCodeDescription>

          \[Nur SARIF-Formate] Grund für das Beenden des fehlgeschlagenen Prozesses.

--sarif-category=<category>

          \[Nur SARIF-Formate] \[Empfohlen] Gib eine Kategorie für diese Analyse an, die in der SARIF-Ausgabe enthalten sein soll. Eine Kategorie kann verwendet werden, um mehrere Analysen zu unterscheiden, die für denselben Commit und dasselbe Repository, aber für verschiedene Sprachen oder verschiedene Teile des Codes durchgeführt wurden.

Wenn du dieselbe Version einer Codebasis mit verschiedenen Methoden (z. B. für verschiedene Sprachen) analysierst und die Ergebnisse zur Präsentation in die Codeüberprüfung auf GitHub hochlädst, sollte sich dieser Wert zwischen den einzelnen Analysen unterscheiden, damit die Codeüberprüfung weiß, dass die Analysen sich gegenseitig ergänzen und nicht ersetzen. (Die Werte sollten zwischen Ausführungen derselben Analyse für verschiedene Versionen der Codebasis konsistent sein.)

Dieser Wert wird (mit einem nachgestellten Schrägstrich, sofern noch nicht vorhanden) als Eigenschaft <run>.automationDetails.id angezeigt.

--diagnostic-dir=<diagnosticDirs>

Verzeichnis, das CodeQL-Diagnosemeldungen enthält. Du kannst dies mehrmals übergeben, um mehrere Verzeichnisse einzuschließen.

Allgemeine Optionen

-h, --help

Zeigt diesen Hilfetext an.

-J=<opt>

          \[Erweitert] Gib der JVM, die den Befehl ausführt, eine Option.

(Beachte, dass Optionen, die Leerzeichen enthalten, nicht ordnungsgemäß verarbeitet werden.)

-v, --verbose

Ermöglicht die inkrementelle Erhöhung der Anzahl ausgegebener Statusmeldungen.

-q, --quiet

Ermöglicht die inkrementelle Verringerung der Anzahl ausgegebener Statusmeldungen.

--verbosity=<level>

          \[Erweitert] Lege die Ausführlichkeitsstufe explizit auf einen der Werte Fehler, Warnungen, Fortschritt, Fortschritt+, Fortschritt++, Fortschritt+++ fest. Überschreibt `-v` und `-q`:

--logdir=<dir>

          \[Erweitert] Detaillierte Protokolle in eine oder mehrere Dateien im angegebenen Verzeichnis schreiben, mit generierten Namen, die Zeitstempel und den Namen des ausgeführten Unterbefehls enthalten.

(Um eine Protokolldatei mit einem Namen zu schreiben, über den du die volle Kontrolle hast, gib stattdessen --log-to-stderr an, und leite stderr wie gewünscht um.)

--common-caches=<dir>

          \[Erweitert] Steuert den Zwischenspeicherort von Datenträgern wie z. B. heruntergeladene LQ-Pakete und kompilierte Abfragepläne, die zwischen mehreren Ausführen des CLI erhalten bleiben sollen. Wenn dies nicht explizit festgelegt ist, wird dieses Verzeichnis standardmäßig auf ein Verzeichnis mit dem Namen `.codeql` festgelegt, das sich im Startverzeichnis des Benutzer. Es wird erstellt, wenn es noch nicht vorhanden ist.

Verfügbar seit v2.15.2.