Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation Anywhere

Inhalt schließen

Inhalte

Inhalt öffnen

Protokollierung

  • Aktualisiert: 5/10/2019
    • 11.3.x
    • Erkunden
    • Enterprise

Protokollierung

Protokolle sollten leicht zu lesen und zu analysieren sein.

Protokolldateien speichern Meldungen, die von verschiedenen Anwendungs‑ und Systemkomponenten ausgegeben werden.

Protokolle müssen leicht lesbar, gut verständlich und einfach zu analysieren sein. Sorgen Sie dafür, dass die Protokolldateien lesbar, verständlich und aussagekräftig sind. Zeigen Sie die verarbeiteten Daten und ihre Bedeutung an. Zeigen Sie, was der Bot tatsächlich tut. Gute Protokolle können eine hervorragende Dokumentation des Bots sein.

Protokolle helfen Menschen und Computern dabei,

  • festzustellen, ob ein Prozess erfolgreich abgeschlossen wurde.
  • zu überprüfen, warum ein fehlgeschlagener Prozess nicht abgeschlossen wurde.
  • zu ermitteln, ob der Bot wie erwartet funktioniert.
  • den Protokollen interaktiv zu folgen.
  • die Protokolle mit einem Tool zu analysieren oder die Protokolle in Excel zu importieren, um Kennzahlen zu erfassen und zu analysieren.
  • die Protokolle in eine Datenbank zu importieren.

Im Folgenden finden Sie eine Reihe von Standards, die dafür sorgen, dass die Protokollierung ordnungsgemäß ausgeführt wird.

Arten von Protokollen

  • Process/Informational: Das Prozessprotokoll dient als Informationsprotokoll. Es kann zum Überwachen des normalen Betriebs einer Aufgabe verwendet werden, aber noch wichtiger ist, dass es beim Auditing verwendet werden kann. Die Verwendung des Prozessprotokolls für einen Audit-Trail kann eine hervorragende Methode sein, um festzustellen, ob ein Geschäftsprozess ordnungsgemäß abgeschlossen wurde, z. B. ob eine Bestellung aufgegeben oder ein Ticket fehlerfrei ausgeführt wurde.
  • Error: Das Fehlerprotokoll enthält detaillierte Fehlermeldungen. Wenn in einer Aufgabe ein Fehler auftritt, platzieren Sie eine Benachrichtigung über den aufgetretenen Fehler im Prozessprotokoll. Fügen Sie dem Fehlerprotokoll detaillierte Informationen zum Fehler hinzu.
  • Debug: Speichern Sie Informationen zur Fehlerbehebung in einer eigenen Protokolldatei und deaktivieren Sie die Fehlerbehebungsprotokollierung im Produktionsmodus. Verwenden Sie die Variable isProductionMode, um diese Meldungen auszuschalten, wenn der Bot in die Produktion verschoben wird.
  • Performance: Die Leistungsprotokollierung kann entweder im Process/Informational-Protokoll oder im Performance-Protokoll erfasst werden. In einigen Fällen ist es nützlich, die Leistungsmeldungen in einer eigenen Protokolldatei zu speichern.

Arten von Meldungen

  • ERROR: Ein schwerer Fehler ist aufgetreten, der sofort untersucht werden muss. Die Aufgabe kann ihre Funktion an dieser Stelle nicht richtig ausführen. Beispiel: Datenbank nicht verfügbar, unternehmenskritischer Anwendungsfall kann nicht fortgesetzt werden, Datei ist ausgelastet und kann nicht geöffnet werden.
  • WARN: Die Aufgabe kann fortgesetzt werden, Sie sollten aber Vorsicht walten lassen. Beispiel: Task is running in development mode. Die Aufgabe kann weiter ausgeführt werden, Sie sollten die Meldung aber trotzdem überprüfen und auf ihre Ursachen untersuchen.
  • INFO: Ein wichtiger Geschäftsprozess wurde abgeschlossen. In der Informationsmeldung werden – manchmal verschlüsselt – Informationen über die Anwendung angezeigt. Beispiel:
    • Anwendungsaktion abgeschlossen. Im besten Fall wird für eine Buchungsanwendung einer Fluggesellschaft nur eine INFO-Angabe pro Ticket ausgegeben, und zwar [Who] booked ticket from [Where] to [Where].
    • Der Status der Anwendung ändert sich erheblich. Database update oder External system request
  • DEBUG: Alle Informationen, die für die Fehlerbehebung bei einem Bot hilfreich sind, normalerweise für die Verwendung durch den Bot-Entwickler. Diese Meldungen werden nicht im Prozessprotokoll gespeichert. Verwenden Sie die Variable isProductionMode, um diese Meldungen auszuschalten, wenn der Bot in die Produktion verschoben wird.
  • PERFORMANCE: Die Leistungsprotokollierung kann entweder im Process/Informational-Protokoll oder im Performance-Protokoll erfasst werden, wenn ein separates Performance-Protokoll erstellt wurde. Hier wird nachverfolgt, wie lange es dauert, bestimmte Schritte auszuführen. Vermeiden Sie jedoch zu hohe Detailgenauigkeit. In den meisten Fällen sollten Sie die Leistungsprotokollierung auf einen allgemeinen Geschäftsprozess beschränken. Beispiel: Wie lange hat es gedauert, eine Bestellung abzuschließen oder eine Rechnung zu bearbeiten.

