Konfigurieren der Log-Dateien zur Fehlersuche - Hyland Desktop Host Installation - Foundation 23.2 - Foundation 23.2 - Ready - Content Composer - external

Content Composer Hyland Desktop Host Installation

Platform
Content Composer
Product
Hyland Desktop Host Installation
Release
Foundation 23.2
License

Desktop Host ist standardmäßig so konfiguriert, dass Diagnosemeldungen an Log-Dateien gesendet werden, die der technische Support zur Diagnose und Fehlerbehebung verwenden kann. Dieser Abschnitt beschreibt, wie Sie Desktop Host unter Windows so konfigurieren, dass zusätzliche Informationen an die Standard-Logdateien gesendet werden, und wie Sie die Standard-Loggingkonfiguration ändern können.

Um das Desktop Host Logging in Windows zu konfigurieren, führen Sie foilgende Schritte aus:

  1. Öffnen Sie die Datei config.json in einem Texteditor mit erweiterten Rechten. In einer Standardinstallation befindet sich die Datei im Verzeichnis C:\ProgramData\Hyland\DesktopHost\bin.
  2. Suchen Sie in der Datei innerhalb des Hyland.Logging-Elements nach DesktopHostGateway_Log. Standardmäßig enthält die Route die folgenden Schlüssel- und Wertelemente, die Sie bei Bedarf bearbeiten können:
    "DesktopHostGateway_Log":{
       "File":"%ProgramData%/Hyland/DesktopHost/logs/DesktopHostGateway_Log.json",
       "minimum-level":"Information",
       "FileRollInterval":"Day",
       "FileByteLimit":"10000000",
       "FileCountLimit":"30",
       "FileRollOnSize":"true",
       "OutputFormat":"Json",
       "include-profiles": "Desktop Host Gateway"
    }
  3. Für den Schlüssel "File" ersetzen Sie "%ProgramData%/Hyland/DesktopHost/logs/DesktopHostGateway_Log.json" durch den Dateipfad der Log-Datei, einschließlich des Dateinamens, unter dem die Log-Datei gespeichert werden soll. Diese Datei muss eine .json Datei sein.

    Zum Beispiel würde der oben genannte Standardpfad die Protokolle in eine Datei namens DesktopHostGateway_Log<date-stamp>.json im Verzeichnis logs innerhalb des Verzeichnisses schreiben, in dem Desktop Host installiert ist.

    Anmerkung: Stellen Sie sicher, dass das Windows-Benutzerkonto, auf dem Desktop Host läuft, Schreibberechtigung für das im Schlüssel "File" angegebene Verzeichnis hat.
  4. Ändern Sie für den Schlüssel "minimum-level" den Wert auf die niedrigste Sicherheitsstufe, für die Sie in der Log-Datei Einträge erhalten wollen. Die folgenden Log-Level sind verfügbar. sortiert von der höchsten zur niedrigsten Stufe:
    Anmerkung: Die Namen der Log-Level sind case-sensitive.
    Log Level Beschreibung

    Critical

    Log-Einträge, die eine nicht wiederherstellbare Anwendung, einen Systemabsturz oder einen schwerwiegenden Fehler beschreiben, die sofortige Aufmerksamkeit erfordern.

    Error

    Log-Einträge, die protokollieren, wenn der aktuelle Ablauf aufgrund eines Fehlers gestoppt wird. Diese Einträge weisen auf einen Fehler im aktuellen Ablauf hin, jedoch nicht auf einen anwendungsweiten Fehler.

    Warning

    Log-Einträge, die ein anormales oder unerwartetes Ereignis im Ablauf protokollieren, aber nicht zum Beenden der Anwendung führen.

    Information

    Log-Einträge, die den allgemeinen Ablauf der Anwendung protokollieren.

    Debug

    Log-Einträge, die zur interaktiven Analyse während der Entwicklung verwendet werden.

    Trace

    Diese Log-Einträge enthalten die detailliertesten Meldungen und können sensible Daten enthalten. Dieses Log-Level sollte niemals in einer Produktionsumgebung aktiviert werden.

    None

    Dieses Log-Level erzeugt keine Einträge.

    Beispielsweise könnte die Route so bearbeitet werden, dass sie das folgende Attribut enthält:

    "minimum-level": "Information",

    Dieses Beispiel definiert, dass nur Meldungen des Levels Information bzw. höher Levels protokolliert werden.

    Anmerkung: Das Standard-Level einer Route ist mindestens Information und höchstens Critical. Die Route verwendet diese Level, wenn die installierte Datei config.json keinen minimum-level Eintrag enthält.
  5. Ändern Sie den Wert des Schlüssels "FileRollInterval", um das Intervall, nach welchem eine neue Log-Datei erstellt werden soll, anzugeben. Die folgenden Intervalle sind verfügbar:
    Interval Beschreibung

    Minute

    Es wird jede Minute eine neue Log-Datei erstellt.

    Hour

    Es wird jede Stunde eine neue Log-Datei erstellt.

    Day

    Es wird jeden Tag eine neue Log-Datei erstellt.

    Month

    Es wird jeden Monat eine neue Log-Datei erstellt.

    Year

    Es wird jedes Jahr eine neue Log-Datei erstellt.

    Infinite

    Es wird nie eine neue Log-Datei erstellt.

  6. Im Wert des Schlüssels "FileByteLimit" können Sie die maximale Größe in Bytes für eine Log-Datei festlegen, bei der eine neue Datei erstellt wird. Dieses Attribut ist nur aktiv, wenn der Wert des Schlüssels "FileRollOnSize" auf "true" gesetzt ist.
  7. Im Wert des Schlüssels "FileCountLimit" können Sie die Anzahl der Log-Dateien angeben, die erstellt werden, bevor die älteste Datei gelöscht wird. Wenn Sie ältere Dateien nicht löschen möchten, setzen Sie den Wert auf "null".
  8. Ändern Sie den Wert des Schlüssels "FileRollOnSize" auf "true", wenn eine neue Log-Datei erstellt werden soll, sobald die aktuelle Protokolldatei die maximale Größe in Bytes erreicht hat. Wenn Sie keine neuen Dateien auf Basis der Dateigröße erstellen möchten, setzen Sie den Wert auf "false".
    Anmerkung: Wenn "FileRollOnSize" auf "true" gesetzt ist, ist das Attribut "write-to:File.fileSizeLimitBytes" aktiv.
  9. Für den Schlüssel "OutputFormat" können Sie die Struktur jeder Nachricht angeben, die in die Log-Datei geschrieben werden würde. Die folgenden Formate sind verfügbar:
    Format Beschreibung

    Minimal

    Meldung, die nur die Zeit, das Log-Level, die Exception und das Meldungsfeld enthält.

    Text

    Meldung, die alle möglichen Felder als Liste von Schlüssel-Werte-Paaren enthält.

    Json

    Meldung, die Felder in einem kompakten JSON-Format in einer einzigen Zeile enthält. Dieses Format ist ideal für die Weiterverarbeitung in einem SIEM (Security Information and Event Management) oder zum Auslesen mit der Diagnostics Console.

  10. Suchen Sie in der Datei innerhalb des Hyland.Logging-Elements nach DesktopHostCore_Log. Standardmäßig enthält die Route die folgenden Schlüssel- und Wertelemente, die Sie bei Bedarf bearbeiten können:
    "DesktopHostCore_Log":{
       "File":"%LocalAppData%/Hyland/DesktopHost/logs/
    DesktopHostCore_Log.json",
       "minimum-level":"Information",
       "FileRollInterval":"Day",
       "FileByteLimit":"10000000",
       "FileCountLimit":"30",
       "FileRollOnSize":"true",
       "OutputFormat":"Json"
       "include-profiles":"Desktop Host Core"
    }
  11. Für den Schlüssel "File" ersetzen Sie "%LocalAppData%/Hyland/DesktopHost/logs/DesktopHostCore_Log.json" durch den Dateipfad der Log-Datei, einschließlich des Dateinamens, unter dem die Log-Datei gespeichert werden soll. Diese Datei muss eine .json Datei sein.
    Zum Beispiel würde der oben genannte Standardpfad die Protokolle in eine Datei namens DesktopHostCore_Log<date-stamp>.json im Verzeichnis logs innerhalb des für einen Benutzer angelegten Verzeichnisses schreiben.
    Anmerkung: Stellen Sie sicher, dass das Windows-Benutzerkonto, auf dem Desktop Host läuft, Schreibberechtigung für das im Schlüssel "File" angegebene Verzeichnis hat.
  12. Bearbeiten Sie die anderen Schlüssel- und Wertepaare in der Diagnoseroute DesktopHostCore_Log wie benötigt.
    Anmerkung: Stellen Sie sicher, dass der Schlüssel "include-profiles" den Wert "Desktop Host Core" enthält.
  13. Suchen Sie in der Datei innerhalb des Hyland.Logging-Elements nach DesktopHostLauncher_Log. Standardmäßig enthält die Route die folgenden Schlüssel- und Wertelemente, die Sie bei Bedarf bearbeiten können:
    "DesktopHostLauncher_Log":{
       "File":"%LocalAppData%/Hyland/DesktopHost/logs/
    DesktopHostLauncher_Log.json",
       "minimum-level":"Information",
       "FileRollInterval":"Day",
       "FileByteLimit":"10000000",
       "FileCountLimit":"30",
       "FileRollOnSize":"true",
       "OutputFormat":"Json"
       "include-profiles":"Desktop Host Launcher"
    }
  14. Für den Schlüssel "File" ersetzen Sie "%LocalAppData%/Hyland/DesktopHost/logs/DesktopHostLauncher_Log.json" durch den Dateipfad der Log-Datei, einschließlich des Dateinamens, unter dem die Log-Datei gespeichert werden soll. Diese Datei muss eine .json Datei sein.
    Zum Beispiel würde der oben konfigurierte Standardpfad die Protokolle in eine Datei namens DesktopHostLauncher_Log<date-stamp>.json im Verzeichnis logs innerhalb des für einen Benutzer angelegten Verzeichnisses schreiben.
    Anmerkung: Stellen Sie sicher, dass das Windows-Benutzerkonto, auf dem Desktop Host läuft, Schreibberechtigung für das im Schlüssel "File" angegebene Verzeichnis hat.
  15. Bearbeiten Sie die anderen Schlüssel- und Wertepaare in der Diagnoseroute DesktopHostLauncher_Log wie benötigt.
    Anmerkung: Stellen Sie sicher, dass der Schlüssel "include-profiles" den Wert "Desktop Host Launcher" enthält.
  16. Speichern Sie die Datei und schließen Sie den Texteditor.
  17. Starten Sie den Computer neu.