نظرة عامة على Analytics API

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلىمستندات Apigee X.
info

يعرّف هذا الموضوع على ميزة "إحصاءات Edge API".

الفيديو: شاهِد فيديو قصيرًا يقدّم نظرة عامة عن خدمات "إحصاءات Edge API".

تحسين واجهة برمجة التطبيقات من خلال الإحصاءات

تجمع ميزة "إحصاءات Edge API" وتحسب مجموعة كبيرة من المعلومات التي تتدفق عبر خوادم وكيلة لواجهة برمجة التطبيقات. يمكنك تصوُّر هذه البيانات باستخدام الرسوم البيانية في واجهة مستخدم Edge، أو يمكنك تنزيل البيانات الأولية لتحليلها بلا إنترنت باستخدام واجهات برمجة التطبيقات لإدارة Edge.

تساعدك الإحصاءات في الإجابة عن الأسئلة الشائعة، مثل:

  • كيف يتغيّر عدد الزيارات إلى واجهة برمجة التطبيقات بمرور الوقت؟
  • ما هي طرق واجهة برمجة التطبيقات الأكثر شيوعًا؟
  • من هم أهم مطوّري البرامج؟
  • متى يكون وقت استجابة واجهة برمجة التطبيقات الأسرع؟ والأبطأ؟
  • ما هي المناطق الجغرافية التي تشهد أكبر عدد من الزيارات إلى واجهة برمجة التطبيقات؟

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

تساعد "إحصاءات واجهة برمجة التطبيقات" الجميع في التحسين

من خلال عملية مستمرة لجمع البيانات وتحليلها وتصوُّرها، تساعد ميزة "إحصاءات Edge API" فريق واجهة برمجة التطبيقات في تحسين واجهات برمجة التطبيقات وتساعد مطوّري التطبيقات في تحسين تطبيقاتهم:

alt_text
  • فريق واجهة برمجة التطبيقات : يستفيد فريق واجهة برمجة التطبيقات من الأنظمة الداخلية لإنشاء واجهات برمجة تطبيقات مثيرة للاهتمام. يريد فريق واجهة برمجة التطبيقات معرفة أداء برنامج واجهة برمجة التطبيقات بشكل عام، وأداء واجهات برمجة التطبيقات الفردية، وكيفية تحسين واجهات برمجة التطبيقات.
  • مطوّرو التطبيقات : من خلال مشاركة معلومات الإحصاءات مع مطوّري التطبيقات، ستحصل على تطبيقات أفضل. يُبدع هؤلاء المطوّرون باستخدام واجهة برمجة التطبيقات وينشئون تطبيقات إبداعية تساعد في زيادة الإيرادات في مؤسستك. تساعد الإحصاءات مطوّري التطبيقات في معرفة أداء تطبيقاتهم ومقدار مساهمتها في النتيجة النهائية لمؤسستك. يريد مطوّرو التطبيقات معرفة كيفية تحسين تطبيقاتهم.
  • فريق العمليات : يريد فريق العمليات فهم أنماط الزيارات و توقُّع الوقت المناسب لإضافة موارد في الخلفية أو إجراء تعديلات مهمة أخرى.
  • مالك المؤسسة : يريد مالك المؤسسة معرفة مدى تحقيق استثماراته في واجهة برمجة التطبيقات عائدًا جيدًا وأين يستثمر أموال واجهة برمجة التطبيقات في المستقبل.

ما نوع البيانات التي يتم جمعها وتحليلها؟

تجمع ميزة "إحصاءات Edge API" وتحلّل مجموعة واسعة من البيانات التي تتدفق عبر خوادم وكيلة لواجهة برمجة التطبيقات، مثل:

  • مدة الردّ
  • وقت استجابة الطلب
  • حجم الطلب
  • أخطاء الوجهة
  • اسم منتج واجهة برمجة التطبيقات
  • عنوان البريد الإلكتروني للمطوِّر
  • اسم التطبيق
  • الكثير غير ذلك

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

