إليك مثال على سيناريو محتمَل.

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
المعلومات

يمكنك الاطّلاع على نموذج سيناريو يوضّح كيفية تحديد مشاكل 5xx وحلّها في واجهات برمجة التطبيقات.

# الخطوة الوصف
1 تتبُّع عدد الزيارات الحديثة من واجهة برمجة التطبيقات عرض بيانات مراقبة واجهة برمجة التطبيقات الحديثة لجميع الخوادم الوكيلة والأهداف لواجهة برمجة التطبيقات التي تلقت زيارات خلال الساعة الماضية. التوغّل في الخوادم الوكيلة لواجهة برمجة التطبيقات أو الأهداف ذات معدّل النسبة المئوية للأخطاء المرتفع.
2 تحديد المؤشرات في بيانات مراقبة واجهة برمجة التطبيقات يمكنك الاطّلاع على عرض سابق لبيانات مراقبة واجهة برمجة التطبيقات خلال آخر 3 أشهر للاطّلاع على منظور أوسع.
3 التحقيق في مشاكل 5xx عرض رموز الأخطاء التي تواجه أكبر قدر من الأحجام النسبية بمرور الوقت لمزيد من التحقيق في مصدر مشاكل 5xx (يمكن عادةً تصنيف رموز الحالة 5xx باستخدام رمز خطأ واحد أو أكثر).
4 إعداد تنبيه 5xx يمكنك إعداد تنبيه ليتم إعلامك عندما يتجاوز عدد رموز الحالة 5xx حدًا معيّنًا.
5 إنشاء تقرير مخصّص يحتوي على تفاصيل العميل (اختياري) يمكنك إنشاء تقرير مخصّص اختياريًا لتحديد التفاصيل عن العميل الذي يتسبب في ظهور أخطاء 5xx.

ملاحظة: يجب أن تكون مشرف مؤسسة لإنشاء تقرير مخصّص.

6 تجميع الخوادم الوكيلة لواجهة برمجة التطبيقات في مجموعة يمكنك إنشاء مجموعة لتجميع الخوادم الوكيلة لواجهة برمجة التطبيقات وإعداد قيم مناسبة لحدود التنبيهات لجميع أعضاء المجموعة من أجل تشخيص المشاكل بشكل أسرع.

7 حلّ مشاكل 5xx بناءً على التحقيق والتشخيص، عليك اتخاذ الإجراءات المناسبة لحل مشاكل 5xx.

الخطوة 1: مراقبة الزيارات الواردة من واجهة برمجة التطبيقات الحديثة

لعرض بيانات مراقبة واجهة برمجة التطبيقات للخوادم الوكيلة والأهداف لواجهة برمجة التطبيقات التي حصلت على زيارات خلال آخر ساعة:

  1. حدد تحليل > مراقبة واجهة برمجة التطبيقات > الأحدث في واجهة مستخدم Edge للوصول إلى لوحة البيانات الأحدث.
  2. لاحظ أن الخوادم الوكيلة لواجهة برمجة التطبيقات والأهداف التي تضمنت معدل أخطاء مرتفع بنسبة % خلال آخر ساعة.

  3. انقر على الخادم الوكيل لواجهة برمجة التطبيقات أو الهدف الذي به معدل مرتفع للأخطاء لعرض التفاصيل في الجزء الأيسر. لاحِظ النسبة المئوية المرتفعة لأخطاء 5xx في هذا المثال.

لمزيد من المعلومات عن هذه الخطوة، يُرجى الاطّلاع على مراقبة عدد الزيارات الحديثة من واجهة برمجة التطبيقات.

الخطوة 2: تحديد المؤشرات في بيانات مراقبة واجهة برمجة التطبيقات

للوصول إلى عرض سابق لبيانات مراقبة واجهة برمجة التطبيقات للخوادم الوكيلة والأهداف لواجهة برمجة التطبيقات التي سجّلت زيارات حتى آخر ثلاثة أشهر:

  1. في الجزء الأيسر من لوحة البيانات الأخيرة، اختر قائمة المزيد > عرض في المخطط الزمني للوصول إلى لوحة بيانات المخطط الزمني. بدلاً من ذلك، يمكنك النقر على تحليل > مراقبة واجهة برمجة التطبيقات > المخطط الزمني في واجهة مستخدم Edge.
  2. اطّلِع على مؤشرات الخادم الوكيل لواجهة برمجة التطبيقات أو الاستهداف بمرور الوقت. ولاحِظ أنّ المؤشر كان ثابتًا خلال آخر 7 أيام.

لمزيد من المعلومات عن هذه الخطوة، اطّلِع على المقالة تحديد المؤشرات في بيانات مراقبة واجهة برمجة التطبيقات.

الخطوة 3: التحقيق في مشاكل 5xx

توفّر Apigee مجموعة من رموز الأخطاء التي تساعدك في تشخيص المشاكل. ويمكن عادةً تصنيف رموز الحالة 5xx باستخدام رمز خطأ واحد أو أكثر.

للتحقيق في مشاكل 5xx:

  1. في الجزء الأيسر من لوحة بيانات "المخطط الزمني"، اختَر قائمة المزيد > عرض في التحقيق للوصول إلى لوحة بيانات "التحقيق". بدلاً من ذلك، يمكنك النقر على تحليل > مراقبة واجهة برمجة التطبيقات > التحقيق في واجهة مستخدم Edge.

    تتيح لك لوحة بيانات "التحقيق" مقارنة النشاط العلائقي بين المقاييس، مثل رمز الخطأ مقابل الوقت.
  2. يمكنك عرض رمز الخطأ مقابل مصفوفة الوقت للاطّلاع على نشاط رمز الخطأ على مدار الساعة الماضية. لاحظ رموز الخطأ التي تشهد أعلى أحجام نسبية استنادًا إلى تظليل ألوان الكتلة. كلما كانت القطعة أغمق، ارتفع الحجم النسبي.

    على سبيل المثال، يُظهر رمزا الخطأ policies.ratelimit.SpikeArrestViolation وpolicies.ratelimit.QuotaViolation حجمًا نسبيًا أعلى في المصفوفة التالية: رموز الخطأ

  3. انقر على المربّع الأغمق (القالب الأول) في صف policies.ratelimit.SpikeArrestViolation لعرض المزيد من التفاصيل في اللوحة اليسرى.

  4. تجدر الإشارة إلى أنّ مصدر الخطأ هو الخادم الوكيل لواجهة برمجة التطبيقات perfBenchmark_invalid_v1، ورمز حالة HTTP هو perfBenchmark_invalid_v1. رمز الحالة 500 هو رمز خطأ شائع في وقت التشغيل لانتهاكات سياسة "إيقاف Spike".

  5. يمكنك الاطّلاع على "التوزيع حسب تطبيق المطوّر"، أسفل لوحة السبب المشتبه فيه مباشرةً، لتحديد تطبيقات المطوّرين التي تسجّل أعلى معدّلات للأخطاء.

لمزيد من المعلومات عن هذه الخطوة، اطّلِع على المقالة تحديد المشاكل.

الخطوة 4: إعداد تنبيه 5xx

يمكنك إعداد تنبيه استنادًا إلى السياق المحدّد في جزء "التحقيق في التفاصيل" ليتم إرسال إشعار إليك عند تجاوز عدد رموز الحالة 5xx حدًا معيّنًا.

  1. في الجزء الأيسر من لوحة البيانات "التحقيق"، انقر على قائمة المزيد > إنشاء تنبيه.

  2. أكمِل الحقول في مربّع حوار التنبيه. تتم تعبئة حقول الشروط تلقائيًا ببيانات من السياق الحالي. مثال:

  3. انقر على حفظ.

في المستقبل، عندما يتخطى معدّل أخطاء 5xx% 5 لمدة 5 دقائق للخادم الوكيل perfBenchmark_invalid_v1 لواجهة برمجة التطبيقات، يتم إرسال perfBenchmark_invalid_v1 إلى الرسالة الإلكترونية المحدّدة ويتم عرض perfBenchmark_invalid_v1 في واجهة المستخدم. مثال:

