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

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

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

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

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

ضبط $ACCESS_TOKEN

تُمرِّر جميع طلبات البيانات من واجهة برمجة التطبيقات الموضّحة أدناه بيانات الاعتماد في متغيّر بيئة يُسمى $ACCESS_TOKEN. اضبط قيمة $ACCESS_TOKEN على رمز الدخول المميز OAuth 2.0، كما هو موضّح في الحصول على رمز دخول مميز OAuth 2.0. للحصول على معلومات حول خيارات cURL المستخدَمة في هذه الأمثلة، يُرجى الاطّلاع على استخدام cURL.

الحصول على اشعارات

بشكلٍ تلقائي، تعرض واجهة برمجة التطبيقات Get alerts معلومات عن جميع التنبيهات المحدّدة. تتلقّى واجهة برمجة التطبيقات هذه الآن مَعلمات طلب البحث لتتيح لك فلترة النتائج:

  • enabled: إذا كان true يحدّد عرض التنبيهات المفعّلة فقط. القيمة التلقائية هي false.
  • alertType: تحدّد نوع التنبيه المطلوب عرضه. القيم المسموح بها هي runtime، وهي القيمة التلقائية، وcert.
  • ‫alertSubType: تحدّد هذه السمة النوع الفرعي للتنبيه المطلوب عرضه. القيمة التلقائية هي "غير مضبوطة"، ما يعني عرض جميع الأنواع الفرعية للتنبيهات. حدِّد anomaly لعرض تنبيهات الحالات الشاذة.

على سبيل المثال، استخدِم طلب البيانات من واجهة برمجة التطبيقات التالي لعرض التنبيهات المفعّلة فقط للمؤسسة التي تحمل الاسم myorg:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

لا تعرض عملية استرجاع المكالمات التالية سوى تنبيهات القيم الشاذة، سواء كانت مفعَّلة أو غير مفعَّلة:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=runtime&alertSubType=anomaly'

إنشاء تنبيه بشأن القيم الشاذة أو تعديله

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

  • يجب إضافة الخصائص الجديدة التالية لتحديد أنّ التنبيه هو تنبيه بشأن القيم الشاذة:

    "alertType": "runtime"
"alertSubType": "anomaly"

    القيم التلقائية لهذه الخصائص هي:

    "alertType": "runtime"
"alertSubType": "fixed"

  • في مصفوفة conditions:

    • تقبل الخاصية metrics القيم التالية فقط:

      • count: رفع تنبيه بشأن عدد أخطاء HTTP
      • totalLatency - رفع تنبيه بشأن وقت الاستجابة
    • تتلقّى السمة threshold سلسلة بدلاً من رقم. تشمل القيم المسموح بها: slight وmoderate وsevere.
    • لا تتوفّر السمتان durationSeconds وcomparator.

  • في العنصر dimensions من الصفيفة conditions:

    • يجب ضبط قيمة السمة proxy على ALL.
    • لا تقبل السمة statusCode سوى القيمة 4xx, 503, 504, and 5xx.
    • السمات developerApp، collection، faultCodeCategory، faultCodeSubCategory، faultCodeName غير متاحة.
  • السمة reportEnabled غير متاحة لتنبيهات القيم الشاذة.

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

curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
 -X POST \
 -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -d '{
     "organization":"myorg",
     "name":"5xx Anomaly Alert",
     "description":"My 5xx alert",
     "environment":"prod",
     "enabled":true,
     "alertType": "runtime",
     "alertSubType": "anomaly",
     "conditions":[
     {
        "description":"",
        "dimensions":{
            "org":"myorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ANY",
            "statusCode":"5xx"
        },
        "metric":"count",
        "threshold": "moderate"
     }
     ],
     "notifications":[{
         "channel":"email",
         "destination":"ops@acme.com"
     }],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600
    }'

استخدام واجهة برمجة التطبيقات للأحداث مع الحالات الشاذة

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

تعرض واجهة برمجة التطبيقات تلقائيًا جميع الأحداث التي وقعت في الساعة السابقة. استخدِم مَعلمتَي طلب البحث from وto لتحديد مدة مختلفة. قيم مَعلمتَي طلب البحث from وto لتحديد مدة مختلفة

على سبيل المثال، يعرض طلب البيانات التالي من واجهة برمجة التطبيقات جميع الأحداث في المؤسسة myorg خلال الـ 12 ساعة السابقة:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
"https://apimonitoring.enterprise.apigee.com/metrics/events?org=myorg&from=-12h&to=now"

اضبط قيمة $ACCESS_TOKEN على رمز الدخول المميز OAuth 2.0، كما هو موضّح في الحصول على رمز دخول مميز OAuth 2.0. للحصول على معلومات حول خيارات cURL المستخدَمة في هذا المثال، يُرجى الاطّلاع على استخدام cURL.

يعرض الاستدعاء التالي جميع أحداث القيم الشاذة التي تتضمّن حدًا معتدلاً لآخر 24 ساعة: 

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
"https://apimonitoring.enterprise.apigee.com/metrics/events?org=myorg&type=anomaly&threshold=moderate&from=-24h&to=now"

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

الاسم الوصف تلقائي
threshold

فلترة الأحداث حسب الحدّ المحدّد: slight أو moderate أو severe

يُسمح بذلك فقط عند ضبط type=anomaly.

كل مستويات الخطورة
type فلترة الأحداث حسب النوع المحدّد: alert أو anomaly حدِّد قيمًا متعددة كقائمة مفصولة بفواصل. جميع الأنواع