Skip to main content

Os logs não são detalhados o suficiente

Aumente a verbosidade do log e gere artefatos de depuração quando os logs não tiverem detalhes de diagnóstico.

Se os logs não forem detalhados o suficiente para solucionar um problema, há várias etapas que você pode executar para obter informações extras e tornar os logs mais úteis.

Habilitar log de depuração da etapa

O log de depuração da etapa aumenta o detalhamento dos logs de um trabalho durante e depois da execução.

Para habilitar o log de depuração de etapas:

  1. No repositório que contém o fluxo de trabalho, defina o seguinte segredo ou variável: para . Se o segredo e a variável estiverem definidos, o valor do segredo terá precedência sobre a variável.
  2. Execute novamente o fluxo de trabalho ou dispare uma nova execução.

Depois que o segredo ou a variável são definidos, mais eventos de depuração são mostrados nos logs de etapas. Confira AUTOTITLE.

Você também pode usar o contexto para executar etapas condicionalmente somente quando o registro em log de depuração estiver ativado. Confira AUTOTITLE.

Criando artefatos de depuração de CodeQL

Aviso

Os artefatos de depuração do CodeQL contêm uma cópia do código-fonte que está sendo analisado por CodeQL, portanto, sugerimos compartilhar esses pacotes apenas com pessoas autorizadas a acessar esse código-fonte.

Você pode obter artefatos para ajudar você a depurar CodeQL. Os artefatos de depuração serão carregados na execução do fluxo de trabalho como artefatos com nomes começando em . Se CodeQL analisar várias linguagens ao mesmo tempo durante a execução do fluxo, haverá um desses artefatos para cada uma. Os dados contém os logs de CodeQL, bancos de dados de CodeQL, exceto arquivos de código-fonte, e todos os outros arquivos SARIF produzidos pelo fluxo de trabalho. Para mais informações sobre o download de artefatos de CodeQL, consulte AUTOTITLE.

Estes artefatos ajudarão você a depurar problemas com digitalização de código de CodeQL code scanning. Se você entrar em contato com Suporte do GitHub, eles poderão solicitar esses dados.

Como criar artefatos de depuração de CodeQL para a configuração padrão de CodeQL

Você pode criar artefatos de depuração de CodeQL ativando o log de depuração do GitHub Actions (consulte Habilitar log de depuração da etapa) e iniciando uma nova análise do CodeQL, ao fazer um push de um novo commit para uma ramificação de solicitação de pull.

Se você tiver dado a CodeQL acesso a registros privados, artefatos adicionais cujos nomes começam com estarão disponíveis. Eles contêm logs do proxy de autenticação usado na configuração padrão de CodeQL para autenticar solicitações para registros privados e podem ser usados para solucionar problemas nas configurações desses registros. Para saber mais, confira AUTOTITLE.

Como criar artefatos de depuração de CodeQL para a configuração avançada de CodeQL

Artefatos de depuração para a configuração avançada de CodeQL podem ser obtidos de várias maneiras.

Executar trabalhos novamente com o log de depuração habilitado

A opção mais fácil para criar artefatos de depuração para a configuração avançada de CodeQL é executar os trabalhos novamente com o log de depuração habilitado. Para mais informações sobre como executar novamente os fluxos de trabalho e os trabalhos de GitHub Actions, consulte AUTOTITLE.

Selecione Habilitar log de depuração. Essa opção habilita o log de diagnóstico do executor e o log de depuração de etapas para a execução. Em seguida, você poderá baixar os artefatos de depuração de CodeQL para uma investigação mais aprofundada. Você não precisa modificar o arquivo de fluxo de trabalho ao criar artefatos de depuração do CodeQL executando novamente trabalhos.

Usando um sinalizador de fluxo de trabalho

Você pode criar artefatos de depuração de CodeQL usando um sinalizador no seu fluxo de trabalho. Para isso, você precisa modificar a etapa do arquivo do Fluxo de trabalho de análise do CodeQL e definir .

- name: Initialize CodeQL
  uses: github/codeql-action/init@v4
  with:
    debug: true

Como usar o log de depuração da etapa de GitHub Actions

Se você tiver habilitado o log de depuração de etapas de GitHub Actions, CodeQL também produzirá artefatos de depuração e os carregará como parte da execução do fluxo de trabalho. Para obter instruções, consulte Habilitando o log de depuração da etapa.