البرنامج التعليمي: مراقبة واجهات برمجة التطبيقات المنشورة

  • مقالة

ينطبق على: جميع مستويات إدارة واجهة برمجة التطبيقات

يمكنك باستخدام Azure Monitor تصور المقاييس أو السجلات الواردة من خدمة Azure API Management والاستعلام عنها وتوجيهها وأرشيفها واتخاذ إجراءات بشأنها.

في هذا البرنامج التعليمي، تتعلم كيفية:

  • عرض مقاييس واجهة برمجة التطبيقات
  • إعداد قاعدة تنبيه
  • عرض سجلات النشاط
  • تمكين سجلات الموارد وعرضها

إشعار

تدعم APIM مجموعة من الأدوات الإضافية لمراقبة واجهات برمجة التطبيقات، بما في ذلك التحليلات المضمنة والتكامل مع Application Insights. معرفة المزيد

المتطلبات الأساسية

عرض مقاييس واجهات برمجة التطبيقات

تصدر APIM مقاييس كل دقيقة، مما يمنحك رؤية شبه آنية لحالة واجهات برمجة التطبيقات وصحتها. فيما يلي المقياسان الأكثر استخدامًا. للحصول على قائمة بجميع المقاييس المتوفرة، راجع المقاييس المدعومة.

  • السعة - تساعدك على اتخاذ قرارات حول ترقية/تخفيض خدمات APIM الخاصة بك. يتم إصدار المقياس في الدقيقة ويعكس سعة البوابة المقدرة في وقت إعداد التقارير. يتراوح المقياس من 0-100 محسوبة استنادًا إلى موارد العبارة مثل وحدة المعالجة المركزية واستخدام الذاكرة.
  • الطلبات - يساعدك على تحليل حركة مرور واجهة برمجة التطبيقات التي تمر عبر خدمات APIM الخاصة بك. يتم إصدار المقياس كل دقيقة، كما يبلغ بعدد طلبات البوابة مع الأبعاد. تصفية الطلبات حسب رموز الاستجابة والموقع واسم المضيف والأخطاء.

هام

تم إهمال المقاييس التالية اعتبارًا من شهر مايو 2019، وسيتم سحبها في أغسطس 2023: إجمالي طلبات العبارة، طلبات العبارة الناجحة، وطلبات العبارة غير المصرح بها، وطلبات العبارة الفاشلة، وطلبات العبارة الأخرى. الرجاء الترحيل إلى مقياس الطلبات الذي يوفر وظيفة مكافئة.

لقطة شاشة للمقاييس في نظرة عامة على API Management

للوصول إلى المقاييس:

  1. في مدخل Azure، انتقل إلى مثيل API Management الخاص بك. في صفحة Overview ، في علامة التبويب Monitor ، راجع المقاييس الرئيسية لواجهات برمجة التطبيقات الخاصة بك.

  2. للتحقيق في المقاييس بالتفصيل، حدد Metrics من القائمة اليسرى.

    لقطة شاشة لعنصر Metrics في قائمة Monitoring في المدخل.

  3. من القائمة المنسدلة، حدد المقاييس التي تهتم بها. على سبيل المثال، الطلبات.

  4. يوضح المخطط إجمالي عدد استدعاءات واجهة برمجة التطبيقات. اضبط النطاق الزمني للتركيز على فترات الاهتمام.

  5. يمكن تصفية المخطط باستخدام أبعاد مقياس الطلبات. على سبيل المثال، حدد Add filter، وحدد Backend Response Code Category، وأدخل 500 كقيمة. يظهر المخطط عدد الطلبات التي فشلت في واجهة برمجة التطبيقات الخلفية.

إعداد قاعدة تنبيه

يمكنك تلقي تنبيهات استنادا إلى المقاييس وسجلات النشاط. في Azure Monitor، قم بتكوين قاعدة تنبيه لتنفيذ إجراء عند تشغيله. تتضمن الإجراءات الشائعة ما يلي:

  • إرسال إشعار بالبريد الإلكتروني
  • استدعاء إخطارات على الويب
  • استدعاء Azure Logic App

