Zum Inhalt springen

Private Agent-Überwachung mit Datadog

Einführung

Diese Seite zeigt, wie Sie die Leistung und das Verhalten von Docker, Linux oder Windows privaten Agenten aus der Ferne mit der Datadog Observability-Plattform überwachen können. Nach der Konfiguration können die Metriken Ihrer privaten Agenten mit dem von Jitterbit bereitgestellten vorgefertigten Dashboard oder Ihrem eigenen benutzerdefinierten Dashboard angezeigt werden.

Um Datadog einzurichten, folgen Sie der Reihenfolge in diesen Abschnitten:

  1. Erfüllen Sie die Voraussetzungen.

  2. Installieren Sie den Datadog-Agenten auf dem Host des privaten Agenten.

  3. Konfigurieren Sie den Datadog-Agenten.

  4. Konfigurieren Sie die Datadog-Metriken.

  5. (Optional) Importieren Sie ein Datadog-Dashboard.

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

Voraussetzungen

Sie müssen Folgendes haben:

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

  • Ein Datadog-Konto.

  • Ein Superuser (root) Konto unter Linux oder ein Administratorkonto unter Windows.

    Wichtig

    Führen Sie alle Befehle auf dieser Seite als dieser Benutzer aus.

  • Einen gültigen RFC 1123-Hostname für den Host, auf dem der private Agent ausgeführt wird.

  • Zusätzliche Anforderungen für Docker-private Agenten:

Installieren Sie den Datadog-Agenten

Um den Datadog-Agenten auf einem Host des privaten Agenten zu installieren, folgen Sie diesen Schritten:

  1. Melden Sie sich bei Ihrem Datadog-Konto an.

  2. Wählen Sie im Hauptmenü Integrationen > Flottenautomatisierung > Agenten installieren.

  3. Wählen Sie auf der Seite Plattform zum Installieren von Agenten auswählen die Plattform aus, auf der Ihr privater Agent läuft:

    Wählen Sie Host-basiert > Linux.

    Wählen Sie Host-basiert > Linux.

    Wählen Sie Host-basiert > Windows.

  4. Auf der Seite Installieren Sie den Datadog-Agenten auf gibt es diese drei Abschnitte:

    • ① Passen Sie Ihre Beobachtungsabdeckung an: Aktivieren Sie die erforderlichen Funktionen und wählen Sie ein Umgebungs-Tag aus.

    • ② Führen Sie den Installationsbefehl aus:

      1. Klicken Sie auf die Schaltfläche API-Schlüssel auswählen. Der Dialog API-Schlüssel auswählen öffnet sich.

      2. Wählen Sie einen API-Schlüssel aus der Liste aus und klicken Sie dann auf die Schaltfläche API-Schlüssel verwenden.

        Wenn Sie keinen Schlüssel haben, klicken Sie auf die Schaltfläche Neu erstellen, um einen zu erstellen.

      3. Öffnen Sie eine Konsole (Terminal oder PowerShell) auf dem privaten Agenten-Host. Kopieren Sie den Codeblock und fügen Sie ihn in die Konsole ein.

      4. Führen Sie Folgendes aus:

        1. Fügen Sie eine Zeile hinzu, um den Wert für die Umgebungsvariable DD_HOSTNAME auf den Hostnamen des privaten Agenten festzulegen.

        2. Ändern Sie install_script_agent7.sh in install_script_agent6.sh.

          (Derzeit unterstützt der Jitterbit private Agent nur die Datadog-Agent-Version 6.)

        3. Ihr Befehl sollte so aussehen, mit Ihrem eigenen API-Schlüssel (Zeile 1), Hostnamen des privaten Agenten (Zeile 3) und bearbeitetem curl-Argument (Zeile 4):

          1
          2
          3
          4
          DD_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \
          DD_SITE="datadoghq.com" \
          DD_HOSTNAME="hostname" \
          bash -c "$(curl -L https://install.datadoghq.com/scripts/install_script_agent6.sh)"
          
        4. Drücken Sie Enter, um die Befehle auszuführen.

        Drücken Sie Enter, um die Befehle auszuführen.

        Drücken Sie Enter, um die Befehle auszuführen.

    • ③ Bestätigen Sie die Agenteninstallation: Wenn Sie den Datadog-Agenten auf Ihrem privaten Agenten-Host installiert und ausgeführt haben, warten Sie eine Weile, bis er in diesem Panel erscheint, bevor Sie fortfahren.

  5. (Nur Docker) Erstellen Sie eine Standard-Sicherheitsdatei für den Datadog-Agenten:

    Nach der Installation kann der Datadog-Agent aufgrund eines bekannten Datadog-Problems nicht gestartet werden. Um dies zu beheben, erstellen Sie eine Kopie der Beispiel-Sicherheitsagentendatei, bevor Sie mit dem nächsten Abschnitt fortfahren:

cp  /etc/datadog-agent/security-agent.yaml.example /etc/datadog-agent/security-agent.yaml

Keine Aktion erforderlich.

Keine Aktion erforderlich.

Konfigurieren des Datadog-Agenten

Die Jitterbit-Private-Agent-Software enthält ein Skript zur Konfiguration und zum Start des Datadog-Agenten. Sie können es bei der erstmaligen Installation oder beim Upgrade von einer Installation, die auf dem privaten Agenten 11.34 basiert, verwenden. Gehen Sie dazu wie folgt vor:

  1. Führen Sie Folgendes in einem Terminal oder PowerShell auf dem Host des privaten Agenten aus:

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

    1. Eingabeaufforderung 1:

      *************
      ***WARNING***
      *************
      Installing the metric configurations will backup and overwrite your datadog 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 eine vorhandene Datadog-Konfigurationsdatei (/etc/datadog-agent/datadog.yaml) haben, wird eine Sicherungskopie erstellt (/etc/datadog-agent/datadog.yml.jb.bak) und eine neue wird 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 Nummer ein, die Ihrer Wahl entspricht, gefolgt von der Enter-Taste. Die Optionen sind wie folgt:

    3. Eingabeaufforderung 3:

      Jitterbit agent needs to restart in order to load the new changes.
      Do you wish to restart now? This will stop any in progress operations
      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 fort, um den privaten Agenten hart zu stoppen und neu zu starten, starten Sie den Datadog-Agenten neu und beenden Sie dann das Skript. Um zu bestätigen, dass Ihr Datadog-Agent funktioniert, melden Sie sich bei Ihrem Datadog-Konto an und wählen Sie Integrationen > Flottenautomatisierung im Hauptmenü aus.

      • 2: Beenden Sie das Skript, ohne den privaten Agenten oder den Datadog-Agenten neu zu starten. Sie sollten sowohl den privaten Agenten als auch den Datadog-Agenten nach Belieben neu starten.

Wichtig

Unter Docker startet der Datadog-Agent nicht automatisch mit dem Host. Sie müssen ihn manuell mit dem folgenden Befehl starten:

sudo datadog-agent run

Konfigurieren von Datadog-Metriken

Erstellen von Facetten

Um Datadog-Facetten zu definieren, befolgen Sie diese Schritte:

  1. Wählen Sie Protokolle > Explorer.

  2. Filtern Sie im Feld Nach suchen Protokolle nach dem Host Ihres Agenten und dem JitterbitAgentMetric-Dienst mit dem folgenden String:

    host:<hostname> service:JitterbitAgentMetric

  3. (Optional) Überprüfen Sie, ob die Protokolle Ihres Agenten im JSON-Format vorliegen. Wählen Sie dazu einen aktuellen Protokolleintrag aus und überprüfen Sie, ob die Spalte INHALT eine im JSON-Format vorliegende Protokollnachricht enthält.

  4. Klicken Sie im Feld Suchfacetten auf die Schaltfläche Hinzufügen (Eine Facette hinzufügen). Der Dialog Facette hinzufügen öffnet sich.

  5. Geben Sie im Feld Pfad den unten angegebenen Text ein und klicken Sie dann auf die Schaltfläche Hinzufügen. Wiederholen Sie dies für jeden Punkt in der folgenden Liste:

    • @environment_id

    • @environment_name

    • @is_operation_over_schedule

    • @name

    • @operation_id

    • @operation_instance_guid

    • @operation_name

    • @organization_id

    • @project_guid

    • @project_name

    • @status