Tipps zum Erstellen von Protokollen

  • Consumers

    Es gibt zwei verschiedene Verwender von Protokolldateien: Menschen und Computer.

    People consumers: Wenn Menschen die Verwender sind, beeinflusst ihre Rolle die Art der Informationen, nach denen sie suchen. Ein Entwickler benötigt möglicherweise Informationen zur Fehlerbehebung, Leistungsanalyse oder Fehlersuche, ein Analyst hingegen Audit‑ oder Leistungsinformationen.

    Machine consumers: Computer lesen Protokolldateien normalerweise durch von Systemadministratoren geschriebene Shell-Scripts. Entwerfen Sie Protokolle, die für beide Verwender von Protokolldateien geeignet sind.

  • Content

    • Include objects: Ein gutes Protokoll enthält: Zeitstempel, Protokollierungsstufe, Computername, Name der Aufgabe und die Meldung.

    • Error log statements: enthalten die Zeilennummer und Fehlerbeschreibung für alle Fehler aus dem Automation Anywhere-Fehlerbehandlungsblock.

    • Debug statements: Verwenden Sie Fehlerbehebungsprotokollmeldungen, wenn Sie eine Variable zwischen Unteraufgaben übergeben. Fügen Sie die Variablenwerte für das Eingeben und Beenden einer Unteraufgabe ein. Verwenden Sie die Variable isProductionMode, um diese Fehlerbehebungsmeldung auszuschalten, wenn der Bot in die Produktion verschoben wird.

    • Interface calls: Wenn ein Bot sich mit anderen Systemen verbindet, z. B. per Aufruf an Metabots, APIs, REST oder SOAP, protokollieren Sie diese Aufrufe und gegebenenfalls auch deren Antworten.

  • Formatting
    • Delimiters: Begrenzen Sie Inhaltswerte. Trennen Sie die Werte mithilfe von Tabulatortrennzeichen, um das Importieren und Analysieren von Protokolldateien zu unterstützen.

    • Log-to-file: Verwenden Sie die in Automation Anywhere integrierte Funktion „Log to File“.

    • Timestamp: Verwenden Sie den im Befehl „log to file“ integrierten Zeitstempel.

      Anmerkung: Erstellen Sie keine eigene Methode und kein eigenes Format für Zeitstempel, auch nicht für Excel. Ändern Sie die integrierte Version nur, wenn Sie einen anderen Zeitstempel benötigen.
  • Security and shortcuts
    • Passwords: Protokollieren Sie niemals Kennwörter oder persönliche Informationen!

    • Short cuts: Fügen Sie keine Verknüpfungszeichen und Scripts (magische Codes) hinzu, die nur wenige Personen verstehen können.

    • Numbering: Vermeiden Sie die Nummerierungsformatierung. Verwenden Sie Muster, die von regulären Ausdrücken leicht erkannt werden können.

  • Performance

    • Excessive logging: Normale Protokollierungsbefehle beeinträchtigen die Leistung nicht sonderlich stark. Vermeiden Sie jedoch übermäßige Protokollierung, z. B. mehrere Iterationen innerhalb einer kleinen Schleife.

    • Frequency: Erstellen Sie alle 24 Stunden neue Protokolle. Fügen Sie Code hinzu, um das aktuelle Datum zu überprüfen. Wenn sich der Tag geändert hat, sollte ein neues Protokoll erstellt werden. Komprimieren und archivieren Sie ältere Protokolldateien nach Bedarf. Dies verhindert zu große Protokolldateien.

Feedback senden