Dieser Abschnitt unterstützt Softwareentwickler, die Anwendungen mithilfe von Dotcom-Monitor-Überwachungstools entwickeln möchten. Öffnen Sie ein Supportticket, um den Zugriff auf die Dotcom-Monitor-API über Ihre IP-Adressen zu ermöglichen.

Es gibt mehrere Möglichkeiten, Überwachungsdaten außerhalb der Dotcom-Monitor-Websiteoberfläche anzuzeigen und mit ihnen zu interagieren, einschließlich der Verwendung des XML-Feeds zum Verwenden von Daten und der Interaktion mit der Dotcom-Monitor-API zum Überwachen und Aktualisieren installierter Überwachungs-Agents.

Mit dem XML-Feed können Entwickler die gewünschten Daten abonnieren und in ihrem eigenen Format mithilfe ihrer eigenen benutzerdefinierten Berichte präsentieren. Weitere Informationen finden Sie unter Verwenden des XML Reporting Service (XRS)-Tools.

Die Dotcom-Monitor-API-Benutzer können ihre eigenen benutzerdefinierten Skripts oder Anwendungen erstellen, um mit den Einstellungen zu interagieren und die überwachten Daten in ihrer eigenen benutzerdefinierten Umgebung anzuzeigen. Unser System verwendet die REST-API, die die Interaktion mit der Dotcom-Monitor-Website programmgesteuert mit den beliebtesten Methoden zum Arbeiten mit Daten über HTTP(S)-Anforderungen (GET, POST, PUT, DELETE) ermöglicht. Nahezu alle Dotcom-Monitor-Objekte können über die REST API aufgerufen werden und fast jeder Aspekt der Dotcom-Monitor-Dienstfunktionalität kann verwaltet werden. Mithilfe von API-Aufrufen können die Entwickler Geräte und Aufgaben erstellen und entfernen, sie verschieben und starten, Warnungsgruppen, Vorlagen, Filter und Planer erstellen und verwalten, Gerätestatusinformationen sowie viele andere Optionen abrufen.

Im Allgemeinen kann die Dotcom-Monitor API in den folgenden Aufgaben verwendet werden:

  • Integration von Drittanbietern mit der Dotcom-Monitor Monitoring-Lösung.
  • Datendownload und Upload.
  • Datenänderung.

Die häufigsten Aktionen, die über die REST-API ausgeführt werden:

  • Zugriff auf Listen von Überwachungsplattformen, Geräten, Zielen, Planern, Standorten, Warngruppen, Filtern, Warnungsvorlagen.
  • Zugriff auf detaillierte Informationen zu Plattformen, Geräten und Zielen.
  • Bearbeiten von Geräten, Zielen, Planern, Warngruppen und Vorlagen, Filtern.
  • Erstellen eines neuen dotcom-Monitor-Objekts (Geräte, Ziele, Planer usw.).
  • Verwalten von Überwachungsobjekten.

Benutzerdefinierte Collector-API

Separate MetricsView API ist eine Reihe von Methoden zum Hochladen von Metriken aus jeder Quelle unabhängig von einer Plattform in Dotcom-Monitor inc. zur weiteren Verarbeitung und Analyse.

