Einrichtung benutzerdefinierter API-Metriken

Hier erfährst du, wie du benutzerdefinierte Metriken verwenden kannst, um Daten von APIs zu erfassen. Dabei kann es sich um eine API eines Technologie-Anbieters, die du geschäftlich einsetzt, oder deine eigene API, die du zur Unterstützung deiner Kunden oder Prozesse entwickelt hast, handeln. Es kann sogar eine benutzerdefinierte API sein, die du programmiert hast, um interne geschäftliche Daten oder Plattformmetriken zu erfassen und zu berechnen. Test-Tools und Monitoring-Lösungen sorgen dafür, dass deine APIs korrekt funktionieren. Sie sollten daher ein wichtiger Teil deines Plattformbetriebs sein. Aber es gibt weitere Maßnahmen, anhand derer du Einblicke in Plattform- und Geschäftsstatus erhältst. Das benutzerdefinierte Monitoring deiner API-Daten prüft nicht nur die Verfügbarkeit und führt Datenvalidierungen durch: Es erfasst die von deiner API produzierten Daten und zeigt den Fortschritt der Plattform- und Geschäftsdaten über einen Zeitraum visuell.

API Monitoring

Du kannst Test-Tools wie Postman, Insomnia, SoapUI oder Swagger UI einsetzen, um deine APIs zu prüfen und Daten für Ad-hoc-Tests und zur Fehlerbehebung untersuchen. Du kannst ein synthetisches Monitoring-Tool (wie Uptrends’ API-Monitoring ) verwenden, um die Verfügbarkeit und Antwortzeiten fortlaufend zu überwachen. Damit hört es aber nicht auf. Du solltest eine eingehende Content-Validierung deiner JSON-Daten (mit JSON-Ausdrücken) oder XML-Daten (mit XPath-Abfragen) einrichten, sodass du siehst, ob die von der API zurückgegebenen Daten deine Erwartungen erfüllen – ohne Fehler und innerhalb annehmbarer Grenzen. Damit wird sichergestellt, dass die Prozesse, die sich auf solche APIs stützen, weiterhin korrekt und schnell funktionieren. Diese Prozesse können deine Mobile-Apps und kundenzugewandte Web-Apps oder auch geschäftliche Abläufe im Hintergrund sein.

API-Daten überwachen

Nehmen wir an, du hast eine REST API, die Teil eines Produkte vertreibenden E-Commerce-Systems ist. Der gesamte Produktkatalog besteht aus mehreren Produktlinien unterschiedlicher Lieferanten, die ihre Produktlisten mehrmals am Tag aktualisieren. Zudem gibt es Prozesse im Hintergrund, die deinen eigenen Produktkatalog aktualisieren, sobald Aktualisierungen verfügbar sind (die wahrscheinlich ebenfalls die API deiner Lieferanten nutzen). Auf deine Produkt-API greifen dein E-Commerce-Webshop und die Mobile-App direkt zu.

Es ist wahrscheinlich ziemlich wichtig für dein Geschäft zu prüfen, dass deine Produktlisten die erwartete Anzahl Produkte und Kategorien (zumindest ein bestimmtes Minimum) bereithält. Wahrscheinlich erhältst du einige Berichte, die von deinen Hintergrundprozessen generiert werden, aber mit dem Monitoring auf Grundlage deiner API-Daten bekommst du die Informationen viel schneller.

Und das Einrichten ist kein Problem! Du kannst ein Multi-Step API Monitoring (MSA) einrichten, das ein oder mehrere Aufrufe an deine Produkt-API-Endpunkte sendet und JSON-formatierte Daten mit der Gesamtzahl der Produkte, den Produktkategorien und der Anzahl der Produkte in jeder Kategorie zurückgibt. Füge einige Assertions hinzu, die einzelne Attribute (für dieses Beispiel TotalProductCountund CategoryCount) ansprechen und verifizieren, dass diese Zahlen nicht die Mindestwerte unterschreiten. Zum Beispiel soll TotalProductCount immer größer als 1500 und CategoryCount mindestens 10 sein. Diese Assertions sind Absicherungen gegen unbemerkte Fehler bei der Produktaktualisierung, wodurch plötzlich große Mengen deines Produktbestands geleert würden. Wenn ein Fehler auftritt, wirst du sofort von Uptrends gewarnt und kannst schnell handeln. Dieser Bereich deines Tagesbetriebs ist also geregelt.

