Configurer les fichiers journaux pour la passerelle de données locale

  • Article

Il existe trois catégories de journaux de service pour une passerelle de données locale : informations, erreurs et réseau. Cette catégorisation vous procure une meilleure expérience de résolution des problèmes, vous permettant de vous concentrer sur un domaine spécifique, en fonction de l’erreur ou du problème.

Pour vérifier vos configurations de journalisation, effectuez les étapes suivantes :

  1. Ouvrez le fichier de configuration de passerelle Microsoft.PowerBI.EnterpriseGateway.exe.config qui doit se trouver par défaut sous \Programmes\Passerelle de données locale.
  2. Avant de continuer, faites une copie de ce fichier pour le cas où vous devriez le restaurer plus tard.
  3. Recherchez le ApplicationFileTraceListener de l’écouteur sous system.diagnostics.

Les sections suivantes fournissent les détails de configuration par type de rétention, qui dépend de la version de votre passerelle.

Rétention basée sur l’ancienneté

À compter de février 2023, le nouveau concept de rétention basé sur l’ancienneté au sein d’une passerelle a été introduit. Ce concept est le type de rétention par défaut pour nouvelles installations de passerelle.

Pour ce type de rétention, deux aspects principaux doivent être pris en compte (par ordre de priorité) :

  • L’espace disque maximal à consommer par les journaux de passerelle (GatewayInfo*.log, GatewayError*.log, GatewayNetwork*.log), avec une valeur par défaut de 5 Go.
  • La période de rétention en jours, avec une valeur par défaut de 30 jours.

Dans cette nouvelle logique, nous faisons en sorte que pour chaque nouvelle journée, un nouveau fichier journal soit provisionné. Ce provisionnement garantit que les informations d’une journée donnée sont présentes dans les fichiers journaux, où le nom de fichier correspond aux dates d’entrée du journal. En outre, la partition du fichier dans la journée est effectuée si la taille maximale du fichier individuel (la valeur par défaut est de 100 Mo) est atteinte.

  <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>

Si vous souhaitez modifier les valeurs des paramètres de rétention par défaut, vous devez les ajuster dans la valeur de initializeData. La liste suivante décrit chaque paramètre :

  • Période de rétention en jours (valeur comprise entre 1 et 365 jours).
  • Taille totale maximale en Mo qui peut être consommée par les trois types de fichiers journaux.
  • Taille maximale en Mo que chaque fichier journal peut avoir individuellement. Chaque fois que la limite est atteinte, un nouveau fichier est créé, un numéro séquentiel étant ajouté à son nom.

Remarque

Les journaux de passerelle utilisent des horodatages basés sur UTC, et la rotation quotidienne des fichiers journaux se produit à 00:00 UTC.

Rétention basée sur le nombre de fichiers

C’était la logique de rétention des journaux par défaut dans une passerelle pour les versions de décembre 2022 et antérieures. Cette logique a deux concepts principaux :

  • Nombre de fichiers à conserver par type de journal (GatewayInfo*.log, GatewayError*.log, GatewayNetwork*.log).
  • Espace disque maximal à consommer par type de journal (GatewayInfo*.log, GatewayError*.log, GatewayNetwork*.log).

Les fichiers sont partitionnés conformément aux critères précédemment listés et par conséquent, chaque fois que vous atteignez le nombre maximal de fichiers, il sera généralement au niveau de l’espace disque maximal ou proche de celui-ci.

L’extrait suivant du fichier de configuration de passerelle Microsoft.PowerBI.EnterpriseGateway.exe.config contient les trois catégories: GatewayInfo.log, GatewayErrors.log et 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>

Par défaut, le fichier de configuration de la passerelle se trouve dans le répertoire \Program Files\On-premises data gateway. Pour définir le nombre de fichiers journaux à conserver, changez le premier nombre de la valeur de initializeData du fichier. Pour configurer la taille de chaque fichier journal, modifiez le deuxième nombre.

L’exemple suivant spécifie que 20 fichiers journaux, la somme totale de tous les fichiers de chaque catégorie ne dépassant pas 50 Mo, seront conservés : GatewayInfo.log,GatewayErrors.log,GatewayNetwork.log,20,50

La nouvelle logique de rétention basée sur l’ancienneté s’applique-t-elle par défaut à mon installation de passerelle de données locale existante ?

Nombre Cette logique de rétention s’applique pour l’instant aux installations de passerelles entièrement nouvelles. Les passerelles existant lors de la mise à niveau vers la version de février 2023 ou les versions ultérieures doivent conserver leur logique de rétention des journaux actuelle (rétention basée sur le nombre de fichiers).

Étapes suivantes

Pour plus d’informations sur l’importation des journaux de passerelle à des fins de résolution des problèmes, consultez Outils de résolution des problèmes.