للحصول على مزيد من المعلومات عن هذه الخطوة، يُرجى الاطّلاع على إعداد التنبيهات والإشعارات.

الخطوة 5: إنشاء تقرير مخصّص يتضمّن تفاصيل العميل (اختيارية)

يمكنك اختياريًا إنشاء تقرير مخصّص لتحديد مزيد من التفاصيل عن العميل الذي يتسبب في ظهور أخطاء 5xx.

في صفحة "التقارير"، تتم تسمية التقارير المخصَّصة، التي يتم إنشاؤها استنادًا إلى تنبيه، باستخدام التنسيق التالي: API Monitoring Generated: alert-name.

  1. يمكنك الوصول إلى التقرير المخصّص الذي تم إنشاؤه عند إعداد التنبيه بإحدى الطرق التالية:

    • اختر تحليل > التقارير المخصّصة > التقارير في شريط التنقّل الأيمن لعرض صفحة "التقارير". انقر على اسم التقرير في القائمة: تم إنشاء مراقبة واجهة برمجة التطبيقات: تنبيه 5xx

    • انقر داخل الإشعار الذي يتم عرضه عند إنشاء التنبيه. مثال:

  2. أضِف السمات التالية:

    • تطبيق المطوّر
    • معرِّف العميل
    • عنوان IP للعميل

  3. لعرض تقرير استنادًا إلى تطبيق معيّن لمطوّر البرامج لديه معدّل أخطاء مرتفع، أضِف فلترًا مشابهًا للفلتر التالي:

    and (developer_app eq 'perfBenchmarkApp0')

    ملاحظة: في هذه الحالة، عليك إزالة "تطبيق المطوِّر" من قائمة السمات.

  4. انقر على حفظ.

  5. يمكنك تشغيل التقرير للاطّلاع على تفاصيل عن تطبيق المطوِّر والبرامج التي تؤدي إلى ظهور رمز الحالة 5xx.

لمزيد من المعلومات عن هذه الخطوة، اطّلِع على مقالة إنشاء تقارير مخصّصة.

الخطوة 6: تجميع الخوادم الوكيلة لواجهة برمجة التطبيقات في مجموعة

يمكنك إنشاء مجموعة لتجميع الخوادم الوكيلة لواجهة برمجة التطبيقات وإعداد قيم مناسبة لحدود التنبيهات لجميع أعضاء المجموعة من أجل تشخيص المشاكل بشكل أسرع.

  1. اختَر تحليل > مراقبة واجهة برمجة التطبيقات > المجموعات في واجهة مستخدم Edge لعرض لوحة بيانات المجموعات.
  2. انقر على + مجموعة مختارات.
  3. اختَر الخادم الوكيل.
  4. اختَر المنتج من القائمة المنسدلة للبيئة.
  5. انقر على Next (التالي).
  6. أكمِل الحقول في مربّع حوار المجموعة.
  7. انقر على حفظ.

بعد ذلك، يمكنك إعداد تنبيه، كما هو الحال في الخطوة 4، وضبط السمة على المجموعة التي حدّدتها أعلاه.

للحصول على مزيد من المعلومات حول هذه الخطوة، يمكنك الاطّلاع على إدارة المجموعات.

الخطوة 7: حل مشاكل 5xx

اتّخذ الإجراءات المناسبة لحل مشاكل 5xx. على سبيل المثال، وبناءً على التشخيص، يمكنك إجراء إحدى المهام التالية:

  • استخدِم Apigee Sense لتحديد ما إذا كانت الزيادة في الطلبات مريبة وتحديد ما إذا كنت تريد حظر عنوان IP للعميل المحدّد في التقرير المخصّص.
  • أضِف سياسة حصة للحدّ من عدد الاتصالات التي يمكن لتطبيقات المطوِّرين إجراؤها مع الخادم الوكيل لواجهة برمجة التطبيقات خلال فترة زمنية محدَّدة.
  • تحقيق الربح من واجهة برمجة التطبيقات لفرض رسوم على المطوّرين مقابل استخدامهم لعدد معيّن من المكالمات.