Ana içeriğe geç

Rehberler / İzleme rehberleri: her kontrol türü, adım adım kurulum

HostTracker'da API İzleme Nasıl Kurulur

Bir API kontrolü, bir uç noktayı tıpkı bir HTTP kontrolünün yaptığı gibi ister, sonra bir adım daha ileri gider: yanıt gövdesini JSON, XML veya düz metin olarak ayrıştırır ve yalnızca durum kodunu değil, içindeki belirli bir değeri doğrular. Bunu, üzerinde doğrulama yapmak istediğiniz verisi olan bir REST veya SOAP uç noktası için kullanın; örneğin bir durum alanı, bir stok sayısı veya bir fiyat. Yalnızca bir URL'nin yüklendiğini ve kabul edilebilir bir durum döndürdüğünü doğrulamanız gerekiyorsa, bir HTTP kontrolü daha basit bir seçimdir.

Ana Ayarlar

API türü için bu bölümde ekran görüntüsü yoktur, ama her diğer kontrol türüyle aynı paylaşılan kontrolleri kullanır. İzleme etkin, ana açma/kapama anahtarıdır. Aralık programı (1 dakikadan 24 saate, kaydırıcı veya açılır menü) veya bir Cron programı oluşturucusu (her N dakikada/saatte, günlük, haftalık, aylık, veya özel bir ifade, yalnızca ücretli plan) kontrolün ne sıklıkla çalıştığını denetler. Zaman aşımı 1 ile 100 saniye arasıdır; DNS çözümleme süresi sayılmaz. Etiketler, gruplama ve filtreleme için virgülle ayrılmış etiketlerdir. Tam Kayıt, aynı ardışık sonuçları gruplamak yerine her sonucu kaydeder, ve Açık İstatistikler görevin istatistiklerini ve kaydını genel bir bağlantıda yayınlar. HTTP'nin aksine, API formunda bir DNSBL anahtarı yoktur (DNSBL yalnızca Http/Ping/Port için kalıcıdır); yine de aynı Alan Adı Sona Erme, Sertifika Sona Erme ve Web Riski kartlarını taşır, her biri 12 saatte bir çalışır - sona erme hatırlatmaları aşağıdaki Up aboneliklerinizi izler, kötü bir sonuç Down/Repeat'i izler.

İstek Yapılandırması

