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 em log sobre o build na janela Saída do Visual Studio. Os dados de saída podem ser salvos em arquivos de log que podem ser exibidos no Visual Studio e em outros editores.

Os logs podem ajudar você a solucionar problemas no build. É possível 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ção que você deseja ver na saída do build e nos arquivos de log de build.

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 a fim de gerar e exibir arquivos de log de build para seu cenário.

• Projeto C++:

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

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

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

• Projeto .NET:

  Para projetos .NET, você orienta 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 solicitará um local para salvar a saída de build. Assim, você pode abrir os arquivos de log desse local no Visual Studio ou em outro editor.

• MSBuild:

  Você também pode gerar logs de build executando o MSBuild diretamente na 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 (opção de linha de comando -binaryLogger ou -bl). Você pode exibir logs binários no Visualizador de logs estruturados. O visualizador de logs estruturados proporciona uma interface de usuário mais avançada 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 como 1 e defina MSBUILDDEBUGPATH como a localização desejada do arquivo de log de compilação. As variáveis devem ser definidas no ambiente no qual o Visual Studio é iniciado. Essas configurações afetam todos os builds do Visual Studio, portanto, podem não ser uma boa opção se você quiser logs apenas para uma invocação específica do build.

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

Especificar detalhamento de dados para logs de build

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

A tabela a seguir mostra quais tipos de mensagem são coletados com base no detalhamento do agente:

Tipo de mensagem/Detalhamento	Quiet	Minimal	Normal	Detalhado	Diagnostic
Errors	✅	✅	✅	✅	✅
Warnings	✅	✅	✅	✅	✅
Mensagens de alta prioridade		✅	✅	✅	✅
Mensagens de prioridade normal			✅	✅	✅
Mensagens de baixa prioridade				✅	✅
Outras informações sobre o 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 Compilar e Executar.

3. Use a lista suspensa Detalhamento da saída de build do projeto no 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 no 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 as alterações, selecione OK.

Importante

Você deve recompilar o projeto para que suas alterações entrem em vigor na janela 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, confira Caixa de diálogo Opções, Projetos e Soluções, Criar e Executar e LoggerVerbosity.

Usar logs binários para arquivos de log grandes

Logs binários são um recurso opcional para projetos do .NET que proporcionam uma experiência de navegação de log mais rica que pode facilitar a localização de informações em logs grandes. Para usar logs binários, instale as Ferramentas do Sistema para Projetos 2022. Saiba mais em https://msbuildlog.com e Log binário.

Conteúdo relacionado

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