Naar hoofdinhoud springen

Handleidingen / Monitoringhandleidingen: elk checktype, stap voor stap

Hoe u API-monitoring instelt in HostTracker

Een API-check bevraagt een endpoint op dezelfde manier als een HTTP-check, en gaat dan een stap verder: hij parseert de responsebody als JSON, XML of platte tekst en valideert een specifieke waarde daarbinnen, in plaats van alleen de statuscode. Gebruik hem voor een REST- of SOAP-endpoint waarvan u een waarde wilt toetsen, bijvoorbeeld een statusveld, een voorraadaantal of een prijs. Wilt u alleen bevestigen dat een URL laadt en een acceptabele status teruggeeft, dan is een HTTP-check de eenvoudigere keuze.

Hoofdinstellingen

Er is geen screenshot van dit onderdeel voor het checktype API, maar het gebruikt dezelfde gedeelde regelaars als elk ander checktype. Monitoring ingeschakeld is de hoofdschakelaar aan/uit. Intervalschema (1 minuut tot 24 uur, schuif of keuzelijst) of een Cronschema-bouwer (elke N minuten/uur, dagelijks, wekelijks, maandelijks, of een aangepaste expressie, alleen betaald pakket) bepaalt hoe vaak de check draait. Timeout is 1 tot 100 seconden; de DNS-resolutietijd telt niet mee. Tags zijn door komma's gescheiden labels om te groeperen en te filteren. Volledig log bewaart elk resultaat in plaats van identieke opeenvolgende resultaten te groeperen, en Open statistieken publiceert de statistieken en het log van de taak op een openbare link. Anders dan bij HTTP heeft het API-formulier geen DNSBL-schakelaar (DNSBL blijft alleen bestaan voor Http/Ping/Port); het bevat wel dezelfde kaarten Domeinverloop, Certificaatverloop en Web Risk, die elk om de 12 uur draaien - verloopherinneringen volgen uw Up-abonnementen hieronder, een slecht resultaat volgt Down/Repeat.

Verzoekconfiguratie

Paneel Verzoekconfiguratie voor een API-check: keuzelijst HTTP-methode ingesteld op GET, de doorverwijzingsselector ingesteld op Redirects volgen met een schuif Max redirects op 20, een lege HTTP Headers-tabel, schakelaar Verzoekauthenticatie, keuzelijst DNS-serverselectie, en schakelaar DNS-cache uitschakelen
  • HTTP-methode - GET, HEAD, POST, PUT, DELETE of PATCH. GET (standaard) is vereist om een responsebody te lezen en te analyseren; HEAD haalt alleen headers op.
  • Request body (alleen POST/PUT/PATCH) - Raw body verstuurt precies wat u typt (voeg uw eigen Content-Type-header toe om json/xml/plaintext te omschrijven); POST parameters accepteert één KEY=VALUE per regel en wordt verstuurd als een form-urlencoded body.
  • Doorverwijzingsgedrag - Onmiddellijk antwoord beoordeelt het eerste antwoord zoals het is; Redirects volgen (standaard) volgt de keten, met een schuif Max redirects te volgen (1-20); Redirect is fout laat de check falen bij elke redirect (niet beschikbaar onder assertion mode).
  • HTTP Headers - aangepaste naam/waarde-paren, met suggesties voor veelgebruikte API-headernamen en -waarden (Content-Type, Authorization, X-API-Key, Bearer/Basic-voorvoegsels en meer). Leeg gelaten stuurt de probe standaardheaders (User-Agent, Accept, Accept-Language, een Referer).
  • Verzoekauthenticatie - toont gebruikersnaam/wachtwoord voor de eigen HTTP-challenge-authenticatie van de server (Basic, Digest, NTLM, Kerberos, Negotiate). Voor een bearer-token of API-sleutel voegt u in plaats daarvan hierboven een Authorization-header toe.
  • DNS-serverselectie - Standaard-DNS-servers per locatie; Publieke DNS-servers van het land van de locatie; of Handmatig ingestelde DNS-servers (uw eigen resolver-IP's). De laatste twee vereisen een betaald pakket.
  • DNS-cache uitschakelen - dwingt bij elke check een verse DNS-opzoeking af in plaats van de cache van de agent te hergebruiken.

Antwoordvalidatie

Paneel Antwoordvalidatie voor een API-check met assertion mode uit: een infobanner die assertion mode aanprijst, velden Ignore HTTP Errors en Error on these HTTP statuses, Response format ingesteld op JSON analysis, een leeg Selector-veld, What to check ingesteld op Check the obtained value itself, Condition ingesteld op any (no validation), en het begin van de lijst HTTP Policies

Standaard slaagt een check wanneer DNS resolvt, de verbinding en de TLS-handshake (voor https) voltooien, de server een HTTP Ok-status teruggeeft, en de respons parseert als het hieronder gekozen formaat.

  • Assertion mode - de screenshot toont hem uit, met een banner die u uitnodigt hem aan te zetten voor regels op basis van statuscode, responstijd, header of body-inhoud. API en HTTP zijn de enige twee checktypen met een werkende assertion-editor; zie de diepgaande uitleg van assertion mode voor de volledige regeltaal. Zolang hij uit staat, bepalen de klassieke velden hieronder de uitslag.
  • Ignore HTTP Errors - statuscodes die de check NIET mogen laten falen, bijvoorbeeld 401, 403, 500; leeg betekent dat elke code vanaf 400 een fout is.
  • Error on these HTTP statuses - het omgekeerde: codes die de check wel moeten laten falen, ook als ze dat normaal niet zouden doen.
  • Response format - hoe de body wordt geparseerd voordat de selector draait: JSON analysis (JSONPath of eigenschapselector, geselecteerd getoond in de screenshot), XML analysis (XPath-query), of String analysis (regex met capture). GET is vereist om een body te lezen.
  • Selector - haalt een waarde uit de geparseerde respons; laat leeg om de hele respons als waarde te gebruiken.
  • What to check - standaard beoordeelt de conditie hieronder de geselecteerde waarde zelf (Check the obtained value itself); schakel over naar Check the value change between checks, of een verandering per seconde/minuut, om in plaats daarvan te beoordelen hoeveel de waarde is veranderd.
  • Condition - vergelijkt de waarde: any (no validation) (standaard, getoond in de screenshot), equal to, not equal to, in set of, out of set, less than, less or equal, greater than, greater or equal, in range, out of range, absent in content, of json null. Elke conditie behalve de laatste twee heeft een vergelijkingswaarde nodig die u eronder invult.
  • HTTP Policies - dezelfde optionele header-, cookie- en contentchecks als bij het checktype HTTP: Enforce HTTPS, HSTS-header, geen https-naar-http-downgrade, CSP, clickjacking-bescherming, X-Content-Type-Options, Referrer-Policy, Permissions-Policy, geen versie-onthulling, Cache-Control-assertions, CORS-responseheaders, cookiebeveiliging en gemengde content. De presets Baseline, Strict en API vervangen de hele selectie; een overtreding laat de check net als elke andere mislukking als Down eindigen.
  • TLS-handshake - vier strengheidsschakelaars (betaald pakket): een geldige SSL-certificaatketen vereisen, TLS 1.2 of hoger vereisen, zwakke ciphers (128-bit of lager) blokkeren, en certificaatintrekking controleren.
  • Expected IPs validation - bevestigt bij elke check dat DNS uw host herleidt naar een van de IP's die u opgeeft, en vangt zo kaping of een verouderd record op, ook al antwoordt er nog steeds een server.
  • Max response size - stopt met het lezen van de body voorbij deze grootte, zodat de parser en de selector alleen het gedownloade deel zien. Standaard 1 MB, maximaal 10 MB; 0 leest geen body.

Een opmerking bij de screenshots hierboven: die zijn gemaakt op een account waarvan het pakket het checktype API niet bevat, waardoor het typeselectieveld daar "not in your package" toonde. Dat is een eigenaardigheid van het testaccount, geen weergave die u zelf zult zien - elk veld en elke standaardwaarde hierboven is verder precies wat het formulier toont.

Waarschuwingsabonnementen

Paneel Waarschuwingsabonnementen: schakelaar Alle contacten abonneren op Up/Down-gebeurtenissen aan, een zoekveld voor contacten, en één e-mailcontact met de schakelaars Down, Up en Repeat allemaal actief

Gedeeld door elk checktype. Down = het endpoint faalde de check, Up = het herstelde, Repeat = herinneringen terwijl het down blijft. Alle contacten abonneren op Up/Down-gebeurtenissen is een snelkoppeling; de tabel geeft controle per contact, individueel of via herbruikbare contactgroep-presets. Een taak zonder waarschuwingsabonnementen draait en logt nog steeds resultaten - hij waarschuwt alleen nooit iemand.

Rapportabonnementen

Paneel Rapportabonnementen: schakelaar Alle contacten abonneren op Weekly/Monthly-rapporten aan, en één e-mailcontact met de schakelaars Weekly en Monthly actief en Daily beschikbaar

Periodieke uptimerapporten, alleen per e-mail. Kies Daily, Weekly of Monthly per contact; Monthly bundelt ook Quarterly- en Yearly-samenvattingen. De alles-abonneren-schakelaar werkt hetzelfde als bij Waarschuwingsabonnementen.

Monitoringlocaties

Paneel Monitoringlocaties: een doorzoekbare locatieboom met All world, North America, Russia en West Europe geselecteerd en hun aantal agents, plus de keuzelijsten Hercontrolestrategie en Als geselecteerde locaties onbeschikbaar zijn eronder
  • Locatiekiezer - doorzoek of blader door de regio-/landenboom en vink locaties aan om vanaf te controleren; elke rij toont beschikbare agents versus geselecteerde agents. "Locaties kopiëren van een andere taak" hergebruikt een bestaande set.
  • Hercontrolestrategie - bij een statusovergang (bijvoorbeeld Up naar Down) bevestigen meerdere locaties die eerst opnieuw voordat de nieuwe status wordt geaccepteerd, wat beschermt tegen een valse melding vanuit één regio. Opties: standaard meerderheidsstemming; een vastgesteld aantal locaties dat Down bevestigt (voegt een schuif 1-7 toe); geen hercontrole; volledige overeenstemming van elke hercontrolelocatie; of volledige overeenstemming voor Down, meerderheidsstemming voor Up.
  • Als geselecteerde locaties onbeschikbaar zijn - Alleen geselecteerde locaties (standaard) wacht liever dan een valse melding te riskeren; Dichtstbijzijnde locaties gebruikt de dichtstbijzijnde beschikbare locatie; Elke locatie valt wereldwijd terug.

Uitgewerkt voorbeeld

Een JSON-statusendpoint monitoren: API-check, interval van 5 minuten, timeout van 40s, GET, Redirects volgen (max 20). Response format JSON analysis, Selector $.status, What to check "the obtained value itself", Condition "equal to" met vergelijkingswaarde ok. Ignore HTTP Errors leeg gelaten. Monitoringlocaties op All world gelaten met de standaard hercontrolestrategie. Het e-mailadres van het wachtdienstteam geabonneerd op Down, Up en Repeat, en op Weekly-rapporten.

Probleemoplossing

  • De check slaagt altijd, ook al is het endpoint duidelijk kapot - Condition staat standaard op any (no validation), wat alleen parsing en transport beoordeelt, niet de waarde zelf. Kies een echte conditie en vergelijkingswaarde zodra u weet hoe een gezonde respons eruitziet.
  • Selector geeft niets terug - controleer of Response format overeenkomt met wat het endpoint teruggeeft (JSON versus XML versus platte tekst); een JSONPath-selector op een XML-body matcht nooit. Laat Selector eerst leeg om te bevestigen dat de hele respons doorkomt, en verfijn dan.
  • Een numerieke Condition (greater than, in range, enz.) geeft een fout - die heeft nodig dat de geselecteerde waarde naar een getal converteert. Een selector die naar een string wijst, of een change-modus-berekening zonder nog een vorige check, geeft niets om te vergelijken.
  • Ging Down vlak na het inschakelen van HTTP Policies (vooral Strict) - Strict verwacht headers die veel API's niet hebben ingesteld. Herstel de headers, ga terug naar Baseline, of draai de policies eerst als aparte taak.
  • De selector vindt geen waarde meer bij een grote respons - Max response size kapt de body af, zodat niets voorbij de afkap de parser of de selector bereikt. Verhoog de waarde.

Gerelateerd

Nu controleren

Voer de gratis check uit op je eigen site, zonder account.

Web api validation

Dit permanent monitoren

Ontvang een melding zodra er iets misgaat: HostTracker controleert vanaf meer dan 300 locaties en waarschuwt je via e-mail, sms, Slack, Telegram en meer.

HostTracker-functies

Meer in dit onderdeel: Monitoringhandleidingen: elk checktype, stap voor stap