پایش API فرآیند جمعآوری، بصریسازی و ارسال هشدار بر اساس دادههای تلهمتری API است تا اطمینان حاصل شود درخواستهای API همانطور که انتظار میرود پردازش میشوند.
APIها اجزای حیاتی زیرساخت برنامههای مدرن هستند؛ آنها میکروسرویسهای داخلی را به هم متصل میکنند، مسیرهای حیاتی کاربران را پشتیبانی میکنند و دادهها و قابلیتها را در اختیار مصرفکنندگان شخص ثالث قرار میدهند. به همین دلیل، پایش API نقش مهمی در کمک به تیمها برای شناسایی مشکلات مرتبط با API، مانند خطاها، تأخیر (latency) و آسیبپذیریهای امنیتی، پیش از آنکه تشدید شوند و بر سرویسهای وابسته، شرکا و مشتریان اثر منفی بگذارند، ایفا میکند. در حالی که تست API برای پشتیبانی از تکرار سریع در مرحله توسعه طراحی شده است، هدف اصلی پایش API کاهش میانگین زمان رفع مشکل (MTTR) برای مسائل قابل مشاهده توسط مصرفکننده در محیط تولید است.
در ادامه، نقش پایش API در دنیای API-first، رایجترین موارد استفاده از پایش API، شاخصهای کلیدی عملکرد API که باید تحت نظر باشند، و این که Postman چگونه میتواند به پیادهسازی یک استراتژی جامع پایش API کمک کند را بررسی میکنیم.
چرا پایش API در دنیای API-first حیاتی است؟
در سالهای اخیر، بسیاری از سازمانها برنامههای یکپارچه (monolithic) خود را به میکروسرویسهایی با مدیریت مستقل تقسیم کردهاند که معمولاً روی زیرساختهای مبتنی بر ابر اجرا میشوند و از طریق APIهای داخلی با یکدیگر ارتباط برقرار میکنند. برنامههای مبتنی بر میکروسرویس معمولاً مقیاسپذیرتر و مقرونبهصرفهتر از نمونههای یکپارچه هستند، اما روابط وابستگی آنها نیز میزان قابلتوجهی پیچیدگی ایجاد میکند. برای مثال، یک تغییر بهظاهر کوچک در API یک میکروسرویس میتواند پیامدهای غیرمنتظرهای برای میکروسرویسهایی که به آن وابستهاند داشته باشد.
علاوه بر استفاده از APIها برای اتصال میکروسرویسهای داخلی، برخی سازمانها شروع به ارائه APIهای خود بهعنوان محصولات قابل فروش به مصرفکنندگان شخص ثالث کردهاند. در این مدل که با عنوان «API بهعنوان محصول» شناخته میشود، تولیدکنندگان API مسئول پایبندی به توافقنامههای سطح خدمت (SLA) در زمینه دسترسپذیری، عملکرد و امنیت هستند و بروز مشکل میتواند اعتماد مشتری را تضعیف کرده و به ریزش منجر شود.
این تغییرات گسترده در صنعت همزمان با افزایش محبوبیت مدل توسعه API-first رخ دادهاند؛ مدلی که در آن تیمها پیش از توسعه برنامهها و یکپارچهسازیهایی که به API وابستهاند، ابتدا APIها را توسعه میدهند. این استراتژی در پاسخ به نگرانیها درباره APIهایی که طراحی یا پیادهسازی ضعیفی دارند شکل گرفت؛ APIهایی که اغلب قادر به پاسخگویی به نیازهای سرویسهای وابسته نیستند. پایش API یک رویکرد سیستماتیک برای حفظ کیفیت API ارائه میدهد و به همین دلیل، یکی از ستونهای حیاتی رویکرد API-first به شمار میرود. APIهای حاصل، مقاوم، ساده برای استفاده و مجهز به توانایی مقابله با چالشهای ذاتی معماریهای مبتنی بر میکروسرویس و مدل API بهعنوان محصول هستند.
موارد استفاده اصلی پایش API کداماند؟
هر سازمان متفاوت است و باید استراتژی پایش API را متناسب با نیازهای خاص خود پیادهسازی کند. با این حال، چندین مورد استفاده وجود دارد که تقریباً برای هر تیمی کاربردی است:
۱. اطمینان از سالم ماندن درخواستهای منفرد در طول زمان
اصلیترین مورد استفاده پایش API، اطمینان از این است که درخواستها به یک API در گذر زمان همچنان طبق انتظار عمل میکنند. این موضوع بهویژه برای تیمهای توسعه چابک اهمیت دارد که ممکن است چندین بار در روز تغییرات کد را منتشر کنند. پایش API به این تیمها کمک میکند خطاها و افت عملکرد را بهمحض وقوع شناسایی کنند تا پیش از اثرگذاری بر مصرفکنندگان و مشتریان، اصلاح لازم را اعمال کنند.
۲. اعتبارسنجی مسیرهای چندمرحلهای کاربران
برخی از حیاتیترین جریانهای کاری از نظر کسبوکار، شامل زنجیرهای از درخواستها هستند و گاهی چندین API را در بر میگیرند. بنابراین، یک استراتژی مؤثر پایش API به تیمها امکان میدهد این جریانهای کاری پیچیده را بهصورت سیستماتیک اجرا کنند و نتایج را در هر مرحله تحت نظر بگیرند.
۳. آگاهی از مشکلات در APIهای شخص ثالث
اگر تیمی نتواند منبع یک مشکل را شناسایی کند، ممکن است API شخص ثالث عامل آن باشد. این تیمها میتوانند برای endpointهای شخص ثالثی که از آنها استفاده میکنند مانیتور تعریف کنند تا از عیبیابی مشکلاتی که خارج از کنترل آنهاست جلوگیری شود.
۴. شناسایی آسیبپذیریهای امنیتی
یک API ناامن میتواند نقطه ورود مهاجمان باشد، بنابراین مهم است تیمها APIهای خود را بهطور مداوم از نظر آسیبپذیریها پایش کنند. این فرآیند شامل پیکربندی و اجرای بررسیهای امنیتی در مرحله توسعه، خطوط CI/CD و محیط تولید است.
شاخصهای کلیدی برای پایش API کداماند؟
APIها مجموعهای از سیگنالها تولید میکنند که میتوانند بینش مهمی درباره سلامت و عملکرد آنها ارائه دهند. با این حال، انتخاب ابزاری برای پایش اهمیت دارد که نهتنها نمایی کلی از دادههای عملکردی ارائه دهد، بلکه امکان فیلترکردن بر اساس ابعاد کلیدی مانند نام درخواست، منطقه و محیط را نیز فراهم کند تا دامنه یک مشکل بهدرستی درک شود. مهمترین شاخصهایی که باید پایش شوند عبارتاند از:
خطاها (Errors): انواع مختلفی از خطاهای API و دلایل بروز آنها وجود دارد، اما افزایش ناگهانی در تعداد یا درصد خطاها نشان میدهد API بهطور گسترده در دسترس کاربران خود نیست.
تأخیر (Latency): این شاخص به مدتزمان لازم برای بازگشت پاسخ به یک درخواست اشاره دارد و اصلیترین نشانگر عملکرد API است. تیمها باید تأخیر درخواستهای منفرد و همچنین تأخیر کل تمام درخواستها در یک جریان کاری را پایش کنند. اگر برای یک درخواست خاص که معمولاً پاسخ یکسانی دارد تأخیر بالا مشاهده شود، پیادهسازی کش یا بهینهسازی کوئری پایگاه داده میتواند مفید باشد. اگر تأخیر کل یک جریان کاری افزایش یافته اما درخواست غیرعادی خاصی وجود ندارد، ممکن است نیاز به تأمین مجدد منابع سرور یا پایگاه داده باشد.
نتایج تستها: تستهای API ابتدا در مرحله توسعه چرخه عمر API نوشته و اضافه میشوند، اما اغلب در اجراهای پایش سطح تولید نیز مورد استفاده قرار میگیرند. تستها رفتار و تراکنشهای API را اعتبارسنجی میکنند و افزایش تعداد تستهای ناموفق میتواند نشاندهنده این باشد که یک انتشار اخیر با نسخههای قبلی سازگار نیست.
برخی بهترین شیوههای پایش API کداماند؟
یک استراتژی پایش API زمانی بیشترین موفقیت را خواهد داشت که متناسب با نیازهای منحصربهفرد کسبوکاری که از آن پشتیبانی میکند طراحی شود. با این حال، بهترین شیوههای زیر به ایجاد APIهایی با دسترسپذیری پایدار و عملکرد بالا در هر سازمانی کمک میکنند:
پایش زیرساخت پشتیبان:
در حالی که پایش سلامت و دسترسپذیری endpointهای API حیاتی است، برخی مشکلات مرتبط با API از لایههای دیگر پشته فناوری ناشی میشوند. برای مثال، یک پایگاه داده با منابع ناکافی یا قطعی شبکه میتواند باعث افزایش غیرمنتظره تأخیر یا خطاهای API شود. بنابراین باید دامنه پایش را فراتر از مرزهای مستقیم API گسترش داد تا مشکلات قابل مشاهده برای مصرفکننده سریعتر رفع شوند.
جستوجوی روندهای تاریخی در دادههای پایش:
علاوه بر کمک به تیمها برای شناسایی مشکلاتی که نیاز به توجه فوری دارند، دادههای پایش API میتوانند روندهای بلندمدتی را آشکار کنند که به مدیران در اتخاذ تصمیمهای مبتنی بر داده کمک میکند.
ارسال هشدارهای خودکار به ابزارهای ارتباطی:
اگر تیم مجبور باشد وضعیت مانیتورها را بهصورت دستی بررسی کند، استراتژی پایش API مؤثر نخواهد بود. بنابراین تیمها باید از قابلیتهای هشداردهی و یکپارچهسازی با ابزارهای ارتباطی استفاده کنند تا در صورت مشاهده فعالیت نگرانکننده، بهطور خودکار مطلع شوند.
بازبینی و بازنگری استراتژی پایش:
نیازهای کسبوکار و فناوری پشتیبان آنها دائماً در حال تغییر است. به همین دلیل، مهم است استراتژی پایش بهطور منظم بازبینی شود تا همواره مؤثر و بهروز باقی بماند.