Datentrends erkennen

Mit den Daten lässt sich aber noch mehr machen. Jede einzelne Monitoring-Prüfung sagt dir, dass dein Produktkatalog gut aussieht (oder eben nicht). Die Produkt- und Kategoriezahlen wurden bei jedem Check validiert, aber du siehst nicht die tatsächlichen Werte. Es wäre gut zu wissen, wie die Anzahl der Produkte während des Tages (Micro-Änderungen) und während eines Monats oder Jahres (Macro-Änderungen) schwankt. Wenn die Anzahl der Produkte beispielsweise schneller als erwartet wächst, könnte dies auf ein Problem hinweisen, dass zurückgezogene Produkte nicht aus der Datenbank entfernt wurden. Dies kann deine API sowie schließlich die Mobile-App verlangsamen. Und dies anhand einfacher Assertions zu erkennen, ist schwierig. Du benötigst Trend-Analysen!

Du hast bereits den Wert TotalProductCount mit der MSA-Assertion identifiziert. Jetzt ist es sehr einfach, die Daten als benutzerdefinierte Metrikdaten zu erfassen. Richten wir dies ein!

Benutzerdefiniertes API-Monitoring einrichten

Sobald du ein MSA-Prüfobjekt mit einem einzelnen oder mehreren Schritten eingerichtet hast, musst du eine Multi-Step Monitoring-Variable für wenigstens einen deiner MSA-Schritte definieren. Diese Variablen ermöglichen es, bestimmte API-Antwortwerte zu speichern, die dann als Teil der Schrittdefinition beliebig verwendet werden können. Wenn du beispielsweise eine Variable namens UserId definierst, kannst du sie als Teil der Schritt-URL verwenden: https://your.api.com/GetUserInfo/{{UserID}}.

Eine benutzerdefinierte Metrikvariable erstellen:

1. Rufe im MSA-Prüfobjekt-Editor > Schritte auf.
2. Scrolle runter zum Bereich Benutzerdefinierte Metriken.
3. Klicke auf Metrik hinzufügen.
4. Gib im Feld Metrikname einen Namen für die benutzerdefinierte Metrik ein.
5. Wähle von der Drop-down-Liste die Option Diese Variable wird im Skriptcode ausgefüllt.

Sobald dies erledigt ist, verwendest du die benutzerdefinierte Metrik-Variable im Nach-Antwort-Skript deines Schritts:

1. Wähle den Tab Nach-Antwort deines Schritts.

2. Wähle aus den benutzerdefinierten Metrikfunktionen eine, die deinen Bedürfnissen am besten entspricht.

3. Speichere das Prüfobjekt, um die Änderungen zu sichern.

4. Füge eine benutzerdefinierte Berichtskachel hinzu, um die gerade erstellte benutzerdefinierte Metrikvariable im Blick zu behalten.

Du kannst bis zu fünf benutzerdefinierte Metrikvariablen wie diese zu einem MSA-Prüfobjekt festlegen. Um weitere hinzuzufügen, wende dich bitte an das Support-Team , das dir weiterhilft.

Namen benutzerdefinierter Metriken

Verwende bei der Erstellung einer neuen benutzerdefinierten Metrik einen Namen, der verständlich ist und der die Funktion in Kontext setzt. Der Metrikname und der Name des Prüfobjekts erscheinen in der Liste verfügbarer benutzerdefinierter Metriken, wenn du diese zu deinem Bericht über benutzerdefinierte API-Daten hinzufügst. Daher kannst du dieselben benutzerdefinierten Metriknamen für ähnliche Arten von Daten, die aber zu unterschiedlichen Gruppen gehören (zum Beispiel wird totalSum bei Produkten und Kunden-APIs genutzt), einsetzen, da du sie leicht aufgrund der unterschiedlichen Prüfobjektnamen auseinanderhalten kannst.

Uptrends empfiehlt, direkt die richtigen Namen zu vergeben. Späteres Umbenennen einer benutzerdefinierten Metrik wird als Erstellen einer neuen, anderen Metrik erachtet.

Daten untersuchen und Fehler beheben

Sehen wir uns zunächst unsere neuen Daten an, bevor wir Diagramme und Tabellen einrichten. Rufe das Prüfobjektprotokoll auf und finde dein MSA-Prüfobjekt sowie ein neueres Check-Ergebnis. Klicke darauf, um ein Pop-up-Fenster mit den Ergebnissen zu öffnen.

