создание сводки по журналам

Примечание.

Это содержимое описывает последний выпуск данных CodeQL CLI. Дополнительные сведения об этом выпуске см. в статье https://github.com/github/codeql-cli-binaries/releases.

Чтобы просмотреть сведения о параметрах, доступных для этой команды в предыдущем выпуске, выполните команду с --help параметром в терминале.

Synopsis

Shell

codeql generate log-summary <options>... -- <input> <result>

codeql generate log-summary <options>... -- <input> <result>

Description

          \[Дополнительно] Создайте сводку структурированного файла журнала.

Эта команда создает сводку по структурированным журналам событий вычислителя JSON. Выходные данные этой команды призваны быть более стабильными в разных версиях интерфейса командной строки, чем сами файлы журнала. Таким образом, при реализации скрипта, использующего выходные данные из журналов, настоятельно рекомендуется выполнить эту команду и использовать его выходные данные, а не напрямую с помощью журналов событий.

Options

Основные параметры

`<input>`

          \[Обязательный] Путь к файлу журнала событий для создания сводки.

`<result>`

Путь к расположению для вывода сводного файла журнала. Если это опущено, сводка будет выводиться в stdout.

`--minify-output`

При необходимости опустите пробелы в выходных данных. Результат будет менее читаемым человеком, но занимает меньше памяти. Этот параметр действует только для некоторых форматов выходных данных.

`--utc`

          \[Дополнительно] Некоторые метки времени в сводках, созданных этой командой, могут использовать локальный часовой пояс компьютера, на котором они работают.

Включение этого флага заставляет все метки времени быть в формате UTC.

`--format=<format>`

Управление форматом выходных данных, созданных.

          `predicates`
          _(по умолчанию)_: создание сводки вычислений, выполняемых для каждого предиката. Это будет поток объектов JSON, разделенных двумя новыми символами (по умолчанию) или одним, если `--minify-output` параметр передается.

          `text`: создайте читаемую пользователем сводку по выполнению оценки.

          `overall`: создайте JSON-файл, содержащий некоторые общие сведения об выполнении оценки, включая сводную статистику и сведения о наиболее длительных оценках, которые были выполнены.

`--[no-]deduplicate-stage-summaries`

          \[Дополнительно] Этот параметр работает только в сочетании с текстовым форматом.

При передаче это приведет к тому, что сводные таблицы, содержащие самые дорогие предикаты, не повторяются для этапов, совместно используемых между запросами. Это имеет побочный эффект перемещения всех сводных таблиц в конец журнала, а не наличие тех, которые для каждого запроса отображаются в точке завершения этого запроса.

Распространенные параметры

`-h, --help`

Отображение этого текста справки.

`-J=<opt>`

          \[Дополнительно] Укажите параметр JVM, выполняя команду.

(Убедитесь, что параметры, содержащие пробелы, не будут обрабатываться правильно.)

`-v, --verbose`

Постепенно увеличьте число отображаемых сообщений о ходе выполнения.

`-q, --quiet`

Постепенно уменьшайте количество отображаемых сообщений о ходе выполнения.

`--verbosity=<level>`

          \[Дополнительно] Явным образом задайте уровень детализации на одну из ошибок, предупреждений, хода выполнения, хода выполнения+, хода выполнения++, хода выполнения+++. Переопределяет `-v` и `-q`.

`--logdir=<dir>`

          \[Дополнительно] Запись подробных журналов в один или несколько файлов в указанном каталоге с созданными именами, включающими метки времени и имя выполняющегося подкоманда.

(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого предоставьте --log-to-stderr и перенаправите stderr по мере необходимости.)

`--common-caches=<dir>`

          \[Дополнительно] Управляет расположением кэшированных данных на диске, которые будут сохраняться между несколькими запусками интерфейса командной строки, такими как скачанные пакеты QL и скомпилированные планы запросов. Если этот параметр не задан явным образом, по умолчанию используется каталог с именем `.codeql` в домашнем каталоге пользователя; он будет создан, если он еще не существует.

Доступно с момента v2.15.2.

Кто может использовать эту функцию?

В этой статье