Die Dotcom-Monitor-API ist in 10 Ressourcentypen unterteilt:

  • Plattform: Alle Überwachungsaufgaben fallen in eine von fünf verschiedenen Plattformen.
  • Geräte: Ein überwachtes Gerät ist ein organisierter “Satz” von Überwachungsaufgaben, der entweder eine einzelne Überwachungsaufgabe, eine Abfolge von Überwachungsaufgaben, ein Überwachungsskript, das Aufgaben enthält, oder eine Kombination aus allen dreien enthält.
  • Aufgaben: Eine Aufgabe ist jede einzelne Überwachungsaktivität, z. B. die Überwachung eines Ziels (URL, Mail Server, FTP Server usw.).
  • Häufigkeit: Definiert, wie oft Überwachungssitzungen ausgeführt werden.
  • Scheduler: Ein Planer gibt an, wann eine Aufgabe ausgeführt wird oder nicht.
  • Ort: Ein Überwachungsstandort, der im weltweiten Überwachungsnetzwerk Dotcom-Monitor verfügbar ist.
  • Warnungsgruppe: Durch das Einrichten einer Gruppe werden Empfänger eines Berichts und/oder einer Warnung in einer Gruppe platziert. Jeder Empfänger in der Gruppe kann über eine eindeutige Warnungsvorlage verfügen.
  • Warnungsvorlage: Vorlage definiert Das Warnungsformat.
  • Filter: Ein Filter ist ein Satz von Regeln, die bestimmen, wie Überwachungsantworten verarbeitet und angezeigt werden.
  • Audit: Stellt historische Informationen zu jeder und jeder Kontoänderung bereit.

Hinzufügen eines eindeutigen Integrationsbezeichners

Um eine Integration mit Dotcom-Monitor einzurichten, müssen Sie Zugriff auf ein aktives Dotcom-Monitor-Konto haben und einen eindeutigen Web-API-Bezeichner erstellen, der in der Authentifizierungsanforderung verwendet werden kann:

  1. Melden Sie sich beim Dotcom-Monitor-Konto an.
  2. Erstellen Sie in Dotcom-Monitor eine Integrations-UID unter > Integrationkonfigurieren.

Sie müssen vor einer API-Anforderung in Dotcom-Monitor authentifiziert werden. Die Authentifizierung läuft nach 60 Sekunden Inaktivität ab.

Die folgende Tabelle zeigt, welcher Anforderungstyp und welche Aktion von jedem Ressourcentyp unterstützt wird.