كيف يمكنني جمع بيانات إحصاءات مخصّصة؟

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

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

الاختلافات بين بيانات "إحصاءات Google" وبيانات "مراقبة واجهة برمجة التطبيقات"

يصف هذا القسم بعض الاختلافات الطفيفة بين البيانات التي تجمعها "إحصاءات Edge" وبيانات "مراقبة واجهة برمجة التطبيقات". بما أنّ "مراقبة واجهة برمجة التطبيقات" و"إحصاءات Google" تستخدمان مسارات بيانات مختلفة، قد تلاحظ اختلافات طفيفة بين التقارير المخصّصة التي تنشئها "مراقبة واجهة برمجة التطبيقات" والتقارير التي تنشئها "إحصاءات Google". على سبيل المثال، قد تلاحظ اختلافات في النتائج المُبلغ عنها لأخطاء المهلة، سواء كانت مهلات في الخلفية (رمز حالة HTTP 504 في الطلب) أو مهلات من جهة العميل (رمز حالة HTTP 499). قد تظهر هذه الأخطاء برمز الحالة 200 في التقارير المخصّصة في "إحصاءات Google"، ولكنها ستظهر برمز الحالة 504 أو 499 في التقارير المخصّصة في "مراقبة واجهة برمجة التطبيقات".

متى وكم من الوقت تكون بيانات الإحصاءات متاحة؟

هناك فاصلان زمنيان يتحكّمان في وقت عرض بيانات الإحصاءات ومدة توفّرها:

  • الفاصل الزمني لتأخير البيانات : بعد إجراء طلب إلى خادم وكيل لواجهة برمجة التطبيقات، قد يستغرق ظهور البيانات أو إتاحتها من خلال طلبات البيانات من واجهة برمجة التطبيقات للإدارة مدة تصل إلى 10 دقائق.
  • الاحتفاظ بالبيانات - يعتمد طول مدة الاحتفاظ ببيانات "إحصاءات Google" على خطة اشتراكك:
    • الخطة العادية: 30 يومًا
    • خطة Enterprise: 3 أشهر
    • خطة Enterprise Plus: 14 شهرًا
    يُرجى الاطّلاع على أسعار Apigee API Management لمزيد من المعلومات.

كيف يمكنني الوصول إلى بيانات الإحصاءات؟

توفّر ميزة "إحصاءات Edge API" أدوات لتصوُّر البيانات مضمّنة في واجهة مستخدم Edge. تشمل هذه الأدوات لوحات بيانات إحصاءات محدّدة مسبقًا وتقارير مخصّصة تعرض البيانات في رسوم بيانية وتتيح لك التوغّل للاطّلاع على البيانات المجمّعة في سمات مختلفة (مثل الخادم الوكيل لواجهة برمجة التطبيقات أو عنوان IP أو رمز حالة HTTP).

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

لوحات بيانات الإحصاءات

توفّر واجهة مستخدم Edge مجموعة من لوحات البيانات المحدّدة مسبقًا التي يمكنك استخدامها لعرض بيانات الإحصاءات. على سبيل المثال، تعرض الصورة التالية لوحة بيانات "أداء الخادم الوكيل":

تتضمّن لوحة البيانات هذه رسومًا بيانية لما يلي:

  • إجمالي عدد الزيارات : إجمالي عدد طلبات البيانات من واجهة برمجة التطبيقات التي تلقّاها Edge لبيئة واجهة برمجة تطبيقات في مؤسسة
  • الطلبات الناجحة : إجمالي عدد الطلبات التي أدّت إلى ردّ ناجح لا يتم احتساب الردود التي تتضمّن أخطاء.
  • أخطاء الزيارات : إجمالي عدد جميع طلبات البيانات من واجهة برمجة التطبيقات غير الناجحة؛ أي الطلبات التي لا تقدّم ردًا يشمل العدد كلاً من أخطاء الخادم الوكيل (من جهة Apigee) وأخطاء الوجهة (الخدمات في الخلفية).
  • متوسط عدد المعاملات في الثانية : متوسط عدد طلبات البيانات من واجهة برمجة التطبيقات والردود الناتجة عنها في الثانية

