نظارت بر API
مانیتورهای API هر ۳۰ ثانیه یک درخواست HTTP قابل پیکربندی به یک نقطه پایانی میفرستند و وقتی در دسترس نباشد، کند باشد یا داده نادرست برگرداند به شما هشدار میدهند. متد، هدرها، بدنه و احراز هویت در اختیار شماست و میتوانید کد وضعیت، بدنه JSON، هدرها و زمان پاسخ را بسنجید.
مانند سایر مانیتورها، اگر مانیتور API مشکلی را شناسایی کند، میتوانید با تیمتان برای حل حادثه کار کنید و بهدلخواه صفحه وضعیت خود را بهروزرسانی کنید.
مانیتور API چه چیزی را بررسی میکند؟
- آزمودن نقاط پایانی API از موقعیتهای گوناگون در سراسر جهان، هر ۳۰ ثانیه.
- اعتبارسنجی کدهای وضعیت HTTP، بدنه JSON، هدرها و زمان پاسخ.
- افزودن هدرهای سفارشی، پارامترهای پرسوجو یا محتوای JSON.
- دریافت اعلان فوری در صورت قطع بودن، کند بودن یا برگرداندن نتیجه غیرمنتظره توسط یک نقطه پایانی.
- یکپارچهسازی با Slack، ایمیل، پیامک، تماس تلفنی، وبهوک و موارد دیگر.
چگونه مانیتور API اضافه کنم؟
به پروژه خود → مانیتورها → افزودن مانیتور بروید، API را انتخاب کنید، URL نقطه پایانی را وارد کنید، درخواست را پیکربندی کنید و شرطهایی را تعیین کنید که نشان میدهند نقطه پایانی سالم است.
نوع مانیتور
API را بهعنوان نوع مانیتور انتخاب کنید.
نشانی نقطه پایانی مورد نظر را وارد کنید — برای نمونه،
https://api.yourservice.com/v1/users.
پیکربندی درخواست
میتوانید درخواست API خود را کاملاً سفارشی کنید:
- روش HTTP:
GET،POST،PUT،PATCH،DELETE،OPTIONSیاHEAD - بدنه: همراه درخواست، JSON، داده فرم، GraphQL یا متن ساده بفرستید
- احرازهویت: احرازهویت پایه، کلید API یا مجوز توکن Bearer اضافه کنید
- پارامترهای پرسوجو: جفتهای کلید/مقدار را به نشانی درخواست بیفزایید
- هدرها: هدرهای سفارشی لازم برای درخواست API خود را اضافه کنید
مانیتور موفق است اگر
مانیتور API زمانی موفق است که همه گزارههای مشخصشده برآورده شوند.
میتوانید یک یا چند مورد از گزارههای زیر را تنظیم کنید:
- کد وضعیت: مثلاً پاسخ
200 OKباشد - زمان پاسخ: مثلاً کمتر از
۱ ثانیه - بدنه شامل باشد: مثلاً
"success": true - مسیر JSON: مثلاً
data.statusبرابر"active"باشد - هدر شامل باشد: مثلاً
Content-Type: application/json
اگر هر یک از این شرطها برقرار نباشد، مانیتور قطع علامت میخورد و هشدارها بر اساس تنظیمات هشدار شما فرستاده میشوند.
تنظیمات پیشرفته
- نام نمایشی: نامی گویا به مانیتورتان بدهید تا شناساییاش آسانتر باشد.
- اجرای بررسیها هر: تعیین کنید نقطه پایانی هر چند وقت آزموده شود.
- اجرا از: موقعیتهای آزمون را انتخاب کنید (ایالات متحده، کانادا، اروپا، آسیا).
- افزودن به صفحه وضعیت: زمان فعالیت و آمار پاسخ API را عمومی نمایش دهید.
- وقتی مانیتور دچار خطا میشود: حادثهای آغاز کنید، به مشترکان اطلاع دهید یا در صفحه وضعیت منتشر کنید.
- وقتی مانیتور بازیابی میشود: حوادث را حل کنید و صفحه وضعیت را بهصورت خودکار بهروزرسانی کنید.