درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
سناریو نمونه‌ای را گام‌به‌گام دنبال کنید که نشان می‌دهد چگونه مشکلات 5xx را با APIهای خود عیب‌یابی کنید.
| # | مرحله | شرح |
|---|---|---|
| 1 | پایش ترافیک اخیر میانای برنامه‌سازی کاربردی | داده‌های پایش API اخیر را برای همه پراکسی‌های API و هدف‌هایی که در ساعت گذشته ترافیک داشته‌اند مشاهده کنید. در کارگزاران یا هدف‌های میانای برنامه‌سازی کاربردی با نرخ درصد خطای بالا دقیق شوید. |
| 2 | شناسایی روندهای موجود در داده‌های پایش «میانای برنامه‌سازی کاربردی» | برای به‌دست آوردن دیدگاهی گسترده‌تر، به نمای تاریخی داده‌های پایش API خود تا ۳ ماه گذشته دسترسی پیدا کنید. |
| 3 | بررسی مشکلات 5xx | کدهای خطایی را که درطول زمان بیشترین حجم نسبی را دارند مشاهده کنید تا منبع مشکلات 5xx را بیشتر بررسی کنید. (معمولاً، کدهای وضعیت 5xx را می‌توان بااستفاده از یک یا چند کد خطا طبقه‌بندی کرد.) |
| 4 | راه‌اندازی هشدار 5xx | هشدار راه‌اندازی کنید تا وقتی تعداد کدهای وضعیت ۵xx از آستانه خاصی فراتر رفت مطلع شوید. |
| 5 | تولید گزارش سفارشی با جزئیات مشتری (اختیاری) | به‌صورت اختیاری، گزارش سفارشی تولید کنید تا جزئیات مربوط به کارخواهی که خطاهای ۵xx را راه‌اندازی می‌کند شناسایی کنید. توجه: برای تولید گزارش سفارشی، باید سرپرست سازمان باشید. |
| 6 | گروه‌بندی کارگزاران میانای برنامه‌سازی کاربردی در مجموعه‌ای | مجموعه‌ای برای گروه‌بندی پراکسی‌های API ایجاد کنید و مقادیر آستانه هشدار مناسبی برای همه اعضای گروه تنظیم کنید تا مشکلات را سریع‌تر تشخیص دهید.
|
| 7 | حل‌وفصل کردن مشکلات 5xx | براساس بررسی و تشخیص خرابی خود، اقدامات مناسب را برای حل مشکلات 5xx انجام دهید. |
مرحله ۱: پایش ترافیک اخیر API
برای مشاهده داده‌های پایش API برای پراکسی‌های API و هدف‌هایی که در ساعت گذشته ترافیک داشته‌اند:
- در «واسط کاربر Edge»، تجزیه‌وتحلیل > پایش API > اخیر را انتخاب کنید تا به داشبورد «اخیر» دسترسی پیدا کنید.
به پراکسی‌های API و هدف‌هایی که در ساعت گذشته نرخ درصد خطای بالایی داشته‌اند توجه کنید.
را ببینید.
روی پراکسی API یا هدف با نرخ درصد خطای بالا کلیک کنید تا جزئیات را در قاب سمت چپ مشاهده کنید. به درصد بالای خطاهای 5xx در این مثال توجه کنید.
برای اطلاعات بیشتر درباره این مرحله، پایش ترافیک اخیر «میانای برنامه‌سازی کاربردی» را ببینید.
مرحله ۲: شناسایی گرایش‌ها در داده‌های پایش «میانای برنامه‌سازی کاربردی»
برای دسترسی به نمای تاریخی داده‌های پایش API برای پراکسی‌های API و هدف‌هایی که تا سه ماه گذشته ترافیک داشته‌اند:
- در قاب سمت چپ داشبورد «اخیر»،
> مشاهده در «خط زمان» را انتخاب کنید تا به داشبورد «خط زمان» دسترسی پیدا کنید.
یا می‌توانید در «واسط کاربر Edge» روی تجزیه‌وتحلیل > پایش API > خط زمان کلیک کنید.
- روند کارگزار نیابتی API یا هدف را درطول زمان مشاهده کنید. توجه داشته باشید که این گرایش در ۷ روز گذشته ثابت بوده است.
برای اطلاعات بیشتر درباره این مرحله، شناسایی روندها در داده‌های پایش API را ببینید.
مرحله ۳: بررسی مشکلات 5xx
Apigee مجموعه‌ای از کدهای خطا را ارائه می‌دهد که به شما در تشخیص مشکلات کمک می‌کند. معمولاً، کدهای وضعیت 5xx را می‌توان بااستفاده از یک یا چند کد خطا طبقه‌بندی کرد.
برای بررسی مشکلات 5xx:
- در قاب سمت چپ داشبورد «خط زمان»، > مشاهده در «تحقیق» را انتخاب کنید تا به داشبورد «تحقیق» دسترسی پیدا کنید.
یا می‌توانید در «واسط کاربر Edge» روی تجزیه‌وتحلیل > پایش API > بررسی کلیک کنید.
داشبورد «تحقیق» به شما امکان می‌دهد فعالیت‌های رابطه‌ای بین سنجه‌ها را مقایسه کنید، مثلاً کد خطا دربرابر زمان. برای مشاهده فعالیت کد خطای یک ساعت گذشته، ماتریس کد خطا دربرابر زمان را مشاهده کنید. براساس سایه رنگ بلوک، متوجه کدهای خطایی شوید که بیشترین حجم نسبی را دارند. هرچه بلوک تیره‌تر باشد، حجم نسبی بیشتر است.
برای مثال، کدهای خطای
policies.ratelimit.SpikeArrestViolationوpolicies.ratelimit.QuotaViolationدر ماتریس زیر حجم نسبی بالاتری را نشان می‌دهند:
روی تاریک‌ترین بلوک (اولین بلوک) در ردیف
policies.ratelimit.SpikeArrestViolationکلیک کنید تا جزئیات بیشتری در قاب سمت چپ مشاهده کنید.
توجه داشته باشید که منبع خطا پراکسی API perfBenchmark_invalid_v1 و کد وضعیت HTTP 500 است. کد وضعیت ۵۰۰ یک کد خطای زمان اجرا رایج برای نقض خط‌مشی «مهار جهش» است.
برای شناسایی برنامه‌های توسعه‌دهنده با بالاترین نرخ خطا، «توزیع براساس برنامه توسعه‌دهنده» را درست در زیر پانل «علت مشکوک» مشاهده کنید.
برای اطلاعات بیشتر درباره این مرحله، شناسایی مشکلات را ببینید.
مرحله ۴: راه‌اندازی هشدار 5xx
هشدار را براساس زمینه انتخاب‌شده در قاب «جزئیات تحقیق» تنظیم کنید تا وقتی تعداد کدهای وضعیت ۵xx از آستانه مشخصی فراتر رفت، مطلع شوید.
در قاب سمت چپ داشبورد «تحقیق»،
> ایجاد هشدار را انتخاب کنید.
فیلدهای چارگوش گفتگوی هشدار را تکمیل کنید. فیلدهای وضعیت با داده‌های زمینه کنونی ازپیش تکمیل شده‌اند. برای مثال:
روی ذخیره کلیک کنید.
در آینده، وقتی نرخ خطای 5xx برای یک دوره ۵ دقیقه‌ای برای پراکسی API perfBenchmark_invalid_v1 از ۵٪ فراتر رود، اعلان به ایمیل مشخص‌شده ارسال می‌شود و هشدار تصویری در واسط کاربر نمایش داده می‌شود. برای مثال:
برای اطلاعات بیشتر درباره این مرحله، راه‌اندازی هشدارها و اعلان‌ها را ببینید.
مرحله ۵: تولید گزارش سفارشی با جزئیات مشتری (اختیاری)
به‌صورت اختیاری، گزارش سفارشی تولید کنید تا جزئیات بیشتری درباره کارخواهی که خطاهای ۵xx را راه‌اندازی می‌کند شناسایی کنید.
در صفحه گزارش‌ها، گزارش‌های سفارشی که براساس هشدار ایجاد می‌شوند بااستفاده از قالب زیر نام‌گذاری می‌شوند: API Monitoring Generated: alert-name.
به گزارش سفارشی که هنگام راه‌اندازی هشدار ایجاد شده است، به یکی از روش‌های زیر دسترسی پیدا کنید:
در نوار پیمایش سمت راست، تجزیه‌وتحلیل > گزارش‌های سفارشی > گزارش‌ها را انتخاب کنید تا صفحه «گزارش‌ها» نمایش داده شود. روی نام گزارش در فهرست کلیک کنید: API Monitoring Generated: 5xx Alert
در اعلانی که هنگام ایجاد هشدار نمایش داده می‌شود کلیک کنید. برای مثال:
ابعاد زیر را اضافه کنید:
- برنامه توسعه‌دهنده
- شناسه کارخواه
- نشانی IP کارخواه
برای مشاهده گزارشی براساس برنامه توسعه‌دهنده خاصی با نرخ خطای بالا، فیلتری مشابه فیلتر زیر اضافه کنید:
and (developer_app eq 'perfBenchmarkApp0')توجه: در این مورد، «برنامه توسعه‌دهنده» را از فهرست ابعاد بردارید.
روی ذخیره کلیک کنید.
برای مشاهده جزئیات مربوط به برنامه توسعه‌دهنده و کارگزارانی که کد وضعیت 5xx را راه‌اندازی می‌کنند، گزارش را اجرا کنید.
برای اطلاعات بیشتر درباره این مرحله، ایجاد گزارش‌های سفارشی را ببینید.
مرحله ۶: گروه‌بندی کارگزاران نیابتی API در مجموعه
مجموعه‌ای برای گروه‌بندی پراکسی‌های API ایجاد کنید و مقادیر آستانه هشدار مناسبی برای همه اعضای گروه تنظیم کنید تا مشکلات را سریع‌تر تشخیص دهید.
- در «میانای کاربر Edge»، تجزیه‌وتحلیل > پایش API > مجموعه‌ها را انتخاب کنید تا داشبورد «مجموعه‌ها» نمایش داده شود.
- روی + مجموعه کلیک کنید.
- پراکسی را انتخاب کنید.
- prod را از منوِ کرکره‌ای محیط انتخاب کنید.
- روی بعدی کلیک کنید.
- فیلدهای چارگوش گفتگوی مجموعه را تکمیل کنید.
- روی ذخیره کلیک کنید.
سپس، می‌توانید هشدار راه‌اندازی کنید، مشابه مرحله ۴، و ابعاد را روی مجموعه‌ای که در بالا تعریف کردید تنظیم کنید.
برای اطلاعات بیشتر درباره این مرحله، به مدیریت مجموعه‌ها مراجعه کنید.
مرحله ۷: حل‌وفصل کردن مشکلات ۵xx
برای رفع مشکلات 5xx، اقدامات مناسب را انجام دهید. برای مثال، براساس تشخیص خود می‌توانید یکی از تکالیف زیر را انجام دهید:
- از Apigee Sense استفاده کنید تا تشخیص دهید آیا افزایش ناگهانی درخواست‌ها مشکوک است یا نه و تصمیم بگیرید که نشانی IP کارخواه شناسایی‌شده در گزارش سفارشی را مسدود کنید.
- خط‌مشی سهمیه را اضافه کنید تا تعداد اتصالاتی را که برنامه‌های توسعه‌دهنده می‌توانند در یک دوره زمانی مشخص به پراکسی API شما برقرار کنند محدود کنید.
- از API خود درآمدزایی کنید تا توسعه‌دهندگان را برای استفاده بیش از تعداد مشخصی از تماس‌ها شارژ کنید.