Comment log4net fonctionne

Quand un module de CES qui prend en charge log4net et un fichier XML avec l’extension .log4net et le même nom complet que l’exécutable de modèle existe, le module obtient la configuration de log4net de ce fichier, puis produit les informations correspondantes.

Le fichier de configuration log4net n’a pas besoin d’exister lorsque vous démarrez votre CES. Log4net surveille la création d’un nouveau fichier dans le dossier, donc simplement créer le fichier de configuration .log4net déclenche la mise à jour dans la composante qui est en enregistrement. En utilisant un appender de fichier, le dossier de destination n’a pas besoin d’exister. Log4net crée le dossier.

Pour journaliser des informations avec log4net

1. Connectez-vous au serveur maître de Coveo avec un compte d'administrateur.

2. À l'aide d'un éditeur de texte :

   1. Ouvrez le fichier de configuration log4net que vous avez reçu de Assistance Coveo ou un exemple de fichier de configuration log4net qui convient au module CES pour lequel vous souhaitez journaliser des informations.

      Note : À partir de CES 7.0.7104 (octobre 2014), les exemples suivants de fichiers de configuration log4net sont disponibles à partir du dossier [CES_Path]\bin\Log4Net Samples\ :

      • CESCustomCrawlers7.exe.log4net

        Pour journaliser des informations provenant de processus de connecteur (robot).

      • Coveo.CNL.HostProcess.exe.log4net

        Pour journaliser des informations provenant de processus enfants lancés par certains connecteurs tels que le connecteur Database.

      • Coveo.Cdf.NodeProcess.exe.log4net

        Pour journaliser des informations provenant des processus de fournisseur de sécurité.

   2. Dans le fichier, modifiez les lignes qui ont habituellement besoin d’être personnalisées :

      Exemple : Ce qui suit est le contenu typique d’un exemple de fichier de configuration log4net pour un connecteur.

      <log4net>
          <!-- RollingFileAppender - Use for long lasting logging sessions -->
          <!-- NOTE : DO NOT FORGET TO CHANGE THE LOG PATH -->
          <!-- NOTE : If you think that a lot of logs will be generated, change the maxSizeRollBackups value -->
          <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
              <file value="C:\Temp\Crawler.logs" /> <!-- Change this if necessary -->
              <appendToFile value="true" />
              <rollingStyle value="Size" />
              <maxSizeRollBackups value="10" />
              <maximumFileSize value="50MB" />
              <staticLogFileName value="true" />
              <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
              <layout type="log4net.Layout.PatternLayout">
                  <conversionPattern value="%date [%thread] %-5level %logger - %message%newline" />
              </layout>
          </appender>
          
          <!-- Example logger -->
          <!-- NOTE : To activate a logger, you need to specify the name and uncomment the following lines -->
          <!-- 
          <logger name="Coveo.CES.CustomCrawlers.MyCrawler">
              <level value="DEBUG" />
              <appender-ref ref="RollingFileAppender" />
          </logger>
          -->
      </log4net>

      • Dans la section appender, veillez à ce que le fichier de production pointe vers un bon lecteur, dossier, et nom de fichier.

        Exemple : Lorsque vous souhaitez journaliser des informations d’analyse dans le dossier C:\Temp\ :

        <file value="C:\Temp\Crawler.logs" />

      • Dans la section logger, veillez à ce que l’attribut de nom contienne le bon espace de noms. Contactez Assistance Coveo pour obtenir de l’aide lorsque vous ne connaissez pas l’espace de noms.

        Exemple : Lorsque vous souhaitez voir ce qui se passe avec la connexion à Google Drive d’une source, vous pouvez utiliser l’exemple de fichier CESCustomCrawlers7.exe.log4net avec la section logger suivante :

        <logger name="Coveo.Connectors.GoogleDrive.Connection">
          <level value="DEBUG" />
          <appender-ref ref="RollingFileAppender" />
        </logger>

      • Lorsque la section logger est commentée, supprimez les marqueurs de commentaire <!-- --> qui l’entourent pour activer la journalisation.

      Note : Pour plus d’informations sur la syntaxe du fichier de configuration log4net, référez-vous à la documentation d'Apache log4net, ou contactez Assistance Coveo.

   3. Enregistrez le fichier dans le dossier [CES_Path]\bin\.

3. Veillez à ce que le module CES dont vous collectionnez des enregistrements effectue les actions que vous souhaitez journaliser.

4. Ouvrez le fichier journal pour évaluer les enregistrements.

5. Une fois que vous avez obtenu les informations que vous voulez, désactivez la journalisation à l’aide d’une des méthodes suivantes :

   • Renommez le fichier de configuration log4net.

     Exemple : Vous pouvez ajouter l’extension .DISABLED au fichier pour indiquer son état.

     [CES_Path]\bin\CESCustomCrawlers7.exe.log4net.DISABLED

     Lorsque vous souhaitez recommencer à enregistrer des informations similaires, vous n’avez qu’à supprimer l’extension .DISABLED.

     OU

   • Déplacez le fichier de configuration log4net dans un autre dossier tel que [CES_Path]\bin\Log4Net Samples\.

     OU

   • Supprimez le fichier de configuration log4net.

     OU

   • À l’aide d’un éditeur de texte, ouvrez le fichier de configuration log4net dans le dossier [CES_Path]\bin\, et commentez toutes les sections logger en ajoutant des marqueurs de commentaire <!-- --> autour d’eux, puis enregistrez le fichier.

   Important : Il est déconseillé de laisser la journalisation log4net active pendant de longues périodes de temps, car ce processus peut ralentir le module CES qui produit les journaux.