Bir API kontrolü için İstek Yapılandırması paneli: GET olarak ayarlanmış HTTP Yöntemi açılır menüsü, 20'de bir Maksimum yönlendirme kaydırıcısıyla Yönlendirmeleri izle olarak ayarlanmış yönlendirme davranışı seçici, boş bir HTTP Başlıkları tablosu, İstek Kimlik Doğrulaması anahtarı, DNS Sunucu Seçimi açılır menüsü, ve DNS önbelleğini devre dışı bırak anahtarı

  • HTTP Yöntemi - GET, HEAD, POST, PUT, DELETE veya PATCH. Bir yanıt gövdesini okumak ve analiz etmek için GET (varsayılan) gereklidir; HEAD yalnızca başlıkları getirir.
  • İstek gövdesi (yalnızca POST/PUT/PATCH) - Ham gövde, tam olarak yazdığınızı gönderir (json/xml/düz metni tarif etmek için kendi Content-Type başlığınızı ekleyin); POST parametreleri satır başına bir KEY=VALUE kabul eder ve form-urlencoded bir gövde olarak gönderilir.
  • Yönlendirme davranışı - Anlık yanıt, ilk yanıtı olduğu gibi değerlendirir; Yönlendirmeleri izle (varsayılan) zinciri izler, bir İzlenecek maksimum yönlendirme kaydırıcısıyla (1-20); Yönlendirme hatadır, herhangi bir yönlendirmede başarısız olur (onay modu altında kullanılamaz).
  • HTTP Başlıkları - yaygın API başlık adları ve değerleri için veri listesi önerileriyle özel ad/değer çiftleri (Content-Type, Authorization, X-API-Key, Bearer/Basic önekleri ve daha fazlası). Boş bırakıldığında, prob varsayılan başlıkları gönderir (User-Agent, Accept, Accept-Language, bir Referer).
  • İstek kimlik doğrulaması - sunucunun kendi HTTP zorlama kimlik doğrulaması (Basic, Digest, NTLM, Kerberos, Negotiate) için kullanıcı adı/parola alanlarını ortaya çıkarır. Bir taşıyıcı token veya API anahtarı için, bunun yerine yukarıya bir Authorization başlığı ekleyin.
  • DNS Sunucu Seçimi - Konumlardaki varsayılan DNS sunucuları; Konumun ülkesinin genel DNS sunucuları; veya Elle tanımlanmış DNS sunucuları (kendi çözümleyici IP'leriniz). Son ikisi ücretli plan gerektirir.
  • DNS önbelleğini devre dışı bırak - aracının önbelleğini yeniden kullanmak yerine her kontrolde taze bir DNS sorgusu zorlar.

Yanıt Doğrulama

Onay modu kapalıyken bir API kontrolü için Yanıt Doğrulama paneli: onay modunu tanıtan bir bilgi bandı, HTTP Hatalarını Yoksay ve Bu HTTP durumlarında hata ver alanları, JSON analizi olarak ayarlanmış Yanıt biçimi, boş bir Seçici alanı, Elde edilen değerin kendisini kontrol et olarak ayarlanmış Neyin Kontrol Edileceği, herhangi biri (doğrulama yok) olarak ayarlanmış Koşul, ve HTTP Politikaları listesinin başlangıcı

Varsayılan olarak bir kontrol, DNS çözüldüğünde, bağlantı ve TLS el sıkışması (https için) tamamlandığında, sunucu bir HTTP Ok durumu döndürdüğünde, ve yanıt aşağıda seçilen biçimde ayrıştırıldığında başarılı sayılır.

  • Onay modu - ekran görüntüsü kapalı olduğunu gösterir, durum kodu, yanıt süresi, başlık veya gövde içeriği kuralları için onu açmanızı davet eden bir bantla. API ve HTTP, çalışan bir onay düzenleyicisine sahip yalnızca iki kontrol türüdür; tam kural dili için onay modu derinlemesine incelemesine bakın. Kapalıyken, aşağıdaki klasik alanlar sonucu yönlendirir.
  • HTTP Hatalarını Yoksay - kontrolü BAŞARISIZ YAPMAMASI gereken durum kodları, örneğin 401, 403, 500; boş, 400 ve üzeri her kodun bir hata olduğu anlamına gelir.
  • Bu HTTP durumlarında hata ver - tersi: normalde başarısız olmasa bile kontrolü başarısız yapması gereken kodlar.
  • Yanıt biçimi - seçici çalışmadan önce gövdenin nasıl ayrıştırıldığı: JSON analizi (JSONPath veya özellik seçici, ekran görüntüsünde seçili gösterilir), XML analizi (XPath sorgusu), veya Metin analizi (yakalamalı regex). Bir gövdeyi okumak için GET gereklidir.
  • Seçici - ayrıştırılmış yanıttan bir değer seçer; tüm yanıtı değer olarak kullanmak için boş bırakın.
  • Neyin Kontrol Edileceği - varsayılan olarak aşağıdaki koşul seçilen değerin kendisini değerlendirir (Elde edilen değerin kendisini kontrol et); bunun yerine değerin ne kadar hareket ettiğini değerlendirmek için Kontroller arasındaki değer değişikliğini kontrol et'e, veya saniye/dakika başına bir değişim oranına geçin.
  • Koşul - değeri karşılaştırır: any (no validation) (varsayılan, ekran görüntüsünde gösterilir), 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, veya json null. Son ikisi hariç her koşul, altına girilen bir karşılaştırma değeri gerektirir.
  • HTTP Politikaları - HTTP kontrol türüyle aynı isteğe bağlı başlık/çerez/içerik kontrolleri: Enforce HTTPS, HSTS başlığı, https'den http'ye düşürme yok, CSP, tıklama hırsızlığı koruması, X-Content-Type-Options, Referrer-Policy, Permissions-Policy, sürüm ifşası yok, Cache-Control onayları, CORS yanıt başlıkları, çerez güvenliği ve karışık içerik. Baseline, Strict ve API ön ayarları tüm seçimin yerini alır; bir ihlal, kontrolü diğer her başarısızlık gibi Down olarak sonuçlandırır.
  • TLS El Sıkışması - dört katılık anahtarı (ücretli plan): geçerli bir SSL sertifika zinciri gerektir, TLS 1.2 veya üstünü gerektir, zayıf (128 bit veya altı) şifrelemeleri engelle, ve sertifika iptalini kontrol et.
  • Beklenen IP'ler onayı - DNS'in ana bilgisayarınızı her kontrolde listelediğiniz IP'lerden birine çözdüğünü doğrular, bazı sunucular hâlâ yanıt verirken bile ele geçirmeyi veya eski bir kaydı yakalar.
  • Maksimum yanıt boyutu - gövdeyi bu boyutun ötesinde okumayı durdurur, bu yüzden ayrıştırıcı ve seçici yalnızca indirilen kısmı görür. Varsayılan 1 MB, maksimum 10 MB; 0 hiçbir gövde okumaz.

Yukarıdaki ekran görüntüleri hakkında bir not: paketi API kontrol türünü içermeyen bir hesapta çekildi, bu yüzden oradaki tür seçim alanı "paketinizde değil" olarak okunuyordu. Bu, test hesabının bir yapaydır, göreceğiniz bir şey değil - burada tarif edilen her alan ve varsayılan, aksi takdirde formun tam olarak gösterdiği şeydir.

Uyarı Abonelikleri

Uyarı Abonelikleri paneli: Tüm kişileri Up/Down olaylarına abone et anahtarı açık, bir kişi arama kutusu, ve Down, Up ve Repeat geçiş düğmelerinin hepsi etkin olan bir e-posta kişisi

Her kontrol türü tarafından paylaşılır. Down = uç nokta kontrolü başarısız oldu, Up = kurtarıldı, Repeat = Down durumundayken hatırlatmalar. Tüm kişileri Up/Down olaylarına abone et bir kısayoldur; tablo kişi başına kontrol verir, tek tek veya yeniden kullanılabilir kişi grubu ön ayarları aracılığıyla. Uyarı aboneliği olmayan bir görev yine de çalışır ve sonuçları kaydeder - yalnızca kimseye bildirim göndermez.

Rapor Abonelikleri

Rapor Abonelikleri paneli: Tüm kişileri Haftalık/Aylık raporlara abone et anahtarı açık, ve Haftalık ve Aylık geçişleri etkin, Günlük kullanılabilir olan bir e-posta kişisi

Periyodik çalışma süresi raporları, yalnızca e-posta. Kişi başına Günlük, Haftalık veya Aylık seçin; Aylık ayrıca Üç Aylık ve Yıllık özetleri de paketler. Tümünü abone et anahtarı, Uyarı Abonelikleri'ndeki gibi çalışır.

İzleme Konumları

İzleme Konumları paneli: Tüm dünya, Kuzey Amerika, Rusya ve Batı Avrupa seçili ve aracı sayıları gösteren aranabilir bir konum ağacı, artı altında Yeniden kontrol stratejisi ve Seçili konumlar kullanılamazsa açılır menüleri

  • Konum seçici - bölge/ülke ağacını arayın veya gözden geçirin ve kontrol edilecek konumları işaretleyin; her satır mevcut aracıları seçili aracılarla karşılaştırır. "Konumları başka bir görevden kopyala", mevcut bir kümeyi yeniden kullanır.
  • Yeniden kontrol stratejisi - bir durum geçişinde (örneğin Up'tan Down'a), bir bölgeden yanlış pozitife karşı koruma sağlayarak, birkaç konum yeni durumu kabul edilmeden önce yeniden doğrular. Seçenekler: varsayılan çoğunluk oyu; Down'ı onaylayan belirtilen sayıda konum (1-7 kaydırıcı ekler); yeniden kontrol yok; her yeniden kontrol konumunun tam anlaşması; veya Down için tam anlaşma, Up için çoğunluk oyu.
  • Seçili konumlar kullanılamazsa - Yalnızca seçili konumlar (varsayılan), yanlış bir uyarı riski almak yerine bekler; En yakın konumlar en yakın kullanılabilir konumu kullanır; Herhangi bir konum dünya çapına geri döner.

Uygulamalı örnek

Bir JSON durum uç noktasını izlemek: API kontrolü, 5 dakikalık aralık, 40 saniyelik zaman aşımı, GET, Yönlendirmeleri izle (maksimum 20). Yanıt biçimi JSON analizi, Seçici $.status, Neyin Kontrol Edileceği "elde edilen değerin kendisi", Koşul "eşittir" karşılaştırma değeri ok ile. HTTP Hatalarını Yoksay boş bırakıldı. İzleme Konumları varsayılan yeniden kontrol stratejisiyle Tüm dünya'da bırakıldı. Nöbetçi ekibin e-postası Down, Up ve Repeat'e, ve Haftalık raporlara abone edildi.

Sorun giderme

  • Uç nokta açıkça bozukken bile kontrol her zaman geçiyor - Koşul varsayılan olarak any (no validation)'dır, ki bu yalnızca ayrıştırmayı ve taşımayı değerlendirir, değerin kendisini değil. Sağlıklı bir yanıtın nasıl göründüğünü öğrendikten sonra gerçek bir koşul ve karşılaştırma değeri seçin.
  • Seçici hiçbir şey döndürmüyor - Yanıt biçiminin uç noktanın döndürdüğüyle eşleştiğini doğrulayın (JSON'a karşı XML'e karşı düz metin); bir XML gövdesine karşı bir JSONPath seçici asla eşleşmez. Tüm yanıtın geldiğini doğrulamak için önce Seçiciyi boş bırakın, sonra daraltın.
  • Sayısal bir Koşul (büyüktür, aralıkta, vb.) hata veriyor - seçilen değerin bir sayıya dönüşmesi gerekir. Bir dizeye işaret eden bir seçici, veya henüz önceki bir kontrolü olmayan bir değişim modu hesaplaması, karşılaştıracak hiçbir şey vermez.
  • HTTP Politikaları'nı (özellikle Strict'i) etkinleştirdikten hemen sonra Down oldu - Strict, birçok API'nin yapılandırmadığı başlıkları bekler. Başlıkları düzeltin, Baseline'a düşün, veya politikaları önce ayrı bir görev olarak çalıştırın.
  • Seçici büyük bir yanıtta bir değer bulmayı durduruyor - Maksimum yanıt boyutu gövdeyi keser, bu yüzden kesim noktasının ötesindeki hiçbir şey ayrıştırıcıya veya seçiciye ulaşmaz. Onu yükseltin.

İlgili

Şimdi kontrol edin

Ücretsiz kontrolü kendi sitenizde çalıştırın - hesap gerekmez.

Web api validation

Bunu sürekli izleyin

Bir sorun çıktığı anda haberdar olun: HostTracker 300’den fazla konumdan kontrol eder ve size e-posta, SMS, Slack, Telegram ve daha fazlasıyla bildirim gönderir.

HostTracker özellikleri

Bu bölümde daha fazlası: İzleme rehberleri: her kontrol türü, adım adım kurulum