إنشاء تقارير مخصّصة

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

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

إنشاء تقرير مخصّص استنادًا إلى السياق

ويمكنك إنشاء التقارير المخصّصة بسرعة استنادًا إلى السياق كما هو موضّح في الجدول التالي. في صفحة التقارير المخصّصة، تتم تسمية التقارير المخصّصة التي يتم إنشاؤها باستخدام "مراقبة واجهة برمجة التطبيقات" بشكلٍ فريد (تلقائيًا)، كما هو موضّح في الجدول، ويمكنك تغيير الاسم عند تعديل التقرير المخصّص.

سياق التقرير المخصَّص	اصطلاح التسمية التلقائي للتقرير المخصّص
لوحة البيانات الأخيرة	API Monitoring Recent Generated
لوحة بيانات المخطط الزمني	API Monitoring Timeline Generated
التحقيق في لوحة البيانات	API Monitoring Investigate Generated
حالة التنبيه	API Monitoring Generated: alert-name

السمة والمقاييس التلقائية

سيتضمن التقرير المخصص السمات والمقاييس المدرجة في الجدول التالي لجميع التقارير التي تم إنشاؤها من خلال مراقبة واجهة برمجة التطبيقات، وذلك بشكل تلقائي.

المكوِّن	الإعدادات التلقائية
الأبعاد	عنوان URI للطلب
المقاييس	إجمالي وقت الاستجابة وقت الاستجابة المستهدَف أخطاء الخادم الوكيل أخطاء الاستهداف

تعديل التقرير المخصّص

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

في التقرير المخصّص التالي، يمكنك إضافة سمة Gateway Flow ID المحدّدة مسبقًا، حيث يحتوي Gateway Flow ID على المعرّف الفريد العالمي لكل طلب من واجهة برمجة التطبيقات يتم إجراؤه على Edge. تجدر الإشارة إلى أنّ التقرير يستخدِم السمة Request URI:

يُضيف المثال التالي السمة Client ID إلى التقرير المخصّص. تحتوي السمة Client ID على مفتاح المستهلك (مفتاح واجهة برمجة التطبيقات) للمطوّر الذي يطلب البيانات من واجهة برمجة التطبيقات، سواء تم تمريره في الطلب كمفتاح واجهة برمجة التطبيقات أو تم تضمينه في رمز OAuth المميز:

يحتوي التقرير المخصّص على معلومات عن جميع قيم Client ID. يضيف المثال التالي فلترًا يتيح لك إنشاء تقرير مخصّص لملف Client ID محدّد:

للحصول على مزيد من المعلومات عن جميع السمات والمقاييس المحدّدة مسبقًا التي يمكنك إضافتها إلى تقرير معيّن، اطّلِع على مرجع المقاييس والسمات والفلاتر في "إحصاءات Google".

في المثال التالي، يمكنك إضافة فلتر إلى تقرير مخصّص يسجِّل المقاييس والسمات التلقائية لرمز خطأ policies.ratelimit.QuotaViolation ورموز الحالة 5xx:

للحصول على التفاصيل الكاملة عن كيفية تعديل تقرير مخصّص، يُرجى الاطّلاع على مقالة إدارة التقارير المخصّصة.

مثال: استخدام التقارير المخصّصة لتشخيص مشاكل النشر

أرفِق سياسة StatisticsCollector بالخوادم الوكيلة لواجهة برمجة التطبيقات لجمع بيانات الإحصاءات المخصصة، مثل معرِّف المستخدم أو المنتج، والسعر، وإجراء REST، والإصدار المستهدف، وعنوان URL المستهدف، وطول الرسالة. ويمكن أن تأتي البيانات من متغيّرات التدفق المحدَّدة مسبقًا من خلال Apigee أو عناوين الطلبات أو مَعلمات طلب البحث أو المتغيرات المخصَّصة التي تحدِّدها.

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

curl -H "prodid:123456" -H "userid:98765" -H "targetversion:beta" http://myapi.com/myapi

يمكنك بعد ذلك استخدام المعلومات الواردة في العناوين للمساعدة في تشخيص مشاكل وقت التشغيل المتعلقة بالخادم الوكيل لواجهة برمجة التطبيقات.

لإنشاء تقرير مخصّص لهذه العناوين:

1. أضِف سياسة StatisticsCollector إلى واجهة برمجة التطبيقات لتسجيل قيمة العناوين المُخصَّصة:

   <StatisticsCollector name="publishPurchaseDetails">
     <Statistics>
       <Statistic name="prodid" ref="request.header.prodid" type="integer">0</Statistic>
       <Statistic name="userid" ref="request.header.userid" type="integer">0</Statistic>
       <Statistic name="targetversion" ref="request.header.targetversion" type="string">alpha</Statistic>
     </Statistics>
   </StatisticsCollector>
   

2. انشر الخادم الوكيل وامنحه وقتًا كافيًا للوصول إليه.

3. انقر على تحليل > مراقبة واجهة برمجة التطبيقات > الأحدث في واجهة مستخدم Edge لعرض أي مشاكل في واجهة برمجة التطبيقات. لاحظ أنك تظهر لك أخطاء 4xx و5xx للخادم الوكيل myapi:

   

4. اختَر صف الخادم الوكيل myapi لعرض المزيد من التفاصيل في الجزء الأيسر من لوحة البيانات الحديثة.

5. في الجزء الأيسر من لوحة البيانات "الأخيرة"، اختَر > عرض في التحقيق للوصول إلى لوحة بيانات التحقيق:

   

6. يمكنك فلترة لوحة البيانات "التحقيق في لوحة البيانات" حسب الخادم الوكيل myapi، ثم الاطّلاع على رمز الحالة في أعلى رسم بياني. لاحظ أنك تظهر لك أخطاء 403 و501:

   

7. في واجهة مستخدم Edge، اختر إحصاءات Google > التقارير المخصّصة > التقارير لإنشاء تقرير مخصّص يتضمّن قيم هذه المقاييس المخصّصة على أنّها سمة.

8. اختَر + تقرير مخصّص لإنشاء تقرير مخصّص باسم myapi_errors.

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

10. حدّد مكوّن رمز حالة الاستجابة المحدّد مسبقًا، ثم أضف الإحصاءات المخصّصة الثلاثة prodid وtargetersion وuserid إلى الأبعاد:

    

11. اضبط الفلتر لتضمين بيانات الخادم الوكيل لواجهة برمجة التطبيقات myapi فقط (apiproxy eq 'myapi'):

    

12. احفظ التقرير.

13. تنفيذ التقرير خلال آخر 24 ساعة عند فتح التقرير لأول مرة، سيظهر لك رسم بياني لأخطاء HTTP 403 و501:

    

14. ضمن الملخّص، انقر على 403 أو 510 لمعرفة المنتج الذي يتسبّب في حدوث الأخطاء. على سبيل المثال، اختَر 403:

    

15. انقر على معرّف منتج ضمن ملخّص للاطّلاع على الأخطاء حسب الإصدار المستهدَف (الإصدار الأولي أو الإصدار التجريبي):

    

16. انقر على إصدار مستهدف ضمن ملخّص للاطّلاع على الأخطاء حسب المستخدم: