API stebėjimas, kuris aptinka neteisingą atsaką.

Jūsų /health galinis taškas nemato sugedusio prisijungimo proceso. Uptimia prisijungia, iškviečia API ir patikrina atsakus – iškart sužinote, kuris žingsnis sugedo, o ne gaunate kliento skundą.

Pradėkite nemokamą bandymą → Žiūrėkite kainas
30 dienų nemokamas bandymas · iki 50 API stebėjimų Be kreditinės kortelės Atitinka BDAR
Trumpiausias intervalas
60s
Patvirtinančios vietos
3
Tikrinimo taškai
171+
Aprėptos šalys
70+

Užklausa, grąžinusi ne tą atsaką

Penkių žingsnių užsakymo eiga vykdoma pagal grafiką. Prisijungimas, užsakymo paieška ir suma – viskas pavyksta, o štai kita užklausa – ne.

1 žingsnis Prisijungti – gauti žetonąPrisijungimas pavyksta; grąžintas žetonas patenka į {{token}} jūs: netrukdomi
2–3 žingsniai Juo iškviečiama APIGET /orders paima {{order_id}}; užsakymo suma turi būti teisinga jūs: netrukdomi
4 žingsnis Nepavyksta pridėti užsakymo pastabosTikrinimo sąlyga įvardija spragą: pastaba taip ir nesukurta jūs: netrukdomi
14:32 Patvirtinama kitur – tik tada jus pažadinaKitos vietos pakartoja patikrą ir sutampa; įspėjime jau nurodytas 4 žingsnis pažadinta: su priežastimi
4 žingsnisįvardyta įspėjime
„4 žingsnis neišlaikė patikros.“14:32
Visa paieška atlikta dar prieš jums įjungiant kompiuterį: žingsnis, tikrinimo sąlyga ir patvirtinimas, kad tai ne pavienio tikrinimo taško atsitiktinis gedimas. Taisyti pradedate nuo nepavykusios užklausos, o ne nuo „API neveikia“.
įvardytas nepavykęs žingsnistiksli tikrinimo sąlygapatvirtinta iš kitų vietųbūsena · laikas · antraštės · reikšmės – kiekviename žingsnyje
O jei tik ping? /health visą laiką atsakinėja puikiai – sugedęs žingsnis sekos viduryje jo net nepaliečia. Pirmas signalas – klientas, kuriam nepavyko užbaigti, ir paieška žurnaluose, kur viskas nutrūko. aptiko klientas

Ko ping niekada nepamato

Užklausa, kuri pavyksta, bet grąžina klaidingus duomenis, vis tiek yra klaida, o sugedęs žingsnis trimis užklausomis giliau jūsų /health galinio taško net nepaliečia. Nukreipkite vieną stebėjimo objektą į savo API – arba į tiekėjų API, nuo kurių priklausote, ir žinosite, kad kalti jie, o ne jūs.

Būsenos kodai ir antraštėsToks atsakymas, kokio tikitės, kiekviename žingsnyje
Reikšmės atsakeBet kuris laukas, tikrinamas žingsnis po žingsnio
Klaidos sekos viduryje3 žingsnis nepavyksta – ping to nemato
Pasikeitęs atsako formatasNe ta struktūra, trūkstami laukai
15 žingsnių grandinėje visas procesas, įvykdytas iš tikrųjų
Autentifikavimo klaidosNebegaliojantys žetonai, atmesti prisijungimai
TLS ir prisijungimo klaidosNepavykę ryšio derinimai, atmestos jungtys
Atsako laiko ribaKiekvienas žingsnis telpa į savo ribą
Įspėjime nurodomas žingsnis ir neįvykdyta patikra: nepavykusi užklausa, klaidinga atsako reikšmė, trūkstamas laukas, lėtas žingsnis, ryšio klaida ar neveikiantis prisijungimas. žingsnis + sąlyga

Grandinės, patikros ir trukmė

Seka

Sujunkite iki 15 užklausų

Kiekvienas žingsnis gali ištraukti reikšmę iš atsako – žetoną, užsakymo numerį – į kintamąjį, kurį vėlesni žingsniai įterpia kaip {{name}}. Vienas stebėjimo objektas apima visą kelią nuo prisijungimo iki išvalymo.

  • 6 HTTP metodai – GET, POST, PUT, PATCH, DELETE arba HEAD, bet kokia tvarka
  • Reikšmių ištraukimas į kintamuosius – naudokite jas bet kuriame vėlesniame žingsnyje kaip {{name}}
  • Pasirinktinės antraštės, turinys ir žingsnio laiko limitas – dubliuokite žingsnį greičiau
Atlikite tą pačią seką tikroje naršyklėje →
POST/auth/login1 sąlyga
{{token}}ištraukta → vėlesniems žingsniams
GET/orders2 sąlygos
{{order_id}}
GET/orders/{{order_id}}3 sąlygos
POST/orders/{{order_id}}/notes1 sąlyga
DEL/sessions/{{token}}išvalymas
Grandinė pavyko1.94 s
Vienas stebėjimo objektas atlieka visą procesą – nuo prisijungimo iki išvalymo – net kas minutę.
5 žingsniai7 sąlygos2 kintamieji
Žingsnis be patikrų vis tiek laikomas pavykusiu, jei užklausa sėkminga – tikrinkite tik ten, kur tai svarbu. bet kokia sėkmė
Tikrinimo sąlygos

Tikrinkite būseną, reikšmes ir laiką

Nurodykite sąlygas, kurias žingsnis turi atitikti: tikslų būsenos kodą, atsako laiko ribą, reikšmę atsako turinyje, antraštę ar tekstą atsake. Jei kuri nors neatitinka, vykdymas parodo gautą rezultatą, o Išbandyti kreipiasi į tikrą galinį tašką dar prieš išsaugant.

  • Būsena ir atsako laikas – žingsnis nepavyksta, jei kodas ne tas arba atsakas per lėtas
  • Reikšmės atsako turinyje – nurodykite lauką ir reikalaukite, kad jis egzistuotų ir būtų teisingas
  • Atsako antraštės ir turinio tekstas – reikalaukite antraštės reikšmės arba teksto, kuris privalo būti ar kurio būti negali
Stebėkite tekstą puslapyje, o ne tik būsenos kodą →
Išbandyti200 · 191 ms
GET /orders/8842 · 3 žingsnis – tikras atsakas, gautas dar prieš išsaugant.
{
  "id": 8842,
  "status": "paid",
  "total": 4210
}
būsena yra 200gauta 200
$.status lygu "paid"gauta "paid"
atsako laikas iki 500 msgauta 191 ms
Ištraukta {{order_id}} = 8842 perduodama kitam žingsniui – viršuje, tikrame atsake, ji paryškinta. = 8842
Laikas

DNS, TLS ar jūsų pačių serveris

„API lėta“ – toks skundas nieko nepaaiškina. Kiekvieno žingsnio laikas skaidomas į penkias fazes – DNS, susijungimas, TLS, laukimas, gavimas – tad matote, kuris žingsnis stabdo ir kas dėl to kaltas: tinklas ar jūsų serveris.

  • Penkių fazių laikas kiekviename žingsnyje – DNS, susijungimas, TLS, laukimas, gavimas
  • Kiekvieno žingsnio atsako laiko diagrama – sluoksniuota, su incidentų žymomis
  • Lėčiausias žingsnis ir lėčiausios patikros matomi stebėjimo objekto puslapyje
Laiko skaidymas pagal fazes – ir tinklalapiams →
4 žingsnis – lėtas14:32:16
POST /orders/8842/notes · iš viso 1 389 ms, suskaidyta į penkias fazes.
dns18 ms
susijungimas31 ms
tls44 ms
laukiama1,284 ms
gavimas12 ms
Tinklas – tvarkoje
dns 18 · connect 31 · tls 44
93 ms
Serveris – stabdis
apdorojimo laikas iki pirmo baito
1,284 ms
Lėčiausias žingsnis ir lėčiausios patikros matomi objekto puslapyje – sluoksninė žingsnio diagrama rodo lėtėjimo pradžią. lėčiausias
Slaptos reikšmės

Tikri API raktai, visada paslėpti

Slaptažodžius, API raktus ir žetonus saugokite kaip slaptus kintamuosius: jie tik įrašomi, paslepiami skaitant ir pašalinami iš rodomų URL, antraščių bei atsakų ištraukų. Į patikrų istoriją nepatenka nieko jautraus.

  • Tik įrašomi slapti kintamieji – visada paslepiami juos nuskaitant
  • Pašalinami visur, kur rodoma – URL, antraštėse ir turinio ištraukose
  • Ištrauktos reikšmės, sutampančios su slapta reikšme, taip pat niekur nerodomos
Stebėkite puslapius, pasiekiamus tik prisijungus →
API_KEYslapta
••••••••••••••••tik įrašoma
Įrašoma vieną kartą ir daugiau nerodoma – perskaičius grąžinama value:'' · has_value:true.
1 žingsnio antraštė – ką nustatote jūs
Authorization: Bearer {{API_KEY}}
tikras raktas įterpiamas siunčiant – tik atmintyje, niekur neįrašomas
Patikrų istorija – kas įrašoma
Authorization: Bearer [redacted]
Ištrauktos reikšmės, sutampančios su slapta reikšme, taip pat niekur nerodomos – į patikrų istoriją nepatenka nieko jautraus. paslėpta

Sujunkite užklausas vieną kartą.Ir visada žinokite, kuris žingsnis lūžo.

Visi žingsniai, visos tikrinimo sąlygos, visi įspėjimų kanalai – 30 dienų nemokamai, ir niekas iš to nėra mokamas priedas.

Išbandykite nemokamai 30 dienų →
30 dienų nemokamai be kreditinės kortelės atšaukite bet kada

Kaip veikia API stebėjimas

Susikurkite grandinę, išbandykite ją su realia API, o tada Uptimia vykdys ją pagal tvarkaraštį iš savo tinklo – nieko diegti nereikia.

1 žingsnissukuriate

Sujunkite savo užklausas

Sudėkite užklausas iš eilės, nurodykite antraštes bei turinį ir ištraukite į kintamuosius tas reikšmes, kurių prireiks vėlesniems žingsniams.

1 žingsnis · užklausa
POST /auth/login
ištraukti $.token → {{token}}
2 žingsnis · užklausa
GET /orders
2 žingsnispatikrinate

Nustatykite sąlygas ir išbandykite

Nurodykite kiekvieno žingsnio sąlygas ir spauskite „Išbandyti“ – patikra tikru adresu, rezultatai matomi dar prieš išsaugant.

Tikrinimo sąlygos · 3 žingsnis
būsena yra 200$.status = "paid"
iki 500 ms
Išbandyti · 5/5 žingsnių pavyko per 1,9 s
3 žingsniskas minutę

Grandinę vykdome pagal tvarkaraštį

Patikra vienu kartu įvykdo visą grandinę, patikrina kiekvieną sąlygą ir išsaugo žingsnių rezultatus – gedimas patvirtinamas iš kitų vietų, tik tada siunčiamas įspėjimas.

Patikra pavyko – 5/5 žingsnių
14:31 · 1,8 s · visos sąlygos išlaikytos
laiku
Patikra nepavyko – 4 žingsnis
14:32 · tikėtasi 201, gauta 500
įspėjama

Taip pat įskaičiuota

Slack, PagerDuty, SMS ir dar 9 kanalai

API įspėjime įvardijamas nepavykęs žingsnis ir priežastis, o ateina jis tais pačiais kontaktais, kuriuos naudoja visi Uptimia stebėjimo objektai – el. paštu, SMS, į Slack, Teams, Discord, PagerDuty, webhook ir kitur.

3 žingsnis · $.status: tikėtasi "paid", gauta "pending" → Slack · El. paštas · PagerDuty

Prieš siunčiant įspėjimą, patvirtinama iš kitų vietų.

Nepavykusi patikra pirmiausia pakartojama iš kitų tinkamų vietų.

pakartota kitur · sutapo dar prieš atidarant incidentą

Dubliuokite žingsnį

Grandinę greitai pailginsite – kopijuokite užklausą ir koreguokite.

3 žingsnis → dublikatas → 4 žingsnis

Incidento priežasčių analizės eksportas

Uždarytame incidente lieka žingsnių duomenys – eksportuokite juos.

RCAPDFHTML

Laiko limitas, antraštės ir turinys kiekvienai užklausai

Kiekvienai užklausai galite nurodyti savo laiko limitą, antraštes ir turinį.

limitas 10 s · 20 antraščių · 64 KB turinio

Visi stebėjimo tipai vienoje paskyroje

Jūsų API stebėjimas yra greta veikimo, SSL, veikimo signalo ir DNS stebėjimo – tie patys kontaktai, grupės ir vaidmenys.

Checkout order flowAPI www.caldmont.comUPTIME db-backup · nightlyHEARTBEAT

Kas yra API stebėjimas?

API stebėjimas – automatinė paslauga, pagal tvarkaraštį vykdanti realią HTTP užklausų seką jūsų REST API ar JSON galiniame taške ir įspėjanti, kai koks nors žingsnis grąžina netinkamą būseną, neteisingus duomenis arba užtrunka per ilgai. Ji stebi visą procesą už galinio taško, o ne vien tai, ar serveris atsakė.

Kol viskas veikia

Kaip veikia API stebėjimas?

Uptimia
vykdo grandinę
5 žingsniai · pagal tvarkaraštį
Jūsų API
visos patikros pavyko

Patikra įvykdo visus žingsnius vienu kartu, įvertina kiekvieną sąlygą ir išsaugo kiekvieno žingsnio rezultatus – tai ir yra jūsų patikrų istorija.

Kai patikra nepavyksta

Pirma patvirtinti, tik tada įspėti

Jūsų API
4 žingsnis · nepavyko
kartojama · kitose vietose
Uptimia
atidaro incidentą

4 žingsnis neišlaikė patikros → atidaromas incidentas, įspėjime nurodomas žingsnis

Patikros

Ką tikrina API stebėjimas?

Numatytuoju atveju žingsnis laikomas pavykusiu, jei atsakas sėkmingas. Pridėkite tikrinimo sąlygų – patikra turės jas įrodyti: tikslų būsenos kodą, atsako laiko ribą, reikšmę atsake, antraštę ar turinio tekstą.

Nemokamas įrankis: bet kurio galinio taško būsenos kodas ir antraštės →
PatikraKą ji įrodoPavyzdys
Būsenos kodasgalinis taškas atsakė taip, kaip tikėtasiyra 201 · yra 200 arba 204 · bet koks 2xx
Atsako laikasžingsnis pakankamai greitasiki 500 ms
JSON turinysatsake yra reikiami duomenys$.status lygu "paid"
Antraštėtinkamas turinio tipas ar talpyklos taisyklėContent-Type turi json
Turinio tekstasžymė yra arba jos trūkstaturi "order created"

DUK apie API stebėjimą

01Kas yra API stebėjimas?+
Automatinė paslauga, kuri pagal tvarkaraštį paleidžia tikrą HTTP užklausų seką į jūsų API ir tikrina atsakus. Vienas Uptimia stebėjimo objektas sujungia iki 15 užklausų ir įspėja, kai žingsnis grąžina ne tą būseną, ne tuos duomenis arba užtrunka per ilgai. Tai dar vadinama sintetiniu API stebėjimu arba automatine API būklės patikra.
02Kuo API stebėjimas skiriasi nuo paprastos ping patikros?+
Ping tik parodo, kad serveris atsakė. API stebėjimas įvykdo visą procesą ir pats patikrina atsaką – būsenos kodą, atsako laiką, antraštes bei JSON reikšmes. 200 su klaidingais duomenimis čia pastebimas, o paprastas ping to nepastebi.
03Kaip dažnai Uptimia vykdo mano API patikrą?+
Pagal numatytuosius nustatymus – kas 5 minutes, o dažniausiai – kas minutę: tvarkaraštis tikrinamas kas minutę, todėl tai yra mažiausias galimas intervalas. Mažiau svarbiems stebėjimams intervalą galite ir pailginti.
04Kiek žingsnių gali turėti vienas stebėjimas?+
Iki 15 HTTP užklausų vienoje grandinėje, kiekviena – iki 20 antraščių, 15 tikrinimo sąlygų ir 10 reikšmių ištraukimų. Vieno žingsnio laiko limitas – nuo 1 iki 60 sekundžių, o visai grandinei skiriama 90 sekundžių.
05Ar vykdomas JavaScript kodas, ar puslapis atvaizduojamas kaip naršyklėje?+
Ne. API stebėjimas siunčia paprastas HTTP užklausas – be foninės naršyklės, be JavaScript, be ekrano nuotraukų. Jei reikia realia naršykle atkartoti visą atvaizduotą scenarijų, rinkitės Uptimia operacijų stebėjimą; API stebėjimas – lengvesnis ir greitesnis įrankis pačiai API.
06Ar galiu patikrinti reikšmę JSON atsake?+
Taip. Nurodykite lauką JSONPath selektoriumi ir patikrinkite, ar jis egzistuoja, lygus, turi tam tikrą tekstą ar priklauso nurodytam sąrašui. Reikšmę taip pat galite išsaugoti kintamajame ir panaudoti vėlesniuose žingsniuose kaip {{name}}. JSONPath palaikomas tiek, kiek pakanka įprastiems API atsakams.
07Ar palaikote GraphQL ir WebSocket?+
GraphQL veikia kaip įprasta HTTP POST užklausa – užklausą siunčiate turinyje, o grąžintą JSON patikrinate – tačiau specialaus GraphQL kūrimo įrankio nėra. WebSocket nepalaikomas: API stebėjimas apima tik užklausas ir atsakus per HTTP (GET, POST, PUT, PATCH, DELETE, HEAD).
08Ar galiu importuoti cURL komandą arba pradėti nuo paruošto šablono?+
Šioje versijoje – ne. Kiekvieną žingsnį kuriate redaktoriuje: metodas, URL, antraštės, turinys, tikrinimai, ištraukos – žingsnį galima dubliuoti, kad dirbtumėte greičiau. cURL importo ir šablonų bibliotekos API stebėjime kol kas nėra.
09Kaip apsisaugoma nuo netikrų pavojaus signalų?+
Nepavykusi patikra pirmiausia kartojama iš kitų vietų, o incidentas atveriamas tik tada – pagal numatytuosius nustatymus turi sutapti trys vietos (pirminė ir dvi pakartotinės), kad gautumėte pranešimą. Atsistatymas vyksta greičiau: viena sėkminga patikra uždaro incidentą ir išsiunčia atsistatymo pranešimą.
10Ar mano API raktai patikroje saugūs?+
Taip. Prisijungimo duomenis saugokite kaip slaptus kintamuosius – jie tik įrašomi, nuskaitant užmaskuojami ir pašalinami iš rodomų URL, antraščių bei atsakų ištraukų, tad į patikrų istoriją niekas jautraus nepatenka.
11Ar API stebėjimas yra mokamas priedas?+
Ne. API stebėjimas įtrauktas į visus planus kartu su veikimo, SSL, operacijų, DNS ir veikimo signalų stebėjimu – niekada kaip papildoma mokama paslauga. Net nemokamame plane yra vienas API stebėjimas; planai skiriasi tik jų skaičiumi, o 30 dienų nemokamas bandymas apima iki 50, kreditinės kortelės nereikia.

Pradėkite stebėti savo API dar šiandien.

Sukurkite grandinę, patikrinkite ją realiame galiniame taške – ir kitą kartą, kai kuris nors žingsnis sutriks, įspėjimas iškart pasakys, kuris.

Pradėkite nemokamą bandymą →
30 dienų nemokamas bandymas Iki 50 API stebėjimų Be kreditinės kortelės Atitinka BDAR
API stebėjimas prisijungia prie veikimo, SSL, greičio, operacijų, DNS ir veikimo signalų stebėjimo – viskas po vienu Uptimia prisijungimu.