API voi olla pystyssä ja silti rikki. Kuormantasaaja vastaa, tilakoodi on 200, ja vastauksen rungossa lukee, että tietokantayhteys epäonnistui. Mobiilisovelluksesi, kumppanisi ja oma frontendisi näkevät kaikki virheen, mutta pelkkä käytettävyystarkistus ei huomaa mitään.
API-valvonta kutsuu päätepisteitäsi aikataulun mukaan ja tarkistaa sekä sen, että ne vastaavat, että sen, että vastaus on oikea. Uptimecheckissä se käyttää samoja HTTP(S)-valvontoja kuin verkkosivuston käytettävyyden valvonta, API:n tarvitsemin lisäasetuksin.
Mitä voit määrittää
Metodi: GET, POST, PUT, PATCH, DELETE, HEAD tai OPTIONS.Otsakkeet: enintään 20, esimerkiksi API-avain, Authorization-otsake tai oma user agent.Runko: lähetä JSON-sisältö kirjoittavan polun testaamiseksi.Odotettu tila: koodit tai välit, kuten 200-299 tai 201.JSON- ja otsaketarkistukset: enintään 10 ehtoa, joiden kaikkien on täytyttävä, kuten $.status on ok.Avainsana: teksti, joka vastauksessa on oltava tai jota siinä ei saa olla.Aikakatkaisu ja hitausraja: tarkistus epäonnistuu enintään 30 sekunnin jälkeen, ja saat hitaushälytyksen, kun vasteajat pysyvät rajasi yläpuolella.
Mitä päätepisteitä valvoa ensin
Aloita pyynnöistä, jotka tuovat rahaa tai estävät käyttäjiä. Verkkokaupassa ne ovat ostoskori, kassa ja maksun paluukutsu. SaaS-tuotteessa ne ovat kirjautuminen, tärkein lukeva päätepiste ja jokainen maksupalvelulta vastaanotettava webhook. API-valvonnan tarkistuslista kertoo, mitä kannattaa kattaa ja kuinka usein, ja oppaamme health check -päätepisteistä näyttää, mitä hyvä päätepiste palauttaa.
Tyypillinen kokoonpano: lumenanalytics.io
GET /health minuutin välein JSON-tarkistuksella, että $.status on ok.POST /v1/events pienellä testisisällöllä ja API-avainotsakkeella.GET /v1/reports Authorization-otsakkeella ja hitaushälytyksellä 1 500 ms:n kohdalla.
Tiedä, kun päätepiste hidastuu
Uptimecheck tarkistaa Tukholmasta, Lontoosta ja New Yorkista ja vahvistaa jokaisen virheen toisesta sijainnista ennen kuin häiriö avataan, joten yksittäinen pudonnut pyyntö ei herätä tiimiä. Vasteajat tallennetaan jokaisesta tarkistuksesta ja eritellään DNS-, yhteys-, TLS-, palvelin- ja latausvaiheisiin. Näet siis, että raporttipäätepisteen vasteaika nousi 90 ms:sta 2,4 sekuntiin kello 14.00, että aika kului palvelinvaiheessa ja että health check pysyi tasaisena.
Kun yksi pyyntö ei riitä
Moni API-ongelma näkyy vasta pyyntöjen sarjassa: kirjaudu, hae token, käytä sitä. Polkuvalvonta ajaa enintään 10 vaihetta järjestyksessä, tallentaa yhdestä vaiheesta arvon, kuten tokenin tai tilausnumeron, ja käyttää sitä seuraavassa. Salaisuudet, kuten salasanat, salataan eikä niitä näytetä enää uudelleen.
Hälytykset ja automaatio
Kun päätepiste kaatuu, hälytykset menevät sähköpostiin, Slackiin, Microsoft Teamsiin, Discordiin, Google Chatiin, Mattermostiin, Telegramiin, PagerDutyyn, ntfy:hin, Pushoveriin, webhookeihin ja push-ilmoituksina puhelimeesi kaikissa paketeissa. Webhookit allekirjoitetaan, joten omat työkalusi voivat varmistaa niiden lähteen. Voit hallita valvontoja myös koodista: Professional- ja Business-paketeissa REST API luo ja päivittää valvontoja deploy-putkestasi, joten uusi päätepiste saa valvonnan samana päivänä, kun se julkaistaan.
Valvo riippuvuuksia, älä vain omaa koodiasi
API:si on riippuvainen muista: maksupalvelusta, sähköpostipalvelusta, hostingalustasta. Kun jokin niistä kaatuu, päätepisteesi voi yhä vastata, vaikka sen takana oleva toiminto on rikki. Lisää valvonnat päätepisteille, jotka käyttävät näitä palveluita, ja seuraa toimittajien, kuten Klarnan, Shopifyn, Cloudflaren ja OpenAI:n, tilasivuja kolmansien osapuolten valvonnalla. Silloin voit kertoa asiakkaalle minuuteissa, onko vika teillä vai toimittajalla.
Pidä testiliikenne turvallisena
Käytä valvontapyynnöille erillistä testitiliä tai API-avainta, ja tee kirjoittavista tarkistuksista idempotentteja, jotta minuutin välein tehtävä POST ei täytä tietokantaasi testitietueilla. Merkitse valvontaliikenne omalla user agent -otsakkeella, niin se on helppo suodattaa pois omasta analytiikasta ja lokeista.
Taustatöille, joilla ei ole päätepistettä, käytä sen sijaan cron-jobien valvontaa.
Paketit alkavat 9 €:sta kuukaudessa vuosilaskutuksella tai 12 €:sta kuukausilaskutuksella (alv 0 %). Katso kaikki rajat hinnastosivulta tai aloita 14 päivän ilmainen kokeilu ilman korttia.