شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات
این بخش ، API Monitoring را با Edge Analytics مقایسه میکند. اگرچه هر دو API Monitoring و Edge Analytics به شما امکان جمعآوری و مشاهده دادههای API را میدهند، اما اهداف متفاوتی دارند:
- هدف از نظارت بر API این است که اطمینان حاصل شود API های شما طبق برنامه در حال اجرا هستند. برای این منظور، شما میخواهید جدیدترین دادههای موجود را ببینید. نظارت بر API دادههایی را ارائه میدهد که بسیار نزدیک به زمان واقعی هستند و به شما امکان میدهد هشدارهایی ایجاد کنید که در صورت بروز مشکل به شما اطلاع دهند.
- هدف Edge Analytics درک رفتار بلندمدت APIهای شماست تا بتوانید اطمینان حاصل کنید که آنها از الزامات کسبوکار شما پشتیبانی میکنند یا در صورت لزوم تغییراتی ایجاد کنید. برای این اهداف، مشاهده دادههای بلادرنگ اهمیت کمتری دارد. در نتیجه، دادههای Analytics کمی تأخیر دارند، هرچند معمولاً حداکثر 10 دقیقه.
توجه داشته باشید که دادههای مانیتورینگ API، که عمدتاً مربوط به کدهای خطا و تأخیر است، زیرمجموعه کوچکی از دادههای Analytics را تشکیل میدهد.
تفاوتهای بین دادههای مانیتورینگ API و دادههای تحلیلی
این بخش برخی از تفاوتهای جزئی بین دادههای جمعآوریشده توسط Edge Analytics در مقابل API Monitoring را شرح میدهد. از آنجایی که API Monitoring و Analytics از خطوط داده متفاوتی استفاده میکنند، ممکن است تفاوتهای جزئی بین گزارشهای سفارشی تولید شده توسط Monitoring و گزارشهای تولید شده توسط Analytics مشاهده کنید. به عنوان مثال، ممکن است در نتایج گزارش شده برای خطاهای timeout - هم timeoutهای backend (کد وضعیت HTTP 504 در درخواست) و هم timeoutهای کلاینت (کد وضعیت HTTP 499) - اختلافاتی مشاهده کنید. این موارد ممکن است با کد وضعیت 200 در گزارشهای سفارشی Analytics ظاهر شوند، اما در گزارشهای سفارشی Monitoring با کد وضعیت 504 یا 499 نمایش داده میشوند.نظارت بر API
مانیتورینگ API، بینشهای بلادرنگ (real-time) از عملکرد API ارائه میدهد و به شما کمک میکند تا به سرعت مشکلات را تشخیص داده و برطرف کنید تا APIهای شما طبق برنامه کار کنند.
نظارت بر API شما را قادر میسازد تا:
- افزایش در دسترس بودن API و کاهش میانگین زمان تشخیص (MTTD).
- قبل از اینکه مصرفکنندگان تحت تأثیر قرار گیرند، اقدامات مناسب را بر اساس هشدارهای زمینهای انجام دهید.
- برای سرعت بخشیدن به تشخیص، از کدهای خطای Apigee استفاده کنید.
- برای تشخیص خطا، عملکرد و مشکلات تأخیر و منبع آنها، به سرعت حوزههای مشکلدار را جدا کنید.
تحلیلهای API لبه
Edge API Analytics اطلاعاتی را که از طریق APIها جریان دارد، جمعآوری و تجزیه و تحلیل میکند. API Analytics اطلاعاتی مانند موارد زیر را ثبت میکند:
- روند ترافیک API شما در طول زمان چگونه است؟
- کدام اپلیکیشنها برای شما برتر هستند؟
- توسعهدهندگان برتر شما چه کسانی هستند؟
- کدام متدهای API محبوبتر هستند؟
- چه زمانی زمان پاسخگویی API سریعترین/کندترین است؟
- از نظر جغرافیایی بیشترین ترافیک API را در کجا مشاهده میکنید؟
دادههای جمعآوریشده توسط API Analytics
API Analytics طیف گستردهای از دادههایی را که در APIها جریان دارند، جمعآوری و تجزیه و تحلیل میکند. به عنوان مثال، در حالی که API شما مستقر است، Analytics دائماً تعداد پیامهای دریافتی، تعداد توسعهدهندگان، زمان پاسخگویی، خطاها، تعداد برنامههای در حال استفاده، اندازه درخواست و بسیاری از دادههای دیگر را ثبت میکند.
برای آشنایی بیشتر با معیارها و نحوه استفاده از آنها، به «استفاده از APIهای معیارها برای اندازهگیری عملکرد برنامه API» مراجعه کنید. برای فهرست کامل معیارها، به مرجع معیارهای تحلیلی، ابعاد و فیلترها مراجعه کنید.
جمعآوری معیارهای سفارشی
همچنین میتوانید با استفاده از سیاست StatisticsCollector، معیارهای سفارشی را جمعآوری کنید. سیاست StatisticsCollector میتواند اطلاعات را از هدرهای درخواست، بارهای XML/JSON، پارامترهای پرسوجو، URIها و سایر مکانها برای تجزیه و تحلیل و تولید گزارش در سرور Analytics بنویسد.
دسترسی به دادههای تحلیلی
پس از تولید، میتوانید با استفاده از ابزارهای تجسم API Analytics، از جمله داشبورد، گزارشهای سفارشی و GeoMap، به معیارهای از پیش تعریف شده و معیارهای سفارشی دسترسی پیدا کنید. برای اطلاعات بیشتر در مورد ابزارهای تجسم ارائه شده توسط API Analytics، به داشبوردهای Analytics مراجعه کنید. برای اطلاعات بیشتر در مورد گزارشهای سفارشی، به ایجاد گزارشهای سفارشی مراجعه کنید.
مقایسه مانیتورینگ API و آنالیز API
توسعهدهندگان API از هر دو روش API Monitoring و API Analytics استفاده میکنند. یکی از تفاوتهای اصلی بین این دو، مکانیزم هشدار تعبیهشده در API Monitoring است. هشدارها به تیم عملیاتی شما اجازه میدهند تا به مشکلات مربوط به APIهای شما در زمان واقعی پاسخ دهند تا اطمینان حاصل شود که APIهای شما در دسترس هستند و مطابق انتظار عمل میکنند.
شرایط هشدار، کدهای وضعیت خاص (2xx/4xx/5xx)، آستانههای تأخیر و کد خطا را تعریف میکنند که در صورت تجاوز از آنها، هشدارهای بصری در رابط کاربری فعال میشوند و اعلانها را از طریق کانالهای مختلفی مانند ایمیل، slack، pagerduty یا webhooks ارسال میکنند. میتوانید هشدارها را در سطح محیط، پروکسی API یا سرویس هدف یا سطح منطقه تنظیم کنید.
پس از فعال شدن هشدار، تیم عملیاتی شما میتواند از رابط کاربری مانیتورینگ API برای بررسی مشکل و ریشهیابی آن استفاده کند. سپس میتوانید یک گزارش سفارشی ایجاد کنید که شامل اطلاعات از پیش تعریفشده در مورد هشدار باشد، مانند:
- زمان پاسخ کل
- زمان پاسخگویی هدف
- خطاهای پروکسی
- خطاهای هدف
- درخواست UUID
- بسیاری دیگر
API Analytics به گونهای طراحی شده است که طیف گستردهای از دادهها را برای استفاده توسط چندین تیم جمعآوری کند. به عنوان مثال:
- تیم عملیات میتواند از دادههای تحلیلی برای شناسایی دورههای ترافیک بالا یا پایین استفاده کند تا بتواند خدمات شما را متناسب با تقاضاهای متغیر، افزایش یا کاهش دهد.
- تیم بازاریابی میتواند از دادههای تحلیلی برای تعیین الگوهای استفاده مشتری که توسط APIها، برنامهها، مشتریان یا سایر دادهها شناسایی شدهاند، استفاده کند.
- همه تیمها میتوانند به دادههای سفارشی جمعآوریشده از یک درخواست دسترسی داشته باشند تا اطلاعات خاصی مانند مقادیر هدر، پارامترهای پرسوجو یا بار درخواست را ردیابی کنند.