Configurar arquivos de log para o gateway de dados local

Artigo
05/06/2024

Há três categorias de logs de serviço para um gateway de dados local: informações, erro e rede. Essa categorização fornece uma experiência de solução de problemas que permite que você se concentre na área específica para um erro ou problema.

Para verificar suas configurações de log, execute as seguintes etapas:

Abra o arquivo de configuração do gateway Microsoft.PowerBI.EnterpriseGateway.exe.config, que, por padrão, deve estar localizado em \Arquivos de Programas\Gateway de dados local.
Antes de prosseguir, faça uma cópia deste arquivo para o caso de precisar restaurá-lo mais tarde.
Localize o ouvinte ApplicationFileTraceListener que está em system.diagnostics.

As seções a seguir fornecem os detalhes de configuração por tipo de retenção, que dependem da versão do gateway.

Retenção com base na idade

A partir de fevereiro de 2023, foi introduzido o novo conceito de retenção baseado na idade dentro de uma porta de entrada. Esse conceito é o tipo de retenção padrão para novas instalações de gateway.

Para este tipo de retenção, há dois aspetos principais a considerar (por ordem de precedência):

Espaço máximo em disco a ser consumido pelos logs do gateway (GatewayInfo*.log, GatewayError*.log, GatewayNetwork*.log), com um valor padrão de 5 GB.
Período de retenção em dias, com um valor padrão de 30 dias.

Nessa nova lógica, garantimos que, a cada novo dia, um novo arquivo de log seja provisionado. Esse provisionamento garante que as informações de um determinado dia estejam presentes em arquivos de log onde o nome do arquivo corresponde às datas de entrada do log. Além disso, a partição de arquivo dentro do dia é executada se o tamanho máximo do arquivo individual (padrão de 100 MB) for atingido.

  <system.diagnostics>
    <trace autoflush="true" indentsize="4">
      <listeners>
        <remove name="Default" />
        <add name="ApplicationFileTraceListener" type="Microsoft.PowerBI.DataMovement.Pipeline.Common.Diagnostics.AgeBasedRetentionRotatableFilesManagerTraceListener, Microsoft.PowerBI.DataMovement.Pipeline.Common" initializeData="%LOCALAPPDATA%\Microsoft\On-premises data gateway\,30,5120,100" />
      </listeners>
    </trace>
  </system.diagnostics>

Se quiser alterar os valores dos parâmetros padrão de retenção, você deve ajustá-los no initializeData valor. A lista a seguir descreve cada parâmetro:

Período de retenção em dias (um valor entre 1 e 365 dias).
Tamanho total máximo em MB que pode ser consumido pelos três tipos de arquivo de log.
Tamanho máximo em MB que cada ficheiro de registo pode ter individualmente. Cada vez que o limite é atingido, um novo arquivo é criado com um número sequencial anexado.

Nota

Os logs de gateway usam carimbos de data/hora baseados em UTC, e a rotação diária do arquivo de log ocorrerá às 00:00 UTC.

Retenção baseada na contagem de arquivos

Essa era a lógica de retenção de log padrão dentro de um gateway para versões de dezembro de 2022 e anteriores. Esta lógica tem dois conceitos principais:

Número de arquivos a serem retidos por tipo de log (GatewayInfo*.log, GatewayError*.log, GatewayNetwork*.log).
Espaço máximo em disco a ser consumido por tipo de log (GatewayInfo*.log, GatewayError*.log, GatewayNetwork*.log).

Os arquivos são particionados de acordo com os critérios listados anteriormente e, portanto, sempre que você atingir o número máximo de arquivos, normalmente também estará no espaço em disco máximo ou perto dele.

O seguinte trecho do arquivo de configuração do gateway Microsoft.PowerBI.EnterpriseGateway.exe.config contém as três categorias: GatewayInfo.log, GatewayErrors.loge GatewayNetwork.log.

  <system.diagnostics>
    <trace autoflush="true" indentsize="4">
      <listeners>
        <remove name="Default" />
        <add name="ApplicationFileTraceListener"
             type="Microsoft.PowerBI.DataMovement.Pipeline.Common.Diagnostics.RotatableFilesManagerTraceListener, Microsoft.PowerBI.DataMovement.Pipeline.Common"
             initializeData="%LOCALAPPDATA%\Microsoft\On-premises data gateway\,GatewayInfo.log,GatewayErrors.log,GatewayNetwork.log,20,50" />
      </listeners>
    </trace>
  </system.diagnostics>

Por padrão, o arquivo de configuração do gateway está localizado no diretório \Arquivos de Programas\Gateway de dados local. Para definir o número de arquivos de log a serem mantidos, altere o primeiro número no valor do initializeData arquivo. Para configurar o tamanho de cada arquivo de log, altere o segundo número.

O exemplo a seguir especifica que 20 arquivos de log, sendo que a soma total de todos os arquivos em cada categoria não terá mais de 50 MB de tamanho, serão mantidos: GatewayInfo.log,GatewayErrors.log,GatewayNetwork.log,20,50

A nova lógica de retenção baseada na idade será aplicada por padrão à minha instalação de gateway de dados local existente?

Não Essa lógica de retenção, por enquanto, é aplicada a instalações de gateway completamente novas. Os gateways existentes durante a atualização para fevereiro de 2023 ou versões posteriores devem manter sua lógica de retenção de log atual (retenção baseada na contagem de arquivos).

Próximos passos

Para obter informações sobre como exportar logs de gateway para solução de problemas, vá para Ferramentas de solução de problemas.

Partilhar via