Este conteúdo descreve a versão mais recente do CodeQL CLI. Para obter mais informações sobre essa versão, confira https://github.com/github/codeql-cli-binaries/releases.
Para ver os detalhes das opções disponíveis para esse comando em uma versão anterior, execute o comando com a opção --help no terminal.
Sinopse
codeql generate log-summary <options>... -- <input> <result>
codeql generate log-summary <options>... -- <input> <result>
Descrição
[Avançado] Crie um resumo de um arquivo de log estruturado.
Esse comando cria um resumo de um log de eventos do avaliador JSON estruturado. A saída desse comando tem como objetivo ser mais estável em diferentes versões da CLI do que os próprios arquivos de log. Portanto, durante a implementação de um script que usa a saída dos logs, recomendamos fortemente executar esse comando e usar a saída dele em vez de usar os logs de eventos diretamente.
Opções
Opções principais
<input>
[Obrigatório] Caminho para o arquivo de log de eventos do qual um resumo será produzido.
<result>
Caminho para o local no qual o arquivo de log resumido será gerado. Se isso for omitido, o resumo será gerado em stdout.
--minify-output
Quando aplicável, omita o espaço em branco no resumo gerado. O resultado será menos legível por humanos, mas ocupará menos memória. Essa opção só tem efeito para alguns formatos de saída.
--utc
[Avançado] Alguns carimbos de data/hora nos resumos produzidos por esse comando podem usar o fuso horário local do computador em que estão sendo executados. A habilitação desse sinalizador força todos os carimbos de data/hora a serem UTC.
--format=<format>
Controle o formato da saída produzida.
predicates (padrão) : produza um resumo da computação executada para cada predicado. Esse será um fluxo de objetos JSON separados por dois caracteres de nova linha (por padrão) ou um, se a opção --minify-output for transmitida.
text: produza um resumo legível por humanos da execução da avaliação.
overall: produza um arquivo JSON que contém algumas informações gerais sobre a execução da avaliação, incluindo algumas estatísticas resumidas e informações sobre as avaliações mais demoradas que foram executadas.
--[no-]deduplicate-stage-summaries
[Avançado] Essa opção só funciona em conjunto com o formato de texto. Se ela for transmitida, isso resultará na repetição das tabelas de resumo que contêm os predicados mais caros nas fases compartilhadas entre as consultas. Isso tem o efeito colateral de mover todas as tabelas de resumo para o final do log, em vez de fazer com que as de cada consulta apareçam no ponto em que a consulta foi concluída.
Opções comuns
-h, --help
Mostre este texto de ajuda.
-J=<opt>
[Avançado] Forneça a opção para a JVM que executa o comando.
(Use-a com cautela, pois as opções que contêm espaços não serão tratadas corretamente.)
-v, --verbose
Aumente incrementalmente o número de mensagens de progresso impressas.
-q, --quiet
Diminua incrementalmente o número de mensagens de progresso impressas.
--verbosity=<level>
[Avançado] Defina explicitamente o nível de detalhamento como erros, avisos, progresso, progresso+, progresso++ ou progresso+++. Substitui -v e -q.
--logdir=<dir>
[Avançado] Escreva logs detalhados em um ou mais arquivos no diretório fornecido, com nomes gerados que incluem carimbos de data/hora e o nome do subcomando em execução.
(Para gravar um arquivo de log com um nome sobre o qual você tem controle completo, forneça --log-to-stderr e redirecione stderr conforme desejado.)
--common-caches=<dir>
[Avançado] Controle a localização dos dados armazenados em cache no disco que persistirão entre várias execuções da CLI, como pacotes QL baixados e planos de consulta compilada. Se não for definido explicitamente, o padrão corresponde a um diretório intitulado .codeql no diretório inicial do usuário; que será criado se ainda não existir.
Disponível desde v2.15.2.