Exibir, salvar e configurar arquivos de log de build

Depois de criar um projeto no IDE (Ambiente de Desenvolvimento Interativo) do Visual Studio, você pode exibir informações registradas sobre o build na janela de Saída do Visual Studio. Os dados de saída podem ser salvos em arquivos de log que você pode exibir no Visual Studio e em outros editores.

Os logs podem ajudá-lo a resolver problemas na compilação. Você pode localizar as linhas de comando exatas usadas para todas as ferramentas de build e obter dados de diagnóstico completos sobre todo o processo de build. O Visual Studio fornece opções para especificar os tipos de informações que você deseja ver na saída do build e criar arquivos de log.

Este artigo descreve como gerar, configurar e exibir arquivos de log de build no Visual Studio.

Gerar e exibir arquivos de log de build

Use os procedimentos a seguir para gerar e exibir arquivos de log de build para seu cenário.

• Projeto C++:

  O Visual Studio salva os arquivos de log para você ao compilar seu projeto. Os locais comuns para os arquivos de log incluem Release\<ProjectName>.log, Debug\<ProjectName>.loge <ProjectName>.txt. Todos os locais de arquivo são relativos à pasta raiz do projeto e com base em sua configuração específica.

  1. Use Windows Explorer ou Explorador de Arquivos para navegar até o arquivo de log.

  2. Abra o arquivo de log em seu editor preferencial.

• Projeto do .NET:

  Para projetos do .NET, você instrui o Visual Studio a salvar os arquivos de log:

  1. No Visual Studio, selecione Criar>Criar Solução.

  2. Na janela Saída, selecione o texto e use o atalho de teclado Ctrl+S.

  O Visual Studio solicita um local para salvar a saída do build. Em seguida, você pode abrir os arquivos de log desse local no Visual Studio ou em outro editor.

• MSBuild:

  Você pode gerar logs de build executando o MSBuild diretamente da linha de comando usando a opção de linha de comando -fileLogger (-fl). Para obter mais informações, confira Obter logs de build com o MSBuild.

  Com o MSBuild, você também pode gerar logs binários (-binaryLogger ou -bl opção de linha de comando). Você pode exibir logs binários no Visualizador de Log Estruturado . O visualizador de log estruturado fornece uma interface do usuário mais rica que pode facilitar a compreensão de processos de build complexos.

Você pode definir variáveis de ambiente para configurar o Visual Studio para gravar um log binário no sistema de arquivos. Defina MSBuildDebugEngine para 1 e defina MSBUILDDEBUGPATH para o local desejado do arquivo de log de build. As variáveis precisam ser definidas no ambiente no qual o Visual Studio é iniciado. Essas configurações afetam todos os builds do Visual Studio, portanto, talvez não seja uma boa opção se você quiser apenas logs para uma invocação específica do build.

Para obter um suporte mais avançado da interface do usuário para o log de eventos de build em projetos do .NET, instale a extensão Ferramentas de Sistema do Projeto. Com a extensão instalada, você pode ativar e desativar o log binário na interface do usuário e escolher a partir de uma lista de logs. No entanto, devido à forma como ele se integra ao sistema de build do Visual Studio, os logs são um pouco diferentes dos que você obteria da janela Saída ou com as variáveis de ambiente.

Especificar o detalhamento de dados dos logs de build

Você pode especificar quantas informações incluir nos arquivos de log de build. A quantidade de dados nas colunas do arquivo de log é medida como o detalhamento do agente. O número de linhas de arquivo de log representa as mensagens coletadas. O detalhamento de log (valores de coluna) afeta os tipos de mensagens registradas (valores de linha). O detalhamento suave produz um log mínimo na saída de build. Diagnostic é a configuração mais detalhada e gera arquivos de log com todos os dados possíveis.

A tabela a seguir mostra quais tipos de mensagens são coletadas com base na verbosidade do logger:

Tipo de mensagem/Verbosidade	Quieto	Mínimo	Normal	Detalhado	Diagnóstico
Erros	✅	✅	✅	✅	✅
Avisos	✅	✅	✅	✅	✅
Mensagens de alta importância		✅	✅	✅	✅
Mensagens de importância normal			✅	✅	✅
Mensagens de baixa importância				✅	✅
Outras informações do mecanismo do MSBuild					✅

Você pode configurar o detalhamento do agente com as seguintes etapas:

1. No Visual Studio, selecione Ferramentas>Opções para abrir a caixa de diálogo Opções.

2. Na caixa de diálogo, expanda a seção Projetos e Soluções e selecione a guia Criar e Executar.

3. Use a lista suspensa Detalhamento da saída de build do projeto do MSBuild e selecione sua preferência de saída de build.

4. Use a lista suspensa Detalhamento do arquivo de log de build do projeto do MSBuild e selecione sua preferência de detalhamento do agente.

   Dica

   Se você quiser ver as linhas de comando usadas no compilador e em outras ferramentas, escolha pelo menos o nível de detalhamento Detalhado.

5. Para aplicar suas alterações, selecione OK.

Importante

É necessário recompilar o projeto para que suas alterações tenham efeito na Janela de Saída. Para projetos C++, a recompilação do projeto também garante que as alterações sejam refletidas no arquivo <ProjectName>.txt.

Para obter mais informações, consulte a caixa de diálogo Opções , Projects and Solutions, Build and Run e LoggerVerbosity.

Usar logs binários para arquivos de log grandes

Os logs binários são um recurso opcional para projetos do .NET que permite que você tenha uma experiência de navegação de log mais avançada que pode facilitar a localização de informações em logs grandes. Para usar logs binários, instale o Project System Tools 2022. Saiba mais em https://msbuildlog.com e Log binário.

Conteúdo relacionado

• Compilar e limpar projetos e soluções no Visual Studio
• Compilar e construir
• Obter logs de build com o MSBuild