تشمل لوحات البيانات الإضافية المحدّدة مسبقًا ما يلي:

لمزيد من المعلومات عن لوحات البيانات المحدّدة مسبقًا، يُرجى الاطّلاع على مقالة استخدام لوحات بيانات الإحصاءات.

التقارير المخصّصة

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

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

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

  • عمودي: يمثّل كل خادم وكيل لواجهة برمجة التطبيقات عمودًا مختلفًا:

    رسم بياني عمودي مخصّص

  • خطي: يمثّل كل خادم وكيل لواجهة برمجة التطبيقات خطًا مختلفًا:

    رسم بياني خطي مخصّص

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

Analytics API

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

في ما يلي مثال على طلب بيانات من واجهة برمجة التطبيقات لاسترداد بيانات الإحصاءات للخوادم الوكيلة لواجهة برمجة التطبيقات:

curl  https://api.enterprise.apigee.com/v1/o/org_name/environments/test/stats/apiproxy?"select=sum(message_count)&timeRange=6/24/2018%2000:00~6/24/2018%2023:59&timeUnit=hour" \
-u email:password

يعرض هذا الطلب ما يلي:

  • مجموع الطلبات (عدد الرسائل) لكل خادم وكيل لواجهة برمجة التطبيقات
  • لفترة 24 ساعة
  • مجمّعة حسب الساعة

تحدّد مَعلمة طلب البحث timeRange الفترة الزمنية بالتنسيق:

?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM

يُرجى ملاحظة الرمز %20 قبل HH:MM. تتطلب المَعلمة timeRange مسافة مشفّرة بعنوان URL قبل HH:MM، أو الرمز +، كما في: MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.

لمزيد من المعلومات، يُرجى الاطّلاع على مقالة استخدام واجهات برمجة التطبيقات للمقاييس لقياس أداء برنامج واجهة برمجة التطبيقات.

تصدير بيانات الإحصاءات إلى Google Cloud

يمكنك استخدام واجهة برمجة التطبيقات لإدارة Edge لتصدير جميع بيانات الإحصاءات ليوم كامل من Edge إلى مستودع البيانات الخاص بك، مثل Google Cloud Storage أو BigQuery. يمكنك بعد ذلك الاستفادة من إمكانات طلبات البحث القوية وتعلُّم الآلة التي يوفّرها Google Cloud BigQuery وTensorFlow لإجراء تحليل البيانات الخاص بك.

لمزيد من المعلومات، يُرجى الاطّلاع على مقالة تصدير البيانات من الإحصاءات.

كيف يمكنني مشاركة البيانات مع مطوّري التطبيقات؟

عندما تعتبر مطوّري التطبيقات عملاءك، عليك التأكّد من توفُّر الأدوات والمعلومات اللازمة لهم لتحقيق أفضل استفادة من واجهة برمجة التطبيقات.

alt_text

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

  • الأخطاء: ما هي أخطاء واجهة برمجة التطبيقات التي يواجهها تطبيقي؟
  • الأداء: هل أداء واجهة برمجة التطبيقات بطيء الآن؟ ما هي طرق واجهة برمجة التطبيقات التي تكون بطيئة عادةً أو بطيئة في الوقت الحالي؟
  • التوفّر: هل واجهة برمجة التطبيقات متاحة أم غير متاحة الآن؟
  • الحصة: هل تتضمّن واجهة برمجة التطبيقات حصة؟ وبصفتي مطوّر التطبيق، كيف أستفيد من الحصة؟

لمزيد من المعلومات، يُرجى الاطّلاع على ما يلي:

بالإضافة إلى ذلك، يمكنك مشاركة الإحصاءات مع المطوّرين من خلال:

كيف يمكنني إنشاء بيانات إحصاءات كاملة؟

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

