Zum Inhalt springen

Private Agent-Überwachung mit Elasticsearch

Einführung

Diese Seite zeigt, wie Sie die Leistung und das Verhalten von Docker, Linux oder Windows privaten Agenten remote überwachen können, indem Sie die Elasticsearch und Kibana Observability-Plattform verwenden. Nach der Konfiguration können die Metriken Ihrer privaten Agenten über das von Jitterbit bereitgestellte vorgefertigte Dashboard oder Ihr eigenes benutzerdefiniertes Dashboard angezeigt werden.

Um Elasticsearch und Kibana einzurichten, befolgen Sie die Schritte in diesen Abschnitten der Reihe nach:

  1. Erfüllen Sie die Voraussetzungen.

  2. Installieren Sie die Metricbeat- und Filebeat-Agenten auf dem Host des privaten Agenten.

  3. Legen Sie die Kibana-Lebenszyklusrichtlinie fest.

  4. Erstellen Sie Kibana-Vorlagen.

  5. Konfigurieren Sie die Metricbeat- und Filebeat-Agenten.

  6. (Optional) Importieren Sie ein Dashboard.

Wenn Sie Probleme haben, konsultieren Sie den Fehlerbehebungsabschnitt oder kontaktieren Sie den Jitterbit-Support.

Voraussetzungen

Um Elasticsearch und Kibana zur Überwachung eines privaten Agenten-Hosts zu verwenden, müssen Sie Folgendes haben:

  • Privater Agent 11.37.0.7 oder höher installiert und ausgeführt.

  • Ein funktionierendes Elasticsearch- und Kibana-System, das installiert und konfiguriert ist. Um diese zu installieren, beziehen Sie sich auf die folgenden Seiten:

Installieren Sie die Metricbeat- und Filebeat-Agenten

Metricbeat und Filebeat sind Daten sammelnde Agenten, die Metriken des privaten Agenten an Ihr Elasticsearch/Kibana-System weiterleiten. Um sie zu installieren, befolgen Sie diese Schritte:

Konfigurieren der Metricbeat- und Filebeat-Agenten

Der Jitterbit-Private-Agent enthält ein Skript zur Konfiguration von Metricbeat und Filebeat. Um es bei der erstmaligen Installation oder beim Upgrade von einer Installation auf Basis des privaten Agenten 11.34 zu verwenden, befolgen Sie diese Schritte:

  1. Führen Sie Folgendes in einem Terminal oder PowerShell aus:

    cd /opt/jitterbit/scripts/
    ./configure_elasticsearch.sh
    
    cd /opt/jitterbit/scripts/
    ./configure_elasticsearch.sh
    
    cd "C:\Program Files\Jitterbit Agent\scripts\"
    .\configure_elasticsearch.ps
    
  2. Lesen Sie die folgenden Eingabeaufforderungen und antworten Sie darauf:

    1. Eingabeaufforderung 1:

      *************
      ***WARNING***
      *************
      Installing the metric configurations will backup and overwrite your metricbeat configuration files.
      Do you wish to proceed?
      1) Yes
      2) No
      

      Geben Sie die Nummer ein, die Ihrer Wahl entspricht, gefolgt von der Enter-Taste. Die Optionen sind wie folgt:

      • 1: Fahren Sie mit dem Skript fort. Wenn Sie vorhandene Konfigurationsdateien für Metricbeat und Filebeat (/etc/metricbeat/metricbeat.yml und /etc/filebeat/filebeat.yml) haben, werden Sicherungskopien erstellt (/etc/metricbeat/metricbeat.yml.jb.bak und /etc/filebeat/filebeat.yml.jb.bak) und neue werden erstellt.

      • 2: Stoppen Sie das Skript.

    2. Eingabeaufforderung 2:

      *************
      ***WARNING***
      *************
      Turning on Agent observability on the agent will turn on Enhanced Capability feature for the agent.
      Enhanced Capability might affect the operation routing behavior for the agents.
      Do you wish to proceed?
      1) Yes
      2) No
      

      Geben Sie die Zahl ein, die Ihrer Wahl entspricht, gefolgt von der Enter-Taste. Die Auswahlmöglichkeiten sind wie folgt:

Hinweis

Um die Beobachtbarkeit in privaten Docker-Agenten zu aktivieren, müssen Sie Umgebungsvariablen verwenden.

Legen Sie die Lebenszyklusrichtlinie für den Kibana-Index fest

Um die Datenaufbewahrungsrichtlinie festzulegen, befolgen Sie diese Schritte:

  1. Öffnen Sie Ihre Kibana-Webkonsole.

  2. Geben Sie index lifecycle policies in die Suchleiste ein und wählen Sie dann die resultierende Seite aus.

  3. Klicken Sie auf die Schaltfläche Richtlinie erstellen.

  4. Im Dialogfeld Richtlinie erstellen legen Sie die folgenden Werte fest:

    • Richtlinienname: private-agent-metrics-policy
  5. Aktivieren Sie den Schalter Warmphase und legen Sie dann die folgenden Werte fest:

    • Daten in die Phase verschieben, wenn: 30 Tage alt.
  6. Aktivieren Sie den Schalter Kaltphase und legen Sie dann die folgenden Werte fest:

    • Daten in die Phase verschieben, wenn: 90 Tage alt.
  7. Klicken Sie auf die Schaltfläche Richtlinie speichern und schließen Sie dann die Zusammenfassungsansicht.

Erstellen Sie Kibana-Vorlagen

