REST-API (aktiv, Anwendung)

Mit der Komponente „Aktiver REST-API-Monitor“ kann der Monitor auf einem bestimmten Gerät ausgeführt werden. Dadurch erhalten Sie Informationen über den Status des Geräts, Servers oder der Anwendung, indem ausgewertet wird, ob der Monitor erreichbar ist oder nicht.

So fügen Sie einen aktiven REST-API-Monitor als Komponente zu einer vorhandenen Anwendung hinzu:

Klicken Sie auf Einstellungen > Anwendungsüberwachung > Einrichtung von Anwendung und Profil.
Fügen Sie gemäß der Anleitung unter Arbeiten mit Anwendungsprofilen ein Anwendungsprofil hinzu.
Fügen Sie gemäß der Anleitung unter Komponenten, kritische Komponentengruppen und diskrete Anwendungen eine Komponente hinzu.
Klicken Sie im Dialogfeld „Anwendungsprofil bearbeiten“ auf die Registerkarte „Komponenten“. Klicken Sie dann auf das Symbol „Hinzufügen“, um eine neue Komponente hinzuzufügen.
Wählen Sie als Namen der Komponente REST-API > REST-API (aktiv) aus.
Konfigurieren Sie im Komponenteneditor folgende Felder:
- Name. Geben Sie der Komponente einen eindeutigen Namen. Dieser Name wird unter „Leistungskomponenten“ im Editor für Anwendungsprofile angezeigt.
- Description. Geben Sie zusätzliche Informationen zur Komponente ein.
- Kritisch. Aktivieren, wenn es sich um eine kritische Komponente handelt.
- Geräteausnahme. Aktivieren, wenn ein Gerät diese Komponente außer Kraft setzen darf.
- Abfrageintervall. Legt das Intervall ab, in dem die Komponente geprüft wird.
- Verbindungs-Timeout. Die Länge der Anfrage, bevor eine Zeitüberschreitung gemeldet wird.
- REST-API. Geben Sie die URL für den REST-API-Endpunkt der Komponente ein.
Note: Als URL für die REST-API werden Referenzvariablen (auch Prozentvariablen genannt) für das System (%System), das Gerät (%Device) und die Anwendung (%Application) unterstützt. Weitere Informationen finden Sie unter Prozentvariablen. Der Ausdruck wird jedoch als falsch ausgewertet, wenn ein Test vorgenommen wird. Es wird empfohlen sicherzustellen, dass die REST-API eine gültige Antwort ausgibt, bevor der Ausdruck in Parameter umgewandelt und einem Gerät zugewiesen wird.
- Benutzerdefinierte Kopfzeilen bearbeiten. Es können bis zu zehn benutzerdefinierte Kopfzeilen, die zum Zugriff auf den REST-API-Endpunkt erforderlich sind, eingegeben werden. Eine Standard-ACCEPT-Kopfzeile wird bereitgestellt und als application/json angegeben.
Note: Zur Überwachung eines REST-API-Endpunkts von Progress Application Server für OpenEdge OEManager muss die ACCEPT-Kopfzeile auf application/vnd.progress+json oder */* gesetzt werden.
- Methode. Wählen Sie eine unterstützte HTTP-Methode für den REST-API-Endpunkt aus. Derzeit wird nur die GET-Methode unterstützt.
- Zertifikatfehler ignorieren. Aktivieren Sie dieses Kontrollkästchen, wenn WhatsUp Gold alle Zertifikatsfehler ignorieren soll.
- Anonymen Zugriff verwenden. Aktivieren Sie dieses Kontrollkästchen, wenn für den REST-API-Endpunkt keine Authentifizierung erforderlich ist.
- JSONPATH. Geben Sie den Pfad zum JSON-Objekt ein, das überwacht werden soll, oder stellen Sie mit dem JSON-Pfadassistenten sicher, dass der Pfad zum zu überwachenden Objekt stimmt.
Note: Weitere Informationen zu JSONPath und dem JSON-Pfadassistenten finden Sie unter JSONPath-Abfragen und JSON-Pfadassistent.
- JSON-Pfadassistent. Nach der Eingabe eines gültigen REST-API-URL-Endpunkts können Sie mit dem JSON-Pfadassistenten die Struktur der JSON-Antwort anzeigen. Wählen Sie den JSON-Wert aus, der überwacht werden soll.
- Bedingung für „Nicht erreichbar“. Dieser Monitor gilt als nicht erreichbar, wenn einer der aufgeführten HTTP-Antwortcodes ausgegeben wird. Sie können einstellen, welche Antwortcodes die Nichterreichbarkeit des Monitors anzeigen. Sie können ebenfalls eine JSONPATH-Abfrage mit Bedingungen angeben, die die Nichterreichbarkeit des Monitors anzeigen. Der Monitor kann entweder aufgrund einer Bedingung für „Nicht erreichbar“, einer JSONPath-Abfrage oder beides eine Antwort „Nicht erreichbar“ ausgeben.
- JSONPath-Abfrage. Konstruieren Sie einen logischen Test zur Bewertung der Bedingungen, die der REST-API-Endpunkt ausgibt:
1. Klicken Sie auf das Symbol „Hinzufügen“, um einen Bedingungstest mit einer JSONPATH-Abfrage einzugeben. In der Standardeinstellung wird „Kein Vergleich eingestellt“ in der Zeile anzeigt.
2. Doppelklicken Sie in das Eingabefeld für die JSONPath-Abfrage und klicken Sie anschließend auf das Lupensymbol. Anschließend werden Sie zur Eingabe von REST-API-Anmeldeinformationen aufgefordert, wenn „Anonymen Zugriff verwenden“ nicht aktiviert ist. Nachdem die Anmeldeinformationen für die REST-API geprüft wurden, wird das Fenster mit dem JSON-Pfadassistenten geöffnet.
3. Wählen Sie den REST-API-Endpunkt aus, der überwacht werden soll.
4. Erstellen Sie einen logischen Test, der eine „Nicht erreichbar“-Bedingung für die Überwachung des REST-API-Endpunkts darstellt. Als Werttypen werden Boolesche Werte, Zahlen, Zeichenketten und Andere unterstützt. Der Datentyp „Andere“ wird verwendet, wenn ein Wert Null ist. Leere Zeichenketten werden unterstützt.
5. Klicken Sie auf Speichern.
Klicken Sie auf Testen, um die REST-API auszuführen.
Klicken Sie auf OK, um den Komponenteneditor zu schließen.

So fügen Sie diese Komponente zu einem vorhandenen Anwendungsprofil auf einem Gerät hinzu:

Öffnen Sie „Überwachte Anwendung“ und klicken Sie auf das Symbol „Hinzufügen“.
Fügen Sie das erstellte Anwendungsprofil sowie das Gerät hinzu, an welches das Anwendungsprofil angehängt werden soll.
Konfigurieren Sie die anderen Felder nach Bedarf.
Klicken Sie auf Speichern.

Der Komponententest wird auf dem Gerät ausgeführt.