Ressourcentyp Anforderungsmethode URI(s) beschreibung
bahnsteig Erhalten /Plattformen Rückgabeliste der verfügbaren Plattformen
Gerät Erhalten /geräte/{platform} Abrufen der Geräteliste nach Plattform.
Erhalten /gerät/{deviceId} Abrufen von Geräteinformationen
Bereitstellen /devices?verb=PUT Neues Gerät erstellen
PUT /Geräte
Bereitstellen /device/ {deviceId} /DisableAlert/ Deaktivieren von Warnungen
Bereitstellen /gerät/{deviceId} Bearbeiten des Geräts
Bereitstellen /device/ {deviceId} ?verb=löschen Gerät löschen
Löschen /gerät/{deviceId}
Aufgabe Erhalten /device/ {deviceid} /aufgaben Liste der Aufgaben unter einem Gerät abrufen
Bereitstellen /tasks?verb=PUT Neue Aufgabe erstellen
PUT /Aufgaben
Erhalten /task/{TaskId} Abrufen von Aufgabeninformationen
Bereitstellen /task/{TaskId} Bearbeitungsaufgabe
Bereitstellen /task/ {TaskId} ?verb=löschen Löschaufgabe
Löschen /task/{TaskId}
Frequenz Erhalten /Frequenzen/{platform_name} Holen Sie sich verfügbare freq. über die Plattform.
Scheduler Erhalten /Planer Liste der Planer abrufen
Erhalten /Scheduler/{Scheduler_ID} Spezifische Planerinformationen abrufen
Bereitstellen /schedulers?verb=PUT Erstellen eines neuen Planers
PUT Planer
Bereitstellen /scheduler/- Scheduler-ID Scheduler bearbeiten
Bereitstellen /Scheduler/ {Scheduler_Id} ?verb=löschen Scheduler löschen
Löschen /Scheduler/{Scheduler_Id}
standort Erhalten /Standorte/{platform_name} Liste der verfügbaren Standorte abrufen
Warnungsgruppe Erhalten /Gruppen Liste der Warnungsgruppen abrufen
Bereitstellen /groups?verb=PUT/groups Warnungsgruppe erstellen
PUT Gruppen/Gruppen
Erhalten /Gruppe/{Group_ID} Abrufen von Informationen zur Warnungsgruppe
Bereitstellen /Gruppe/{Group_ID} Bearbeiten der Warnungsgruppe
Bereitstellen /Group/ {Group_Id} ?verb=löschen Löschgruppe
Löschen Gruppe/{Group_Id}
Warnungsvorlage Erhalten /vorlagen Liste der Warnungsvorlagen abrufen
Bereitstellen /templates?verb=PUT/templates Erstellen einer neuen Warnungsvorlage
PUT /templates/templates
Erhalten /template/{Template_ID} Abrufen von Warnungsvorlageninformationen
Bereitstellen /template/{Template_ID} Bearbeiten der Warnungsvorlage
Bereitstellen /template/ {Template_Id} ?verb=löschen Vorlage löschen
Löschen /template/{Template_Id}
filter Erhalten /Filter Liste der Filter abrufen
Bereitstellen /filters?verb=PUT Erstellen eines neuen Filters
PUT /Filter
Erhalten /filter/{filter_ID} Spezifische Filterinformationen abrufen
Bereitstellen /filter/{filter_ID} Filter bearbeiten
Bereitstellen /filter/ {filter_ID} ?verb=löschen Filter löschen
Löschen /filter/{filter_ID}
Audit Erhalten /audit/list Abrufen von Listenüberwachungsobjekten für den aktuellen Benutzer für die letzten 24Stunden.
Erhalten /audit/object/-sample-ID Abrufen von Überwachungsinhalten für die jeweilige ID
Bereitstellen /audit/list Abrufen einer gefilterten Liste der überwachten Objekte.
  • Web API Monitoring: How to Start and What Approach to Use

    Bevor wir mit dem Thema Web-API-Überwachung beginnen, lassen Sie uns kurz über die Ansätze sprechen, die häufig verwendet werden, um Daten zwischen verschiedenen Arten von Software auszutauschen.

    Es ist schwer, sich ein modernes Unternehmen vorzustellen, in dem alle Geschäftsprozesse auf einem einzigen Softwareprodukt laufen. Im Allgemeinen gibt es mehrere Desktop- und Webanwendungen, die verwendet werden, um Geschäftsvorgänge über ihren gesamten Lebenszyklus hinweg zu unterstützen. Einige Anwendungen sind sofort in der Lage, mit verwandten Softwareprodukten zu interagieren, während andere zusätzliche Konfigurationen oder Dienste von Drittanbietern benötigen. Die gängigen Praktiken, die auf dem Softwaremarkt eingeführt wurden, um die Softwareintegration zu unterstützen, sind z. B.:

    • Webdienste.
    • Dateiaustausch über FTP.
    • Unstrukturierte HTTP-Anforderungen.
    • Andere Ansätze wie Websockets, dedizierte Ports usw.

    Während alle anderen Softwareintegrationsansätze keine standardisierten Prozesse des Datenaustauschs haben, bieten Webdienste standardisierte Integrationswege. Ein Webdienst ist eine Technologie, die es Anwendungen ermöglicht, über ein Netzwerk miteinander zu kommunizieren. Einfach ausgedrückt, ein Webdienst ist eine Adresse im Internet, ein Link, auf den zugegriffen werden kann, um Daten abrufbar zu machen oder eine Aktion auszuführen. In der Regel werden Webdienste, die über HTTP ausgeführt werden, als Web-API bezeichnet. Der Vorteil der Verwendung von HTTP als Transportprotokoll besteht darin, dass Webdienste unabhängig von Programmiersprachen sind. Bei Webdiensten kann der Client, der die Anforderung an die Ressource stellt, und der API-Server, der die Antwort bereitstellt, jede Programmiersprache oder jedes Framework verwenden. Auf diese Weise spielt es keine Rolle, ob Anwendungen, die wir verbinden möchten, mit den gleichen Programmiersprachen entwickelt werden oder nicht.

    Web-APIs werden in der Regel mit den folgenden Technologien implementiert:

    • XML-RPC (eXtensible Markup Language Remote Procedure Call) – das Protokoll, das HTTP als Transportprotokoll und XML zum Codieren von Aufrufen verwendet.
    • JSON-RPC (JSON Remote Procedure Call) – ein Analogon von XML-RPC außer Nachrichten werden im JSON-Format übertragen.
    • SOAP (Simple Object Access Protocol) – das standardisierte Protokoll, das WSDL (Web Services Description Language) verwendet, das auf XML basiert, um eine Nachrichtenstruktur zu beschreiben.
    • REST (Representational State Transfer) – kein Protokoll, sondern eine Architektur der Softwareinteraktion in einem Netzwerk basierend auf den Methoden des HTTP-Protokolls.
    • Spezielle Protokolle, die entwickelt wurden, um an einer bestimmten Aufgabe zu arbeiten, z. B. GraphQL, das verwendet wird, um eine Abfrage an einen API-Server zu erstellen und Daten aus dieser API in eine Clientanwendung zu laden.

    Was ist API-Überwachung?

    Nachdem Sie eine Web-API für Ihre Anwendung implementiert haben und erwägen, auf der Öffentlichkeit zu gehen, müssen Sie sicherstellen, dass alle API-Funktionen in Übereinstimmung mit der Geschäftslogik Ihrer Anwendung funktionieren. Darüber hinaus ist es von entscheidender Bedeutung, die Web-API-Leistung im Auge zu behalten, unabhängig davon, ob Sie selbst Verbraucher des API-Dienstes sind oder den Dienst für Anwendungen von Drittanbietern bereitstellen. Jede Verschlechterung der API-Serviceleistung kann erhebliche Verluste für verwandte Unternehmen verursachen und sich auf die Benutzererfahrung auswirken.

    Der Hauptzweck der API-Überwachung besteht darin, alle Fehler in Ihrer API proaktiv zu finden und zu beheben, sobald sie auftreten und noch bevor Ihre Benutzer sie bemerken.

    Warum müssen wir die API Ihrer Webanwendung oder Website überwachen? Warum reichen die UI-Tests nicht aus, um sicherzustellen, dass Ihre Webanwendung ordnungsgemäß funktioniert? UI-Tests sind wirklich die beste Möglichkeit, echtes Benutzerverhalten zu simulieren (siehe die Vorteile von Webanwendungstests in einem echten Browser mit Dotcom-Monitor EveryStep Scripting Tool). Die Websitefunktionalität, die wir im Allgemeinen über die Benutzeroberfläche überwachen, kann jedoch bereits durch API-Überwachungstests überprüft werden. Beispielsweise wurde ein API-Aufruf, der die Liste der im Onlineshop auf Lager artikelgespeicherten Elemente lädt, auf dem Back-End geändert, blieb jedoch auf der Benutzeroberfläche gleich, und das System kann die Liste bei der entsprechenden Benutzeraktion auf der Website nicht zurückgeben. In diesem Fall gibt die UI-Überwachung den Fehler zurück, aber die wahre Ursache des Fehlers wird nicht erkannt (es kann ein Verbindungsproblem, Serverüberlastung, UI-Fehler, falscher API-Aufruf usw. sein). Auf der anderen Seite zeigt die Web-API-Überwachung, dass der Aufruf des Ziel-API-Endpunkts die Antwort nicht zurückgibt. Für eine zusätzliche API-Aufrufergebnisüberprüfung kann die Überprüfung des Antwortinhalts verwendet werden.

    Wie funktioniert API Monitoring?

    Die Web-API-Überwachung konzentriert sich auf Ressourcen und den Zugriff auf diese Ressourcen. In der Web-API stellen Ressourcen verschiedene Arten von Informationen dar. Auf Ressourcen kann über URLs (Uniform Resource Locators) zugegriffen werden. Wenn Sie zu einer bestimmten URL in Ihrem Browser navigieren, stellen Sie eine Verbindung mit der Ressource her, die dieser URL entspricht. Dasselbe passiert, wenn Sie eine API-Anforderung an eine URL-Adresse der Ressource von solchen Anwendungen wie Postman oder mit CURL senden. Um für den Webdienst deutlich zu machen, welche Aktion Sie für die Ressource ausführen möchten, werden die HTTP-Methoden verwendet, einschließlich GET (Lesen), POST (erstellen), PUT (Update) und DELETE (Löschen). Ausführliche Erläuterungen zur Verwendung von Dotcom-Monitor zum Überwachen von RESTful-APIs finden Sie unter REST Payload – How to Push to Web API.

    Auf jede Anforderung folgt eine Antwort vom API-Server. Die Antwort ist die Daten, die von der API als Antwort auf die Anforderung zurückgegeben werden. Antworten können unterschiedliche Daten zurückgeben, einschließlich eines JSON-Objekts.

    Der gesamte Pfad zur Ressource, der die Anforderungsparameter enthält und Zugriff auf die Ressource bietet, wird als Web-API-Endpunkt bezeichnet. Der Endpunkt, an den ein API-Aufruf gesendet werden soll, kann z. B. wie folgt aussehen:

    http://example.com/wp-json/wp/v2/tests

    Einfach ausgedrückt, Endpunkte sind das, was wir überprüfen, während wir Web-API-Überwachungsaufrufe für unsere Websites und Anwendungen ausführen. Im Allgemeinen umfassen die Überwachungsschritte für API-Endpunkte Folgendes:

    • Anforderung an einen Endpunkt.
    • Antwort vom API-Server.
    • Überprüfung und Analyse der Reaktion.

    Vorteile der Verwendung von Dotcom-Monitor als API Monitoring Tool

    Dotcom-Monitor ist eine umfassende Lösung, die für alle Arten der Web-API-Überwachung verwendet werden kann (siehe Einrichten von SOAP Web Services Monitoring und REST Web API Monitoring). Neben der API-Überwachung bietet Dotcom-Monitor Überwachungstools für Webanwendungen, Websites, einzelne Webseiten, Webserver und andere Arten von Webressourcen.

    Um den Überwachungsprozess auf eine neue Ebene zu bringen, ermöglicht Dotcom-Monitor Benutzern, ihre Zielwebanwendungen in einem echten Browserfenster zu testen. Browserbasierte Tests stellen sicher, dass der Überwachungstest so nah wie möglich an einem realen Szenario ausgeführt wird und wiederholt die tatsächliche Benutzererfahrung. Sie können zwischen einer Reihe von Browser-Engines wählen, um Ihre Anwendung oder Website in einschließlich Desktop- und mobile Browser-Engines auszuführen.

    Detaillierte Leistungsberichte mit Element-für-Element-Wasserfalldiagrammen, Screenshots und Video, die während der Überwachungssitzungen aufgezeichnet wurden, geben Ihnen volles Verständnis dafür, was genau hinter der Szene der Benutzeroberfläche passiert – welche Elemente Ihre Anwendung verlangsamen und die Fehler und Engpässe in ihrer Leistung verursachen.

    Das hochgradig angepasste Warnsystem Dotcom-Monitor bietet Ihnen einen effizienten Warnbenachrichtigungsdienst. Das System kann so konfiguriert werden, dass Warnmeldungen an die dedizierten Adressen gesendet werden, wenn während der Überwachung Fehler erkannt werden. Weitere Informationen finden Sie in den unterstützten Warnmechanismen im Artikel Alert-Delivery Mechanisms unserer Knowledge Base.