Erstellen eines berechneten Feldes

Um ein berechnetes Feld zu erstellen, befolgen Sie diese Schritte:

  1. Wählen Sie Protokolle > Explorer.

  2. Klicken Sie auf die Schaltfläche Hinzufügen und wählen Sie dann Berechnetes Feld. Der Dialog Ein berechnetes Feld erstellen öffnet sich.

  3. Setzen Sie Werte für die folgenden Felder:

    • Benennen Sie Ihr Feld: operation_duration_seconds

    • Definieren Sie Ihre Formel: @fields.duration_seconds

  4. Klicken Sie auf die Speichern-Schaltfläche.

Erstellen Sie eine Kennzahl

Um eine Kennzahl zu erstellen, befolgen Sie diese Schritte:

  1. Wählen Sie Protokolle > Explorer.

  2. Klicken Sie in der Suchfacetten-Leiste auf die Hinzufügen-Schaltfläche (Eine Facette hinzufügen). Der Dialog Facette hinzufügen öffnet sich.

  3. Wählen Sie die Kennzahl-Registerkarte.

  4. Geben Sie im Feld Pfad @operation_duration_seconds ein.

  5. Klicken Sie auf die Hinzufügen-Schaltfläche.

Erstellen Sie Betriebskennzahlen

Um Betriebskennzahlen zu definieren, wählen Sie Protokolle > Kennzahlen generieren, und folgen Sie dann für jede Betriebskennzahl den folgenden Schritten.

Erstellen Sie die Betriebskennzahl metric.operation.count.by.status
  1. Klicken Sie auf die Neue Kennzahl-Schaltfläche.

  2. Setzen Sie im Dialog Kennzahl generieren die Werte wie folgt:

    • Kennzahlname festlegen: metric.operation.count.by.status

    • Abfrage definieren: service:JitterbitAgentMetric @name:operation_log

  3. Klicken Sie auf das Gruppieren nach-Menü und klicken Sie dann auf jede der folgenden Optionen, um sie zur Liste hinzuzufügen:

    • @fields.operation_id

    • @fields.operation_name

    • @fields.status

    • @agentgroup

    • @host

  4. Klicken Sie auf die Kennzahl erstellen-Schaltfläche.

Erstellen Sie die Betriebskennzahl metric.operation.running.over.scheduled.interval
  1. Klicken Sie auf die Neue Kennzahl-Schaltfläche.

  2. Setzen Sie im Dialog Kennzahl generieren die Werte wie folgt:

    • Kennzahlname festlegen: metric.operation.running.over.scheduled.interval

    • Abfrage definieren: service:JitterbitAgentMetric @name:operation_running_over_scheduled_interval

  3. Klicken Sie auf das Gruppieren nach-Menü und klicken Sie auf jede der folgenden Optionen, um sie zur Liste hinzuzufügen:

    • @fields.operation_id

    • @fields.operation_name

    • @agentgroup

    • @host

  4. Klicken Sie auf die Schaltfläche Metrik erstellen.

Erstellen Sie die metric.operation.duration.seconds Betriebsmetrik
  1. Klicken Sie auf die Schaltfläche Neue Metrik.

  2. Im Dialogfeld Metrik generieren die Werte wie folgt festlegen:

    • Metrikname festlegen: metric.operation.duration.seconds

    • Abfrage definieren: service:JitterbitAgentMetric @name:operation_running_over_scheduled_interval

  3. Klicken Sie auf das Menü Gruppieren nach und klicken Sie auf jede der folgenden Optionen, um sie zur Liste hinzuzufügen:

    • @fields.operation_id

    • @fields.operation_name

    • @agentgroup

    • @host

  4. Klicken Sie auf die Schaltfläche Metrik erstellen.

Erstellen von Prozessmetriken

Um Prozessmetriken zu definieren, wählen Sie Infrastruktur > Prozesse, wählen Sie die Registerkarte Metriken verwalten und folgen Sie dann für jede Prozessmetrik den folgenden Schritten.

