Logging

Le but du logging des diagnostics est de fournir plus d'informations lors de l'exécution de l'application. Les erreurs et les avertissements enregistrés peuvent aider à identifier les défaillances du système qui ne sont pas immédiatement évidentes pour un utilisateur final. Un logging plus détaillé peut être temporairement activée pour obtenir une représentation utile du comportement d'une application lors de la résolution d'un problème.

Blue Prism utilise une bibliothèque éprouvée et fiable appelée NLog pour produire et enregistrer les informations du log. Un administrateur peut régler avec précision la quantité d'informations enregistrées, soit globalement, soit dans des zones spécifiques de l'application.

Niveaux de logging

Les entrées de log sont classées par niveau. Les entrées avec un niveau Information ou supérieur sont généralement enregistrées de manière standard. Des niveaux inférieurs, plus détaillés, tels que Débogage et Trace, fournissent des informations plus complètes, mais doivent être activés.

NLog définit les niveaux suivants :

  • Trace : logs très détaillés qui peuvent inclure des informations à volume élevé telles que les charges utiles de protocole. Ce niveau de logging n'est généralement activé que pendant le développement.
  • Débogage : débogage des informations, moins détaillé que Trace, n'est généralement pas activé dans les environnements de production en raison d'un impact possible sur les performances.
  • Information : messages d'information. Ces logs sont normalement activés dans les environnements de production.
  • Avertissement : messages d'avertissement, généralement pour des problèmes non critiques, qui peuvent être corrigés ou qui sont des défaillances temporaires.
  • Erreur : messages d'erreur qui concernant la plupart du temps des exceptions.
  • Fatal : erreurs très graves.

Configuration de logging standard

Les niveaux de logging sont définis dans le fichier appsettings.json du dossier d'installation pour chaque site Web et service. Pour les installations par défaut, ces dossiers se trouvent sous C:\Program Files (x86)\Blue Prism\.

Vous ne devriez pas avoir à modifier vous-même les réglages de configuration du log dans le fichier appsettings.json pendant l'utilisation normale. Le service clients Blue Prism fournira d'autres réglages de configuration du log lorsqu'il examinera un problème avec le produit. Si les réglages de logging sont modifiés dans le fichier appsettings.json, le site devra être redémarré dans IIS.

La modification de la configuration de logging peut affecter les performances de l'application et vous devez faire preuve de prudence en cas de modification dans un environnement de production.

La configuration par défaut écrit les entrées du log au niveau Information et aux niveaux supérieurs (y compris les avertissements, les erreurs et les erreurs fatales) vers un fichier log. Les fichiers log sont écrits dans le répertoire spécifié dans le réglage LogsFolder du fichier appsettings.json, généralement défini sur ./Logs_{Application}, par exemple ./Logs_Hub ou ./Logs_Interact.

Par défaut, les réglages de configuration de logging dans le fichier appsettings.json sont les suivants :

Copier 
"Logging": {
      "LogsFolder": "./Logs_{Application}",
      "LogLevel": {
        "Default": "Information",
        "System": "Warning",
        "Microsoft": "Warning"
      }
    },

Des fichiers log distincts sont générés en fonction du niveau de logging et de la date, qui sont reflétés dans le nom du fichier log, tel que warns.2021-05-07 ou infos.2021-05-07.

Vous trouverez ci-dessous un exemple de ligne d'un fichier log d'informations :

[08:58:11.4549] Connect.Core.Actions.UpdateCacheAction – Mise à jour du cache des widgets

Le format de ce texte contient les éléments suivants :

  • Heure (en utilisant le fuseau horaire défini sur le serveur) : la date est indiquée dans le nom du fichier.
  • Nom de l'enregistreur : identifie généralement la classe et l'espace de noms d'où provient l'entrée de log.
  • Le message de log.
  • Informations d'erreur : disponibles uniquement si les informations d'exception sont enregistrées. Les détails complets sont enregistrés sur une ligne distincte sous le message de log.

Configuration de logging supplémentaire

Blue Prism a développé des réglages de configuration de logging supplémentaire qui peuvent être ajoutés au fichier appsettings.json approprié pour capturer l'activité de certains composants.

Débogage de LDAP

Vous pouvez configurer le logging pour aider à déboguer les problèmes qui peuvent survenir lors de la synchronisation de Hub avec LDAP. Vous devrez définir le logging dans le fichier appsettings.json d'Authentication Server avant de synchroniser les utilisateurs dans l'interface utilisateur Hub.

  1. Sur le serveur, accédez au dossier Authentication Server. Par défaut, il se trouve sous C:\Program Files (x86)\Blue Prism\.
  2. Ouvrez le fichier appsettings.json dans un éditeur de texte.

  3. Localisez la section Logging et ajoutez "ImsServer.IntegrationServices.Services.LdapConnectionService": "Debug" dans la section LogLevel et insérez une virgule à la fin de la ligne ci-dessus, par exemple :

    Copier 
    "Logging": {
          "LogsFolder": "./Logs_AuthenticationServer",
          "LogLevel": {
            "Default": "Information",
            "System": "Warning",
            "Microsoft": "Warning",
            "ImsServer.IntegrationServices.Services.LdapConnectionService": "Debug"
          }
        },
  4. Enregistrez le fichier.

  5. Recyclez le pool Authentication Server dans les pools d'applications IIS.

    Si vous avez effectué une mise à niveau à partir d'une version antérieure à la 4.3, vous devrez recycler le pool IMS.

  6. Redémarrez le site Authentication Server dans les sites IIS.

Cela crée un fichier avec le préfixe « debug » et la date appropriée dans le répertoire Logs_AuthenticationServer.

Après avoir résolu avec succès tout problème à l'aide des informations de débogage, vous devez supprimer la ligne ajoutée et la virgule, enregistrer le fichier et répéter les étapes 5 et 6. Dans le cas contraire, la taille du fichier log augmentera de manière significative et risque de saturer la mémoire.

Service de collecte de logs

Ce service Windows supprime les anciens logs de produit de chaque composant du serveur Web (Hub, Interact, Authentication Server , Audit Service, Auditeur du service d'audit, Email Service, Service de collecte de logs, IADA, Interact Remote API, SignalR, Submit Form Manager). Ce service est planifié le 7 de chaque mois et les logs sont déplacés vers C:\Program Files (x86)\Blue Prism\ArchivedLogs.

Vous pouvez modifier le chemin d'accès au dossier du log archivé et la date du planificateur dans apppsettings.json. « ArchivedFolder » sous C:\Program Files (x86)\Blue Prism\Log Service (par défaut) vous permettra de modifier le chemin d'accès à l'archive et « DayOfMonth » vous permettra de modifier la date du planificateur.

Plus d'informations

Les liens suivants peuvent fournir des informations supplémentaires utiles :