In Bereich Check-Details siehst du den/die Wert(e) für deine neuen benutzerdefinierten Metriken unter den Ergebnissen des Schritts. Du erhältst direkten Zugriff auf die einzelnen Werte der benutzerdefinierten Metrik, wie sie während der Ausführung des MSA-Prüfobjekts erfasst wurden.

Wenn du nicht den erwarteten Wert für die benutzerdefinierte Metrik siehst, bedenke Folgendes: – Hast du versehentlich die Check-Ergebnisse für einen älteren Check geöffnet, der ausgeführt wurde, als die neue benutzerdefinierte Metrik noch nicht definiert war? – Erfasst deine neue benutzerdefinierte Metrik numerische Ganzzahldaten? Enthält sie Textdaten oder Kommazahlen (wie etwa 99,9 % oder 3,1415), dann würde die benutzerdefinierte Metrik nicht erfasst. Derzeit werden nur Ganzzahlen unterstützt. Bitte sprich uns an, um deine Anforderungen zu erörtern. – Wenn bei der Ausführung des MSA-Prüfobjekts ein Fehler aufgetreten ist, wurde die Variable, die an deine benutzerdefinierte Metrik übergeben wird, möglicherweise gar nicht erst erstellt. Unser Support hilft dir bei der Behebung des Problems.

Berichte erstellen

Wenn du bestätigt hast, dass deine neue benutzerdefinierte Metrik die richtigen Ergebnisse produziert, kannst du einen Bericht erstellen, der den Fortschritt der Metrik widerspiegelt, sobald du ausreichend Daten gesammelt hast. Für dieses Beispiel erstellen wir ein neues Dashboard mehr über die Dashboard-Einrichtung . Klicke auf Dashboards > Dashboard hinzufügen, um ein komplett neues Dashboard zu erstellen. Klicke auf eine der leeren Kacheln, scrolle im sich öffnenden Pop-up-Fenster Neue Kachel hinzufügen nach unten und wähle Liste Benutzerdefinierte Metriken.

Die neue Kachel ist zunächst leer. Öffne die Kachel-Einstellungen und finde das Prüfobjekt, das die benutzerdefinierte Metrik enthält. Erweitere sie, um die benutzerdefinierte Metrik zu deiner Auswahl hinzuzufügen. Beachte, dass du mehr als eine benutzerdefinierte Metrik auswählen kannst: Sie werden in einem Diagramm angezeigt, sodass du die Werte vergleichen kannst.

Dementsprechend kannst du die Kachel Benutzerdefinierte Metriken auch verwenden, um ein Raster zu erstellen, das numerische Werte für eine oder mehrere benutzerdefinierte Metriken anzeigt. Hinweis: Die angezeigten Werte stellen Durchschnittswerte dar.

Nachdem du das Dashboard eingerichtet hast, kannst du es speichern, exportieren und einen Plan für automatischen E-Mail-Versand bestimmen.

Rohdaten untersuchen

Diese Berichte bieten dir eine gute Möglichkeit, Datentrends anzuzeigen. Möglicherweise solltest du aber tiefer gehen und die zugrunde liegenden Daten betrachten. Wenn du auf jeden einzelnen erfassten Wert der Metrik zugreifen kannst, kannst du plötzliche Spitzenwerte genauer erkennen, Minimum-, Maximum- und Mittelwert-Analysen usw. vornehmen.

Dafür erstellst du eine Exportdatei, die alle erfassten Metriken in eine Excel-Datei herunterlädt. Rufe zuerst das Dashboard Prüfobjektprotokoll auf, um die entsprechenden Prüfobjekte auszuwählen. Öffne dann die Kachel-Einstellungen für die Kachel „Prüfobjektprotokoll“. Aktiviere auf der Registerkarte „Export“ das Kontrollkästchen Benutzerdefinierte Metriken. Klicke auf Übernehmen, um die Einstellungen abzuschließen.

Nutze das Dashboard-Menü (Hamburger-Symbol), um den Excel-Export (entweder direkt oder per E-Mail) durchzuführen. Die Excel-Datei zeigt eigene Spalten für jede benutzerdefinierte Metrik, die von deinen Prüfobjekten erfasst wurde.