لتكوين مثال على القاعدة التنبيه استنادًا إلى مقياس طلب:

  1. في مدخل Azure، انتقل إلى مثيل API Management الخاص بك.

  2. حدد Alerts من القائمة اليسرى.

    لقطة شاشة لخيار التنبيهات في قائمة المراقبة في المدخل.

  3. حدد + Create>Alert rule.

  4. في نافذة تحديد إشارة على علامة التبويب الشرط :

    1. في Signal type، حدد Metrics.
    2. في Signal name، حدد Requests.
    3. في منطق التنبيه، حدد قيمة الحد، وهي عدد التكرارات التي يجب تشغيل التنبيه بعدها.
    4. في Split by dimensions، في Dimension name، حدد Gateway Response Code Category.
    5. في قيم الأبعاد، حدد 4xx، لأخطاء العميل مثل الطلبات غير المصرح بها أو غير الصالحة. إذا لم تظهر قيمة البعد، فحدد إضافة قيمة مخصصة وأدخل 4xx.
    6. في متى يتم التقييم، اقبل الإعدادات الافتراضية، أو حدد إعدادات أخرى لتكوين عدد مرات تشغيل القاعدة. حدد التالي.

    لقطة شاشة لتكوين منطق التنبيه في المدخل.

  5. في علامة التبويب إجراءات، حدد أو أنشئ مجموعة إجراءات واحدة أو أكثر لإعلام المستخدمين بالتنبيه واتخاذ إجراء. على سبيل المثال، أنشئ مجموعة إجراءات جديدة لإرسال إشعار بالبريد الإلكتروني إلى admin@contoso.com. للحصول على خطوات مفصلة، راجع إنشاء مجموعات الإجراءات وإدارتها في مدخل Microsoft Azure.

    لقطة شاشة لتكوين الإعلامات لمجموعة إجراءات جديدة في المدخل.

  6. في علامة التبويب Details في Create an alert rule، أدخل اسما ووصفا لقاعدة التنبيه وحدد مستوى الخطورة.

  7. تكوين الإعدادات المتبقية اختياريا. ثم، في علامة التبويب Review + create ، حدد Create.

  8. الآن، اختبر قاعدة التنبيه عن طريق استدعاء Conference API بدون مفتاح واجهة برمجة التطبيقات. على سبيل المثال:

    curl GET https://apim-hello-world.azure-api.net/conference/speakers HTTP/1.1

    يتم تشغيل تنبيه استنادًا إلى فترة التقييم، وسيرسل بريدًا إلكترونيًا إلى admin@contoso.com.

    تظهر التنبيهات أيضا في صفحة التنبيهات لمثيل APIM.

    لقطة شاشة للتنبيهات في المدخل.

سجلات الأنشطة

توفر سجلات النشاط نظرة ثاقبة على العمليات في خدمات API Management. باستخدام سجلات النشاط، يمكنك تحديد "ماذا، من، ومتى" لأي عمليات الكتابة (PUT، POST، DELETE) التي تم أخذها على خدمات API Management.

إشعار

لا تتضمن سجلات النشاط عمليات القراءة (GET) أو العمليات التي يتم تنفيذها في مدخل Azure أو استخدام API Management الأصلية.

يمكنك الوصول إلى سجلات الأنشطة في خدمة API Management أو الوصول إلى سجلات كافة موارد Azure في Azure Monitor.

لقطة شاشة لسجل النشاط في المدخل.

لعرض سجل النشاط:

  1. في مدخل Azure، انتقل إلى مثيل API Management الخاص بك.

  2. اختر Activity log.

    لقطة شاشة لعنصر سجل النشاط في قائمة المراقبة في المدخل.

  3. حدد نطاق التصفية المطلوب ثم تطبيق.

سجلات الموارد

توفر سجلات الموارد (سجلات Azure Monitor) معلومات غنية حول عمليات APIM والأخطاء المهمة لأغراض التدقيق واستكشاف الأخطاء وإصلاحها. عند تمكينها من خلال إعداد تشخيصي، تجمع السجلات معلومات حول طلبات واجهة برمجة التطبيقات التي يتم تلقيها ومعالجتها بواسطة بوابة APIM.

إشعار

لا يدعم مستوى الاستهلاك مجموعة سجلات الموارد.

