Lire et examiner la documentation Automation Anywhere

Fermer les contenus

Contenus

Ouvrir les contenus

Journalisation

  • Mis à jour le : 5/10/2019
    • 11.3.x
    • Exploration
    • Enterprise

Journalisation

Les journaux doivent être faciles à lire et à analyser.

Les fichiers journaux stockent les messages issus de divers composants de l'application et du système.

Les journaux doivent être faciles à lire, à comprendre et à analyser. Faites en sorte que le fichier journal reste lisible, clair et descriptif. Indiquez les données traitées et expliquez leur signification. Montrez ce que le robot : est en train de faire. Des fichiers journaux bien faits peuvent constituer une excellente documentation pour le robot : lui-même.

Les journaux aident les personnes et les machines à :

  • Déterminer si un processus s'est exécuté avec succès.
  • Si un processus ne parvient pas à son terme, à consulter les informations sur les raisons de son échec.
  • Déterminer si le robot : se comporte comme prévu.
  • Suivre les journaux de manière interactive.
  • Analyser les journaux avec un outil ou les importer dans Excel pour rassembler et analyser des éléments de mesure.
  • Importer les journaux dans une base de données.

Voici un ensemble de normes permettant de s’assurer que la journalisation est correctement exécutée.

Types de journaux

  • Processus / Information - Le journal de processus est destiné à être un journal d’information. Il peut être utilisé pour surveiller le fonctionnement normal d'une tâche, mais plus important encore, il peut servir à des fins d'audit. L'utilisation du journal de processus dans une piste d'audit peut être une excellente méthode pour déterminer si un processus métier a été réalisé correctement. Par exemple, une commande a-t-elle été passée ou un ticket a-t-il été rempli sans erreur ?
  • Erreur - Le journal des erreurs est destiné aux messages d'erreur détaillés. Lorsqu'une erreur survient dans une tâche, insérez la notification de l'erreur dans le journal de processus. Insérez les informations détaillées sur l'erreur dans le journal des erreurs.
  • Débogage - Enregistre les informations de débogage dans son propre fichier journal et désactive la collecte de débogage en mode de production. Utilisez une variable isProductionMode pour désactiver ces instructions lorsque le robot : passe à la production.
  • Performance - La journalisation des performances peut être inscrite dans le journal de processus / d'information ou dans le journal de performances. Dans certains cas, il est utile d'enregistrer les messages de performance dans leur propre fichier journal.

Types de messages

  • ERREUR - Quelque chose de grave s'est passé, il faut enquêter immédiatement. La tâche ne peut pas remplir correctement sa fonction dans ce cas. Exemple : base de données non disponible, scénario d'utilisation critique impossible à poursuivre, fichier occupé et impossible à ouvrir.
  • AVERTISSEMENT - La tâche peut être poursuivie, mais demande des précautions supplémentaires. Exemple : Task is running in development mode. La tâche peut continuer à fonctionner, mais il convient de toujours examiner et justifier le message.
  • INFO - un processus métier important est terminé. Le message d’information énonce (de manière parfois énigmatique) des informations sur l’application. Exemple :
    • Une action d'application est terminée. Pour une application de réservation de vol, le meilleur cas possible est l'émission d'une seule instruction INFO par billet, qui indique : [Who] booked ticket from [Where] to [Where].
    • Une application subit un changement d'état significatif. Database update ou External system request
  • DÉBOGAGE - Toutes les informations utiles au débogage d'un robot :, généralement à l'usage du développeur robot :. Ces messages ne figurent pas dans le journal de processus. Utilisez une variable isProductionMode pour désactiver ces instructions lorsque le robot : passe à la production.
  • PERFORMANCE - La journalisation des performances peut être inscrite dans le journal de processus / d'information ou dans le journal de performances, si un journal de performances distinct a été créé. Le journal des performances enregistre le temps nécessaire pour exécuter des étapes spécifiques, tout en évitant un niveau de détail excessif. Dans la plupart des cas, limitez la journalisation des performances à un processus métier global. Par exemple, combien de temps a-t-il fallu pour finaliser une commande ou pour traiter une facture ?

Conseils pour la création de journaux

  • Consommateurs

    Il existe deux consommateurs de fichiers journaux : les personnes et les machines.

    Consommateurs humains - Lorsque le consommateur est une personne, son rôle conditionne le type d’information qu’il recherche. Un développeur peut avoir besoin d'informations pour déboguer, analyser les performances ou localiser des erreurs. Un analyste peut avoir besoin d'informations d'audit ou d'informations sur les performances.

    Consommateurs machines - Les machines lisent généralement les fichiers journaux à l'aide de scripts shell écrits par les administrateurs système. Concevez des journaux adaptés à ces deux types de consommateurs de fichier journal.

  • Contenu

    • Inclure des objets - Un bon journal comprend : horodatage, niveau de journalisation, nom de l'ordinateur, nom de la tâche et message.

    • Instructions du journal d'erreur. - Incluez le numéro de ligne et la description de l'erreur pour toute erreur à partir du bloc de traitement des erreurs .

    • Instructions de débogage -Utilisez les instructions du journal de débogage lors de la transmission de variables entre sous-tâches. Incluez les valeurs des variables à l'entrée et à la sortie d’une sous-tâche. Utilisez une variable isProductionMode pour désactiver ces instructions de débogage lorsque le robot : passe à la production.

    • Appels d'interface - Si un robot : interagit avec d'autres systèmes, tels que les Metabots, les API, les appels REST ou SOAP, enregistrez ces appels et, le cas échéant, leurs réponses.

  • Mise en forme
    • Délimiteurs - Délimitent les valeurs du contenu. Pour faciliter l’importation et l’analyse des fichiers journaux, utilisez la délimitation par tabulation pour séparer les valeurs.

    • Enregistrer dans un fichier - Utilisez la fonctionnalité Enregistrer dans un fichier intégrée à Automation Anywhere.

    • Horodatage - Utilisez l'horodatage intégré dans la commande Enregistrer dans un fichier.

      Remarque : Ne créez pas vos propres méthode et format pour l'horodatage, même pour Excel. Ne modifiez la version intégrée que si vous avez un besoin spécifique d'horodatage différent.
  • Sécurité et raccourcis
    • Mots de passe Ne consignez jamais de mots de passe ou d'informations personnelles !

    • Raccourcis - N'ajoutez pas de caractères de raccourci et de scripts (codes magiques) que seules quelques personnes peuvent comprendre.

    • Numérotation - Évitez le formatage des nombres. Utilisez des modèles faciles à reconnaître par les expressions régulières.

  • Performance

    • Journalisation excessive - Les commandes de journalisation normales ne sont pas en elles-mêmes coûteuses en termes de performances. Cependant, ne pratiquez pas une journalisation excessive. Par exemple, plusieurs itérations à l'intérieur d'une petite boucle.

    • Fréquence - Créez de nouveaux journaux toutes les 24 heures. Ajoutez un code pour vérifier la date du jour. Si la date a changé, créez un nouveau journal. Compressez et archivez les anciens fichiers journaux, si nécessaire. Cela évite des fichiers journaux excessivement volumineux.

Envoyer le commentaire