Speichern von Roboterprotokollen in Elasticsearch

Das Speichern von Roboterprotokollen auf einem Elasticsearch-Server kann über zwei Konfigurationstypen erfolgen: einfach und erweitert.

Die Basiskonfiguration bietet Standardfunktionen, die das vorkonfigurierte Elasticsearch NLog-Ziel aktivieren, das aus einem Elasticsearch-Ziel besteht, das in ein Pufferungsziel eingeschlossen ist. Diese Art der Konfiguration ist in den meisten Szenarien ausreichend.

Wenn Sie die Regeln jedoch weiter anpassen müssen, können Sie die erweiterte Konfigurationsmethode verwenden.

Hinweis: Die Option zum Speichern von Roboterprotokollen auf einem Elasticsearch-Server wird erst nach dem Konfigurieren wirksam und nicht rückwirkend angewandt. Das bedeutet, dass Sie keinen Zugriff mehr auf Protokolle haben, die sich zum Zeitpunkt des Konfigurierens der Option bereits in der Datenbank befanden, da Protokolle nur von einem einzigen Ziel abgerufen und angezeigt werden können.

Grundlegende Elasticsearch-Konfiguration des Roboterprotokolls

Führen Sie die folgenden Schritte aus, um die grundlegende Konfiguration anzuwenden. Weitere Informationen finden Sie unter Konfigurieren der Orchestrator-Parameter.

1. Fügen Sie in der Konfigurationsdatei einen neuen Abschnitt mit dem Namen orchestrator_robot_logs_elastic zur Orchestrator-Konfiguration hinzu, wie im folgenden Beispiel gezeigt:

   "orchestrator": {
       "enabled": true,
       "orchestrator_robot_logs_elastic": {
           "elastic_uri": "https://elastic.example.com:9200",
           "elastic_auth_username": "elastic-user",
           "elastic_auth_password": "elastic-password"
       }
   }

2. Aktualisieren Sie die folgenden Parameter mit Ihren eigenen Werten:

   Parameter	Beschreibung
   elastic_uri	Die Adresse der Elasticsearch-Instanz, die verwendet werden muss. Sie müssen die Adresse als URI zusammen mit einem Benutzernamen und einem Kennwort angeben. Beispiel: https://elastic.example.com:9200. Stellen Sie sicher, dass Sie keinen abschließenden Schrägstrich einfügen.
   elastic_auth_username	Beispiel: elastic-user.
   elastic_auth_password	Beispiel: elastic-password.

Die Basiskonfiguration unterstützt Elasticsearch Version 7.x. Für Elasticsearch 8.x müssen Sie die erweiterte Konfiguration verwenden.

Erweiterte Konfiguration des Roboterprotokolls Elasticsearch

Wichtig: Alle Änderungen, die Sie gemäß den folgenden Schritten vornehmen, können sich negativ auf die Funktionalität und Stabilität des gesamten Systems auswirken. Es ist ratsam, nur Änderungen vorzunehmen, wenn Sie sich der Konsequenzen bewusst sind.

Mit der erweiterten Konfiguration können Sie Ihr NLog.config -Ziel vollständig anpassen.

1. Führen Sie die oben beschriebenen grundlegenden Konfigurationsschritte aus.
2. Folgen Sie den erweiterten NLog-Konfigurationsschritten und aktualisieren Sie dann das robotElasticBuffer-Ziel mit den Eigenschaften, die geändert werden müssen.

Hinweis:

Die erweiterte Konfiguration unterstützt auch Elasticsearch Version 8.x.

Beispiel nlog.config.json für Elasticsearch 7.x

{
  "Nlog": {
    "targets": {
      "robotElasticBuffer": {
        "flushTimeout": 1000,
        "bufferSize": 1000,
        "slidingTimeout": false,
        "target": {
          "uri": "https://elastic.example.com:9200",
          "requireAuth": true,
          "username": "elastic-user",
          "password": "elastic-password",
          "index": "${event-properties:item=indexName}-${date:format=yyyy.MM}",
          "documentType": "logEvent",
          "includeAllProperties": true,
          "layout": "${message}",
          "excludedProperties": "agentSessionId,tenantId,indexName"
        }
      }
    }
  }
}

Beispiel nlog.config.json für Elasticsearch 8.x

{
  "Nlog": {
    "targets": {
      "robotElasticBuffer": {
        "flushTimeout": 1000,
        "bufferSize": 1000,
        "slidingTimeout": false,
        "target": {
          "uri": "https://elastic.example.com:9200",
          "requireAuth": true,
          "username": "elastic-user",
          "password": "elastic-password",
          "index": "${event-properties:item=indexName}-${date:format=yyyy.MM}",
          "documentType": "",
          "includeAllProperties": true,
          "layout": "${message}",
          "excludedProperties": "agentSessionId,tenantId,indexName"
        }
      }
    }
  }
}