لتكوين سجلات الموارد:

  1. في مدخل Azure، انتقل إلى مثيل API Management الخاص بك.

  2. حدد Diagnostic settings.

    لقطة شاشة لعنصر إعدادات التشخيص في قائمة المراقبة في المدخل.

  3. حدد + Add diagnostic setting.

  4. حدد السجلات أو المقاييس التي تريد جمعها.

    لديك العديد من الخيارات حول مكان إرسال السجلات والمقاييس. على سبيل المثال، أرشفة سجلات الموارد جنبا إلى جنب مع المقاييس إلى حساب تخزين، أو دفقها إلى مركز أحداث، أو إرسالها إلى مساحة عمل Log Analytics.

    تلميح

    إذا حددت مساحة عمل Log Analytics، يمكنك اختيار تخزين البيانات في جدول ApiManagementGatewayLogs الخاص بالموارد أو التخزين في جدول AzureDiagnostics العام. نوصي باستخدام الجدول الخاص بالموارد لوجهات السجل التي تدعمه. معرفة المزيد

  5. بعد تكوين تفاصيل وجهة السجل أو الوجهات، حدد حفظ.

إشعار

قد تؤدي إضافة كائن إعداد تشخيص إلى فشل إذا تم تعيين الخاصية MinApiVersion لخدمة APIM إلى أي إصدار API أعلى من 2022-09-01-preview.

لمزيد من المعلومات، راجع إنشاء إعدادات التشخيص لإرسال سجلات النظام الأساسي والمقاييس إلى وجهات مختلفة.

تخزين وعرض البيانات التشخيصية في مساحة تخزين Azure

إذا قمت بتمكين مجموعة من السجلات أو المقاييس في مساحة عمل Log Analytics، فقد يستغرق ظهور البيانات في Azure Monitor بضع دقائق.

لعرض بيانات :

  1. في مدخل Azure، انتقل إلى مثيل API Management الخاص بك.

  2. حدد Logs من القائمة اليسرى.

    لقطة شاشة لعنصر السجلات في قائمة المراقبة في المدخل.

  3. تشغيل الاستعلامات لعرض البيانات. يتم توفير عدة استعلامات نموذجية ، أو تشغيل استعلامات خاصة بك. على سبيل المثال، يسترد الاستعلام التالي أحدث 24 ساعة من البيانات من جدول ApiManagementGatewayLogs:

    ApiManagementGatewayLogs
| where TimeGenerated > ago(1d)

    لقطة شاشة للاستعلام عن جدول ApiManagementGatewayLogs في المدخل.

لمزيد من المعلومات حول استخدام سجلات الموارد لـ API Management، راجع:

تعديل إعدادات تسجيل واجهة برمجة التطبيقات

بشكل افتراضي، عند إنشاء إعداد تشخيص لتمكين مجموعة سجلات الموارد، يتم تمكين التسجيل لجميع واجهات برمجة التطبيقات، مع الإعدادات الافتراضية. يمكنك ضبط إعدادات التسجيل لجميع واجهات برمجة التطبيقات، أو تجاوزها لواجهات برمجة التطبيقات الفردية. على سبيل المثال، اضبط معدل أخذ العينات أو إسهاب البيانات، أو قم بتعطيل التسجيل لبعض واجهات برمجة التطبيقات.

للحصول على تفاصيل حول إعدادات التسجيل، راجع مرجع إعدادات التسجيل التشخيصي.

لتكوين إعدادات التسجيل لجميع واجهات برمجة التطبيقات:

  1. في القائمة اليسرى لمثيل APIM، حدد واجهات برمجة التطبيقات>جميع واجهات برمجة التطبيقات.
  2. حدد علامة التبويب الإعدادات من الشريط العلوي.
  3. مرر لأسفل إلى قسم Diagnostic Logs ، وحدد علامة التبويب Azure Monitor .
  4. راجع الإعدادات وقم بإجراء تغييرات إذا لزم الأمر. حدد حفظ.

لتكوين إعدادات التسجيل لواجهة برمجة تطبيقات معينة:

  1. في القائمة اليسرى لمثيل APIM، حدد واجهات برمجة التطبيقات ثم اسم واجهة برمجة التطبيقات.
  2. حدد علامة التبويب الإعدادات من الشريط العلوي.
  3. مرر لأسفل إلى قسم Diagnostic Logs ، وحدد علامة التبويب Azure Monitor .
  4. راجع الإعدادات وقم بإجراء تغييرات إذا لزم الأمر. حدد حفظ.

الخطوات التالية

في هذا البرنامج التعليمي، نتعلم طريقة القيام بما يأتي:

  • عرض مقاييس واجهة برمجة التطبيقات
  • إعداد قاعدة تنبيه
  • عرض سجلات النشاط
  • تمكين سجلات الموارد وعرضها

تقدم إلى البرنامج التعليمي الآتي:

تتبع المكالمات