Building Block API Health Check: nooit meer onverwacht een API down

De zekerheid van actieve API’s

Jeffrey: “De API Health Check als Building Block biedt onze klanten de zekerheid dat, mocht een proces onverhoopt niet meer functioneren, zij hierover direct geïnformeerd worden. Je wilt immers niet dat een API ongemerkt plat ligt en daar pas later achter komen. Voorheen gebeurde dat soms zelfs toevalligerwijs, als vanuit de Business het signaal kwam dat een aanpassing doorvoeren niet lukte. Met het Building Block monitoren wij actief de gezondheid van API’s. Zo sporen we eventuele problemen vroegtijdig op en kunnen we ze veelal oplossen voordat een proces plat gaat.”

“Dit Building Block implementeren we niet alleen voor onze eigen API’s, maar ook voor de backends waar wij op aansluiten. Op de beschikbaarheid van die backends hebben wij door deze tussenlaag meer controle, waardoor we ook derde partijen kunnen inlichten als we een signaal krijgen van een potentieel risico.”

Automatische notificaties: ‘Kom in actie!’

“Bij het uitdenken en -werken van dit Building Block kwam aardig wat uitzoekwerk kijken. Het moet generiek te configureren zijn, maar instellingen moeten ook op maat ingevoerd kunnen worden. Ook de onderlinge afhankelijkheden van API’s brengen de nodige complexiteit met zich mee. Zo’n veelomvattende puzzel leg ik met veel plezier. De uitwerking heb ik in een iteratief proces gedaan. Ik begon met een simpele, kale notificatie bij een gezondheidsrisico voor een API. Daarna ben ik steeds opnieuw gaan kijken hoe het nog beter, veiliger en stabieler kon. Het Building Block dat er nu staat, is solide en gebruiksvriendelijk.”

“Het begint met het verzamelen van data die verstuurd wordt naar Kibana. Met Kibana kun je logs raadplegen, analyseren, filteren en fraaie overzichten maken. Daar heb ik een dashboard voor gemaakt. Uiteindelijk is het de bedoeling dat die data gebruikt wordt voor notificaties van de API Health Check die we naar een Teams-kanaal sturen, e-mailen of sms’en; naargelang de importantie van de notificatie. De inhoud van zo’n notificatie kan zijn: ‘Let op, mogelijk risico voor je API.’ Maar ook: ‘Je omgeving is down, kom meteen in actie!’ Zo’n bericht kan naar een teamlid of naar het hele team worden verstuurd. Het zorgt ervoor dat een beheerder niet continu Kibana hoeft te checken voor eventuele notificaties, maar automatisch alerts krijgt. Door het Building Block ontstaat er inzicht in wat er echt speelt en belangrijk is.”

“De vervolgstap is dat ontvangers van een notificatie in een automatisch gegenereerd ticket kunnen aangeven of ze een probleem oppakken en wat de status is, zodat er geen dubbel werk wordt gedaan. Als het probleem is opgelost, kun je het ticket sluiten en krijgt iedereen uit het team daar een seintje van. In het automatisch genereren van die tickets ging aardig wat uitzoekwerk zitten, maar het werkt goed en bewijst zich inmiddels in de praktijk. We blijven onderzoeken hoe we verder kunnen aansluiten op bestaande klantprocessen.”

Dashboard met realtime status API’s

“Onze klanten hebben al snel tientallen API’s of (veel) meer. Dan is het belangrijk om een goed zicht te hebben op de status van je (API-)landschap. Dat stelt je in staat om actief te kunnen acteren op het voorkomen van storingen. En is er toch een storing, dan kun je sneller reageren en de root cause achterhalen. Onderdeel van het Building Block API Health Check is daarom een dashboard met daarin de realtime status van alle API’s, wat de laatste error binnen een API is geweest en wat daarvan de reden is. Bij het overzicht staan ook logs met beschikbaarheidspercentages.”

“Dit dashboard hebben we al bij klanten geïmplementeerd. Hiervoor gebruiken we een generiek datamodel voor de API Health Check en andere dashboards. De data wordt steeds op dezelfde manier gevoed aan Kibana, met eenduidige veldnamen en -types, waardoor we het makkelijk kunnen overzetten.”