Erstellen Sie die proc.openginebyname.cpu.num_threads Prozessmetrik
  1. Klicken Sie auf die Schaltfläche Neue Metrik.

  2. Unter Abschnitt 1, Prozesse filtern, im Feld Nach filtern geben Sie command:JitterbitOperationEngineProc ein.

  3. Unter Abschnitt 2, Messen und Dimensionen auswählen, die Werte für die folgenden Felder festlegen:

    • Öffnen Sie das Menü Messen, und wählen Sie # von Threads.

    • Öffnen Sie das Menü Dimensionen, und wählen Sie name.

  4. Unter Abschnitt 4, Name, im Feld metric.name geben Sie openginebyname ein, um den Namen proc.openginebyname.cpu.num_threads zu erstellen.

  5. Klicken Sie auf die Schaltfläche Erstellen.

Erstellen Sie die proc.operationsengine.cpu.num_threads Prozessmetrik
  1. Klicken Sie auf die Schaltfläche Neue Metrik.

  2. Unter Abschnitt 1, Prozesse filtern, im Feld Nach filtern geben Sie command:JitterbitOperationEngineProc ein.

  3. Unter Abschnitt 2, Messen und Dimensionen auswählen, die Werte für die folgenden Felder festlegen:

    • Öffnen Sie das Measure-Menü und wählen Sie # of Threads.

    • Öffnen Sie das Dimensions-Menü und wählen Sie agentgroup.

  4. Geben Sie im Abschnitt 4, Name, im Feld metric.name operationsengine ein, um den Namen proc.operationsengine.cpu.num_threads zu erstellen.

  5. Klicken Sie auf die Schaltfläche Create.

Importieren eines Datadog-Dashboards

Um das vorgefertigte Datadog-Dashboard von Jitterbit zu importieren, befolgen Sie diese Schritte:

  1. Laden Sie die JSON-Datei des Jitterbit Private Agent Datadog-Dashboards von der Harmony-Portal-Seite Downloads herunter.

  2. Wählen Sie Dashboards > Neues Dashboard.

  3. Geben Sie im Dialogfeld Dashboard erstellen einen Namen im Feld Dashboard Name ein und klicken Sie dann auf die Schaltfläche New Dashboard.

  4. Klicken Sie auf die Schaltfläche Konfigurieren, und wählen Sie dann Dashboard-JSON importieren.

  5. Suchen Sie die heruntergeladene Dashboard-JSON-Datei und wählen Sie sie aus.

  6. Um das Dashboard zu verwenden, wählen Sie Dashboards > Dashboard-Liste, geben Sie Jitterbit Harmony Private Agent im Feld Dashboards suchen ein und wählen Sie das importierte Dashboard aus.

Datadog-Probleme beheben

Um Probleme mit Datadog zu lösen, können Sie die Datadog-Dokumentation überprüfen, Protokolldateien inspizieren oder Befehle ausführen, um Benutzer und Berechtigungen zu verwalten.

Datadog-Dokumentation

Datadog-Dateispeicherorte

Protokolldateien

Die Datadog-Protokolldateien befinden sich an folgendem Speicherort:

/var/log/datadog/

/var/log/datadog/

Öffnen Sie die Anwendung Datadog Agent Manager und wählen Sie dann die Registerkarte Log aus.

Konfigurationsdateien

Die Datadog-Konfigurationsdatei befindet sich an folgendem Speicherort:

/etc/datadog-agent/datadog.yaml

/etc/datadog-agent/datadog.yaml

Öffnen Sie die Anwendung Datadog Agent Manager und wählen Sie dann die Registerkarte Einstellungen aus.

In dieser Datei sollten Sie überprüfen, ob Sie die richtigen Werte für die folgenden Schlüssel haben:

  • api_key

  • site

  • $hostname

  • tags

Datadog-Benutzer und Berechtigungsbefehle

Um einen Datadog-Benutzer und eine Gruppe zu erstellen, führen Sie diese Befehle aus:

usermod -a -G root dd-agent
usermod -a -G jitterbit dd-agent

Um den Besitz der Datadog-Konfigurationsdatei festzulegen, führen Sie diese Befehle aus:

chown dd-agent:dd-agent /etc/datadog-agent/conf.d/logs.d/conf.yaml
chown dd-agent:dd-agent /etc/datadog-agent/conf.d/logs.d