يجب اتّخاذ بضع خطوات لكي يتمكّن Edge من تحديد المطوّرين وتطبيقات المطوّرين الذين يطلبون الخوادم الوكيلة لواجهة برمجة التطبيقات. في ما يلي قائمة بهذه الخطوات مع روابط تؤدي إلى معلومات أكثر تفصيلاً:

  1. إنشاء منتج واحد أو أكثر من منتجات واجهة برمجة التطبيقات، وهو عبارة عن تجميع للخوادم الوكيلة لواجهة برمجة التطبيقات مع خطة خدمة. يُرجى الاطّلاع على مقالة إدارة منتجات واجهة برمجة التطبيقات.
  2. تسجيل مطوّري التطبيقات في Edge يُرجى الاطّلاع على مقالة تسجيل مطوّري التطبيقات.
  3. تسجيل التطبيقات وإنشاء مفاتيح واجهة برمجة التطبيقات للمطوّرين يُرجى الاطّلاع على مقالة تسجيل التطبيقات وإدارة مفاتيح واجهة برمجة التطبيقات.
  4. إضافة سياسات أمان إلى الخوادم الوكيلة لواجهة برمجة التطبيقات تتحقّق من مفاتيح واجهة برمجة التطبيقات و/أو الرموز المميّزة للأمان يُرجى الاطّلاع على المواضيع التالية:سياسة التحقّق من مفتاح واجهة برمجة التطبيقات، سياسة OAuthV2، وسياسة التحقّق من رمز JWT.
  5. إذا كنت تستخدم Edge Microgateway، تأكَّد من أنك فعّلت مكوّن الإحصاءات الإضافي (المفعّل تلقائيًا). إذا كان مكوّن الإحصاءات الإضافي غير مفعّل، لن يرسل Edge Microgateway بيانات الإحصاءات إلى إحصاءات Edge.

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

مقارنة "إحصاءات واجهة برمجة التطبيقات" بميزة "مراقبة واجهة برمجة التطبيقات"

يمكنك الاستفادة من كلٍّ من ميزتَي "مراقبة واجهة برمجة التطبيقات في Edge " و"إحصاءات واجهة برمجة التطبيقات". تفحص ميزة "مراقبة واجهة برمجة التطبيقات" بيانات الإحصاءات لتقديم إحصاءات سياقية في الوقت الفعلي عن أداء واجهة برمجة التطبيقات، ما يتيح لك تشخيص المشاكل بسرعة وتسهيل الإجراءات العلاجية لضمان استمرارية العمل. تم تصميم ميزة "مراقبة واجهة برمجة التطبيقات" للعثور بسرعة على المشاكل في واجهات برمجة التطبيقات والخلفيات. تم تصميم "إحصاءات واجهة برمجة التطبيقات" لجمع مجموعة واسعة من بيانات الإحصاءات لاستخدامها من قِبل عدة فرق مختلفة، ولكن عادةً ما تُستخدم البيانات للتحليل في سيناريوهات غير في الوقت الفعلي.

أحد الاختلافات الرئيسية بين "مراقبة واجهة برمجة التطبيقات" و"إحصاءات واجهة برمجة التطبيقات" هو آلية التنبيه المضمّنة في "مراقبة واجهة برمجة التطبيقات". باستخدام التنبيهات، يمكنك تحديد رمز حالة HTTP (2xx/4xx/5xx) أو وقت استجابة أو حدّ رمز خطأ، وعند تجاوزه، يتم إرسال إشعار تنبيه إلى فريق العمليات. يمكن إرسال إشعارات التنبيهات من خلال مجموعة متنوعة من القنوات، مثل البريد الإلكتروني أو Slack أو أجهزة النداء أو عمليات ردّ الاتصال، ما يتيح لك الردّ على المشاكل على الفور.

يُرجى الاطّلاع على مقالة مقارنة ميزة "رصد واجهة برمجة التطبيقات" بميزة "إحصاءات Edge API" للحصول على مقارنة أكثر تفصيلاً بين هاتين الخدمتَين.

مزيد من المعلومات