Skip to main content

GitHub AE es una versión limitada en este momento.

generate log-summary

[Avanzado] Crea un resumen de un archivo de registro estructurado.

Las licencias de GitHub CodeQL se otorgan por usuario tras la instalación. Puedes usar CodeQL solo para determinadas tareas según las restricciones de las licencias. Para obtener más información, vea «Acerca de la CLI de CodeQL».

Si tienes una licencia de GitHub Advanced Security, puedes usar CodeQL para el análisis automatizado, la integración continua y la entrega continua. Para obtener más información, vea «Acerca de GitHub Advanced Security».

En este contenido se describe la versión más reciente de CodeQL CLI. Para obtener más información sobre esta versión, consulta https://github.com/github/codeql-cli-binaries/releases.

Para ver detalles de las opciones disponibles para este comando en una versión anterior, ejecuta el comando con la opción --help en el terminal.

Sinopsis

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

Descripción

[Avanzado] Crea un resumen de un archivo de registro estructurado.

Este comando crea un resumen de un registro de eventos del evaluador JSON estructurado. El objetivo es que la salida del comando sea más estable entre las distintas versiones de la CLI que los propios archivos de registro. Así, cuando se implemente un script que use la salida de los registros, se recomienda encarecidamente ejecutar este comando y usar su salida en lugar de usar los registros de eventos directamente.

Opciones

Opciones principales

<input>

[Obligatorio] Ruta de acceso al archivo de registro de eventos del que se va a generar un resumen.

<result>

Ruta de acceso a la ubicación de salida del archivo de registro resumido. Si se omite, el resumen se generará en stdout.

--minify-output

Si procede, omite los espacios en blanco en el resumen generado. La lectura del resultado será más difícil, pero este ocupará menos memoria. Esta opción solo afecta a algunos formatos de salida.

--utc

[Avanzado] Algunas marcas de tiempo de los resúmenes generados por este comando pueden usar la zona horaria local de la máquina en la que se ejecutan. Al habilitar esta marca, se obliga a que todas las marcas de tiempo estén en UTC.

--format=<format>

Controla el formato de la salida generada.

predicates (predeterminado) : genera un resumen del cálculo realizado para cada predicado. Se trata de una secuencia de objetos JSON separados por dos caracteres de nueva línea (de forma predeterminada) o por uno si se pasa la opción --minify-output.

text: genera un resumen legible de la ejecución de evaluación.

overall: genera un archivo JSON que contiene información general sobre la ejecución de evaluación, incluidas algunas estadísticas de resumen e información sobre las evaluaciones realizadas que requirieron más tiempo.

--[no-]deduplicate-stage-summaries

[Avanzado] Esta opción solo funciona junto con el formato de texto. Si se pasa, hará que las tablas de resumen que contengan los predicados más costosos no se repitan en las fases compartidas entre consultas. Sin embargo, como efecto secundario, se mueven todas las tablas de resumen al final del registro, en lugar de que cada tabla de consulta aparezca en el punto en que finaliza esa consulta.

Opciones comunes

-h, --help

Muestra este texto de ayuda.

-J=<opt>

[Avanzado] Asigna la opción a la JVM que ejecuta el comando.

(Ten en cuenta que las opciones que contienen espacios no se administrarán correctamente).

-v, --verbose

Aumenta incrementalmente el número de mensajes de progreso impresos.

-q, --quiet

Reduce incrementalmente el número de mensajes de progreso impresos.

--verbosity=<level>

[Avanzado] Establece explícitamente el nivel de detalle en errores, advertencias, progreso, progreso+, progreso++, progreso+++. Invalida -v y -q.

--logdir=<dir>

[Avanzado] Escribe registros detallados en uno o varios archivos del directorio especificado, con nombres generados que incluyen marcas de tiempo y el nombre del subcomando en ejecución.

(Para escribir un archivo de registro con un nombre sobre el que tienes control total, proporciona --log-to-stderr y redirige stderr como quieras).

--common-caches=<dir>

[Avanzado] Controla la ubicación de los datos en caché del disco que se conservarán entre varias ejecuciones de la CLI, como paquetes QL descargados y planes de consulta compilada. Si no se define explícitamente, se toma como predeterminado un directorio denominado .codeql en el directorio principal del usuario, que se creará en caso de que no exista.

Disponible desde la versión v2.15.2.