Um Vorlagen zu erstellen, befolgen Sie diese Schritte:

  1. Erstellen Sie die private-agent-metric-template-Vorlage:

    1. Geben Sie index management in die Suchleiste ein und wählen Sie dann die resultierende Seite aus.

    2. Wählen Sie die Registerkarte Indexvorlagen.

    3. Klicken Sie auf die Schaltfläche Vorlage erstellen.

    4. Auf der Seite Logistik geben Sie Werte für die folgenden Felder ein:

      • Name: private-agent-metric-template

      • Indexmuster: private-agent-metric-8.15-*

    5. Klicken Sie auf die Schaltfläche Weiter .

    6. Auf der Seite Komponenten-Vorlagen klicken Sie auf die Schaltfläche Weiter .

    7. Auf der Seite Indexeinstellungen ersetzen Sie den Inhalt des Feldes Indexeinstellungen durch Folgendes:

      {
        "index": {
          "lifecycle": {
            "name": "private-agent-metrics-policy",
            "rollover_alias": "private-agent-metric-alias"
          },
          "number_of_shards": "1",
          "number_of_replicas": "1"
        }
      }
      
    8. Klicken Sie auf die Schaltfläche Weiter .

    9. Auf der Seite Mappings, im Tab Zuordnete Felder, fügen Sie Felder gemäß der folgenden Tabelle hinzu. Klicken Sie nach jedem Eintrag auf die Schaltfläche Feld hinzufügen:

      Feldtyp Feldname
      Keyword fields.env
      Keyword private-agent.group
      Keyword private-agent.name
    10. Wählen Sie den Tab Erweiterte Optionen und setzen Sie die folgenden Schalter auf Ein:

      • Numerische Zeichenfolgen als Zahlen zuordnen

      • Datumszeichenfolgen als Daten zuordnen

    11. Klicken Sie auf die Schaltfläche Weiter .

    12. Auf der Seite Aliases klicken Sie auf die Schaltfläche Weiter .

    13. Auf der Seite Details überprüfen klicken Sie auf die Schaltfläche Vorlage erstellen, und schließen Sie dann die Zusammenfassungsansicht.

  2. Erstellen Sie die Vorlage private-agent-filebeat-template:

    1. Auf dem Tab Indexvorlagen klicken Sie auf die Schaltfläche Vorlage erstellen.

    2. Auf der Seite Logistik geben Sie Werte für die folgenden Felder ein:

      • Name: private-agent-filebeat-template

      • Indexmuster: private-agent-filebeat-8.15-*

    3. Klicken Sie auf die Schaltfläche Weiter .

    4. Auf der Seite Komponenten-Vorlagen klicken Sie auf die Schaltfläche Weiter .

    5. Auf der Seite Indexeinstellungen ersetzen Sie den Inhalt des Feldes Indexeinstellungen durch Folgendes:

      {
        "index": {
          "lifecycle": {
            "name": "private-agent-metrics-policy",
            "rollover_alias": "private-agent-metric-alias"
          },
          "number_of_shards": "1",
          "number_of_replicas": "1"
        }
      }
      
    6. Klicken Sie auf die Schaltfläche Weiter .

    7. Auf der Seite Mappings, im Tab Zuordnete Felder, fügen Sie Felder gemäß der folgenden Tabelle hinzu. Klicken Sie nach jedem Eintrag auf die Schaltfläche Feld hinzufügen:

      Feldtyp Feldname
      Keyword message.fields.environment_name
      Keyword message.fields.operation_name
      Keyword message.fields.project_name
      Keyword message.fields.status
      Keyword private-agent.group
      Keyword private-agent.name
    8. Wählen Sie die Registerkarte Erweiterte Optionen aus und setzen Sie die folgenden Schalter auf Ein:

      • Numerische Zeichenfolgen als Zahlen zuordnen

      • Datumszeichenfolgen als Daten zuordnen

    9. Klicken Sie auf die Schaltfläche Weiter .

    10. Auf der Seite Aliase klicken Sie auf die Schaltfläche Weiter .

    11. Auf der Seite Details überprüfen klicken Sie auf die Schaltfläche Vorlage erstellen, und schließen Sie dann die Zusammenfassungsansicht.

Importieren eines Elasticsearch-Dashboards

Um ein vorgefertigtes Elasticsearch-Dashboard zu importieren, befolgen Sie diese Schritte:

  1. Laden Sie die JSON-Datei Jitterbit Private Agent Elasticsearch-Dashboard von der Harmony-Portal-Seite Downloads herunter.

  2. Geben Sie kibana saved objects in die Elasticsearch-Suchleiste ein und wählen Sie die resultierende Seite aus.

  3. Klicken Sie auf die Schaltfläche Importieren.

  4. Im Dialogfeld Gespeicherte Objekte importieren klicken Sie auf Importieren, suchen Sie die heruntergeladene Dashboard-JSON-Datei und wählen Sie sie aus.

  5. Unter Importoptionen wählen Sie Nach vorhandenen Objekten suchen mit Konflikte automatisch überschreiben.

  6. Klicken Sie auf die Schaltfläche Importieren.

  7. Klicken Sie auf die Schaltfläche Fertig.

  8. Um das Dashboard zu verwenden, geben Sie dashboards in die Elasticsearch-Suchleiste ein, wählen Sie die resultierende Seite aus und wählen Sie dann Jitterbit Harmony Private Agent Dashboard aus.

Fehlerbehebung bei Elasticsearch-Problemen

Um bei Problemen mit Elasticsearch-Komponenten zu helfen, können Sie die Elasticsearch-Dokumentation überprüfen, Protokolldateien inspizieren oder Diagnosetools ausführen.

Elasticsearch-Dokumentation

Speicherorte der Elasticsearch-Protokolldateien

  • /var/log/metricbeat

  • /var/log/filebeat