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

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

يقدم هذا الموضوع نبذة عن إحصاءات واجهة برمجة تطبيقات Edge.

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

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

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

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

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

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

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

من خلال العملية المستمرة لجمع البيانات وتحليلها وتمثيلها مرئيًا، تساعد أداة Edge API Analytics فريق واجهة برمجة التطبيقات في تحسين واجهات برمجة التطبيقات، كما تساعد مطوّري التطبيقات على تحسين تطبيقاتهم من خلال ما يلي:

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

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

تجمع أداة Edge API Analytics وتحلل نطاقًا واسعًا من البيانات التي تتدفق عبر الخوادم الوكيلة لواجهة برمجة التطبيقات، مثل:

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

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

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

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

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

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

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

متى تكون بيانات الإحصاءات متوفّرة ولأي مدة؟

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

  • الفاصل الزمني لتأخّر البيانات: بعد إرسال طلب إلى خادم وكيل لواجهة برمجة التطبيقات، يمكن أن يستغرق الوصول إلى البيانات ما يصل إلى 10 دقائق للعرض أو من خلال طلبات بيانات من واجهة برمجة التطبيقات الإدارية.
  • الاحتفاظ بالبيانات: تختلف المدة الزمنية التي يتم خلالها الاحتفاظ ببيانات الإحصاءات من خلال Edge حسب الخطة. استنادًا إلى خطتك، قد تتوفّر بيانات الإحصاءات لآخر 30 أو 60 أو 90 أو 365 يومًا.

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

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

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

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

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

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

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

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

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

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

تتيح لك التقارير المخصّصة إمكانية التوغّل في مقاييس معيّنة لواجهة برمجة التطبيقات وعرض البيانات الدقيقة التي تريد الاطّلاع عليها. يمكنك إنشاء تقرير مخصّص باستخدام أي من بيانات الإحصاءات المضمّنة في 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 Management API لتصدير جميع بيانات الإحصاءات ليوم كامل من Edge إلى مستودع البيانات الخاص بك، مثل Google Cloud Storage أو BigQuery. يمكنك بعد ذلك الاستفادة من الإمكانات الفعّالة للطلب وتعلُّم الآلة التي يوفّرها Google Cloud BigQuery وTensorFlow لإجراء تحليل للبيانات بنفسك.

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

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

عندما تعتبر أن مطوري التطبيقات هم عملاؤك، ستحتاج إلى التأكد من أن لديهم الأدوات والمعلومات المتاحة لهم لتحقيق أقصى استفادة من واجهة برمجة التطبيقات.

alt_text

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

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

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

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

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

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

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

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

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

مقارنة تحليلات واجهة برمجة التطبيقات بمراقبة واجهة برمجة التطبيقات

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

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

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

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