Logging

Der Zweck diagnostischen Loggings besteht darin, während der Ausführung der Anwendung mehr Informationen zur Verfügung zu stellen. Geloggte Fehler und Warnungen können helfen, Fehler innerhalb des Systems, die für einen Endbenutzer womöglich nicht sofort offensichtlich sind, genau zu ermitteln. Temporär kann ausführlicheres Logging aktiviert werden, um bei der Behebung eines Fehlers einen hilfreichen Einblick in das Verhalten der Anwendung zu gewinnen.

Zum Ausgeben und Aufzeichnen von Loginformationen verwendet Blue Prism eine bewährte und zuverlässige Bibliothek namens NLog. Ein Administrator kann die Menge der protokollierten Informationen entweder global oder in bestimmten Bereichen der Anwendung anpassen.

Logging-Stufen

Logeinträge werden in Stufen kategorisiert. Einträge mit der Stufe Information oder höher werden in der Regel standardmäßig aufgezeichnet. Niedrigere, detailliertere Stufen, wie Debug und Trace, liefern ausführlichere Informationen, müssen jedoch aktiviert werden.

NLog definiert die folgenden Stufen:

  • Trace – Sehr detaillierte Logs, die große Informationsmengen wie Protokollnutzlasten, enthalten können. Diese Logstufe wird typischerweise nur während der Entwicklung aktiviert.
  • Debuggen– Debugging-Informationen mit weniger Details als Trace, normalerweise in Produktionsumgebungen aufgrund möglicher Auswirkungen auf die Leistung nicht aktiviert.
  • Information – Informationsmeldungen, die normalerweise in Produktionsumgebungen aktiviert sind.
  • Warning – Warnhinweise, typischerweise für nicht kritische Probleme, die gelöst werden können, oder für vorübergehende Fehler.
  • Error – Fehlermeldungen – meist sind dies Ausnahmen.
  • Fatal – Sehr schwerwiegende Fehler.

Standard-Logging-Konfiguration

Die Logging-Stufen werden in der „appsettings.json“-Datei im Installationsordner für jede Website und jeden Dienst definiert. Bei Standardinstallationen finden Sie diese Ordner unter C:\Programme (x86)\Blue Prism\.

Sie sollten die Logkonfigurationseinstellungen in der „appsettings.json“-Datei bei normaler Verwendung nicht eigenständig ändern müssen. Der Blue Prism Kundensupport stellt bei der Untersuchung eines Problems mit dem Produkt alternative Logkonfigurationseinstellungen bereit. Wenn die Logging-Einstellungen in der „appsettings.json“-Datei geändert werden, muss die Site in IIS neu gestartet werden.

Das Ändern der Logging-Konfiguration kann sich auf die Performance der Anwendung auswirken und bei Änderungen in einer Produktionsumgebung ist besondere Vorsicht geboten.

Die Standardkonfiguration schreibt Logeinträge der Stufe „Information“ und höher (einschließlich „Warning“, „Error“ und „Fatal“) in eine Logdatei. Logdateien werden in das Verzeichnis geschrieben, das für die „LogsFolder“-Einstellung in der „appsettings.json“-Datei angegeben ist. Typischerweise ist dies festgelegt auf „./Logs_{Anwendung}“, beispielsweise „./Logs_Hub“ oder „./Logs_Interact“.

Die standardmäßigen Logging-Konfigurationseinstellungen in der Datei appsettings.json sind:

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

Separate Logdateien werden basierend auf der Logstufe und dem Datum generiert und diese werden in die Logdateinamen aufgenommen, zum Beispiel „warns.2021-05-07“ oder „infos.2021-05-07“.

Es folgt ein Beispiel für eine Zeile in einer Information-Logdatei:

[08:58:11.4549] Connect.Core.Actions.UpdateCacheAction – Cache für Widgets wurde aktualisiert

Das Format dieses Texts enthält die folgenden Elemente:

  • Zeit (unter Verwendung der auf dem Server eingestellten Zeitzone) – Das Datum ist im Dateinamen enthalten.
  • Logger-Name – Identifiziert normalerweise die Klasse und den Namespace, aus dem der Logeintrag stammt.
  • Die Lognachricht.
  • Fehlerinformationen – nur verfügbar, wenn Ausnahmeinformationen protokolliert werden. Die vollständigen Details werden in einer separaten Zeile unter der Lognachricht protokolliert.

Zusätzliche Logging-Konfiguration

Blue Prism hat zusätzliche Logging-Konfigurationseinstellungen entwickelt, die der jeweiligen „appsettings.json“-Datei hinzugefügt werden können, um Aktivitäten bestimmter Komponenten zu erfassen.

Debugging von LDAP

Sie können das Logging so konfigurieren, dass es beim Debugging von Problemen hilft, die bei der Synchronisierung von Hub mit LDAP auftreten können. Sie müssen das Logging in der Datei appsettings.json von Authentication Server einrichten, bevor Sie die Benutzer in der Hub Benutzeroberfläche synchronisieren.

  1. Navigieren Sie auf dem Server zum Ordner „Authentication Server“. Standardmäßig befindet er sich in C:\Programme (x86)\Blue Prism\.
  2. Öffnen Sie die Datei „appsettings.json“ in einem Texteditor.

  3. Suchen Sie den Abschnitt „Logging“ und fügen Sie "ImsServer.IntegrationServices.Services.LdapConnectionService": "Debug" zum Abschnitt „LogLevel“ hinzu und setzen Sie am Ende der obigen Zeile ein Komma ein. Zum Beispiel:

    Kopieren 
    "Logging": {
          "LogsFolder": "./Logs_AuthenticationServer",
          "LogLevel": {
            "Default": "Information",
            "System": "Warning",
            "Microsoft": "Warning",
            "ImsServer.IntegrationServices.Services.LdapConnectionService": "Debug"
          }
        },
  4. Speichern Sie die Datei.

  5. Recyceln Sie den Authentication Server Pool in den IIS-Anwendungspools.

    Wenn Sie ein Upgrade von einer Version vor 4.3 durchgeführt haben, müssen Sie den IMS-Pool recyceln.

  6. Starten Sie die Authentication Server Site in den IIS-Sites neu.

Dadurch wird eine Datei mit dem Präfix „debug“ und dem entsprechenden Datum im Verzeichnis „Logs_AuthenticationServer“ erstellt.

Nachdem Sie mit den Debugging-Informationen die Probleme erfolgreich gelöst haben, müssen Sie die hinzugefügte Zeile und das Komma entfernen, die Datei speichern und die Schritte 5 und 6 wiederholen. Andernfalls wird die Größe der Logdatei deutlich zunehmen und möglicherweise den Speicher füllen.

Log-Gatherer-Service

Dieser Windows-Dienst entfernt alte Produktlogs von der jeweiligen Webserver-Komponente (Hub, Interact, Authentication Server , Audit Service, Audit Service Listener, Email Service, Log-Gatherer-Service, IADA, Interact Remote API, SignalR, Manager für die Formularübermittlung). Dies geschieht jeweils am 7. des Monats und die Logs werden in C:\Programme (x86)\Blue Prism\ArchivedLogs verschoben.

Sie können den Pfad für archivierte Logdaten und das Zeitplanerdatum in apppsettings.json ändern – unter „ArchivedFolder“ in C:\Programme (x86)\Blue Prism\Log Service (Standard) können Sie den Archivpfad und unter „DayOfMonth“ das Zeitplanerdatum ändern.

Weitere Informationen

Die folgenden Links können weitere nützliche Informationen liefern: