В этом материале описывается последний выпуск Интерфейса командной строки CodeQL. Дополнительные сведения об этом выпуске см. в разделе https://github.com/github/codeql-cli-binaries/releases.
Чтобы просмотреть сведения о параметрах, доступных для этой команды в более раннем выпуске, выполните команду с параметром в терминале --help
.
Краткий обзор
codeql generate log-summary <options>... -- <input> <result>
Описание
[Дополнительно] Создание сводки структурированного файла журнала.
Эта команда создает сводку журнала событий структурированного средства оценки JSON. Выходные данные этой команды должны быть более стабильными в разных версиях интерфейса командной строки, чем сами файлы журнала. Таким образом, при реализации скрипта, использующего выходные данные из журналов, настоятельно рекомендуется выполнить эту команду и использовать ее выходные данные вместо непосредственного использования журналов событий.
Основные параметры
<input>
[Обязательный] Путь к файлу журнала событий для создания сводки.
<result>
Путь к расположению для вывода сводного файла журнала. Если этот параметр опущен, сводка будет выводиться в stdout.
--minify-output
Если это применимо, опустите пробелы в выводимой сводке. Результат будет менее удобочитаемым, но займет меньше памяти. Этот параметр действует только для некоторых форматов выходных данных.
--utc
[Дополнительно. Некоторые метки времени в сводках, созданных этой командой, могут использовать локальный часовой пояс компьютера, на котором они работают. При включении этого флага все метки времени будут иметь значение UTC.
--format=<format>
Управление форматом выходных данных.
predicates
(по умолчанию): создайте сводку вычислений, выполненных для каждого предиката. Это будет поток объектов JSON, разделенных двумя символами новой строки (по умолчанию) или одним, если --minify-output
параметр передан.
text
: создание понятной для человека сводки по выполнению оценки.
overall
: создайте JSON-файл, содержащий некоторые общие сведения о выполнении оценки, включая сводные статистические данные и сведения о наиболее длительных вычислениях, которые были выполнены.
--[no-]deduplicate-stage-summaries
[Дополнительно] Этот параметр работает только в сочетании с текстовым форматом. В случае прохождения это приведет к тому, что сводные таблицы, содержащие наиболее ресурсоемкие предикаты, не будут повторяться для этапов, которые совместно используются запросами. Это имеет побочный эффект перемещения всех сводных таблиц в конец журнала, а не тех, которые для каждого запроса отображаются в момент завершения запроса.
Общие параметры
-h, --help
Показать этот текст справки.
-J=<opt>
[Дополнительно] Предоставьте параметр виртуальной машине Java, запустив команду .
(Остерегайтесь, что параметры, содержащие пробелы, будут обрабатываться неправильно.)
-v, --verbose
Добавочное увеличение числа выводемых сообщений о ходе выполнения.
-q, --quiet
Постепенно уменьшайте количество выводемых сообщений о ходе выполнения.
--verbosity=<level>
[Дополнительно] Явно задайте уровень детализации для одной из ошибок, предупреждений, хода выполнения, хода выполнения+, хода выполнения++, хода выполнения+++. Переопределяет -v
и -q
.
--logdir=<dir>
[Дополнительно] Запись подробных журналов в один или несколько файлов в заданном каталоге с созданными именами, включая метки времени и имя выполняющейся подкоманды.
(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого при необходимости предоставьте --log-to-stderr
и перенаправьте stderr.)