إعداد تنبيهات حركة المرور

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

استخدام تنبيه بشأن حركة المرور لرفع إشعار عند تغير عدد الزيارات لبيئة أو خادم وكيل أو منطقة بنسبة مئوية محددة خلال نطاق زمني.

يمكنك ضبط النطاق الزمني على:

  • ساعة واحدة
  • يوم واحد
  • 7 أيام
  • 15 يومًا (واجهة برمجة التطبيقات فقط)
  • 30 يومًا (واجهة برمجة التطبيقات فقط)

ويعمل التنبيه من خلال مقارنة حركة المرور للنطاق الزمني الحالي بحركة المرور للنطاق الزمني السابق. مثلاً، يمكنك تحديد نطاق زمني مدته ساعة واحدة. بعد ذلك، يقارن التنبيه عدد الزيارات في آخر ساعة. مقابل حركة المرور للساعة السابقة لحساب النسبة المئوية للتغيير في حركة المرور:

percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100

وتعني القيمة الموجبة زيادة عدد الزيارات، بينما تشير القيمة السالبة إلى انخفاض عدد الزيارات.

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

وقبل تحديد تلك النسبة، تأكَّد من توافقها مع القيم أنماط حركة المرور. على سبيل المثال، إذا كان عدد زيارات واجهة برمجة التطبيقات يتغيّر عادةً على مدار اليوم مع حدوث ارتفاعات في عدد الزيارات كل ساعة بنسبة تصل إلى %100 في أوقات ذروة معيّنة، تكون هذه الارتفاعات طبيعية ومن المفترض ألا تؤدي إلى إطلاق أي تنبيه. ومع ذلك، إذا يمكنك بعد ذلك ضبط تنبيه لتشغيل أي زيادة بنسبة 50% في عدد الزيارات كل ساعة، ستتلقى تنبيهات غير ضرورية لحركة المرور العادية.

لمزيد من المعلومات حول التنبيهات، يُرجى الاطّلاع على إعداد التنبيهات والإشعارات.

إضافة تنبيهات وإشعارات حركة المرور

لإضافة تنبيهات وإشعارات حركة المرور:
  1. انقر على تحليل > (تحليل) > قواعد التنبيه في واجهة مستخدم Edge.
  2. انقر على +تنبيه.
  3. أدخِل المعلومات العامة التالية عن التنبيه:
    الحقل الوصف
    اسم التنبيه اسم التنبيه استخدِم اسمًا يصف العامل المفعِّل ويكون مفيدًا لك. يجب ألا يتجاوز الاسم 128 حرفًا.
    الوصف وصف التنبيه.
    نوع التنبيه اختَر إجمالي عدد الزيارات. عرض لمحة عن أنواع التنبيهات لمعرفة المزيد
    البيئة اختَر البيئة من القائمة المنسدلة.
    الحالة انقر على زر التبديل لتفعيل التنبيه أو إيقافه.
  4. حدِّد الحدّ الأدنى والسمة للشرط الذي سيؤدي إلى ظهور التنبيه.
    حقل الشرط الوصف
    الحد الأقصى

    حدِّد رفع التنبيه عند زيادة عدد الزيارات بنسبة تناقص بمقدار نسبة مئوية معيّنة عند مقارنتها بفاصل زمني سابق.

    حدِّد النسبة المئوية للزيادة بنسبة على قيمة أكبر من أو تساوي 0%. اضبط النسبة المئوية للخفض بنسبة على قيمة أكبر من أو تساوي 0%. وأقل من أو يساوي 100٪.

    يمكنك اختيار فاصل زمني:

    • ساعة واحدة
    • يوم واحد
    • أسبوع واحد
    السمة

    انقر على +إضافة سمة وحدِّد تفاصيل السمة التي تريد عرض نتائج تتضمّنها. وكيل واجهة برمجة التطبيقات والمنطقة.

    ضبط سمة معيّنة على:

    • الخادم الوكيل: يتم الضبط على خادم وكيل محدّد أو على جميع الخوادم الوكيلة. لا يتيح الخادم الوكيل استخدام قيمة "Any". بدلاً من ذلك يمكنك إضافة تنبيه منفصل لكل خادم وكيل يهمّك.
    • المنطقة: اضبط القيمة على منطقة معيّنة أو على جميع المناطق. لا يمكن استخدام قيمة "Any" في Region. بدلاً من ذلك يمكنك إضافة تنبيه منفصل لكل منطقة تهتم بها.
  5. انقر على + إشعار لإضافة إشعار تنبيه.
    تفاصيل الإشعار الوصف
    القناة اختَر قناة الإشعارات التي تريد استخدامها وحدِّد الوجهة: البريد الإلكتروني أو Slack أو PagerDuty أو Webhook.
    الوجهة حدِّد الوجهة استنادًا إلى نوع القناة الذي اخترته:
    • البريد الإلكتروني - عنوان البريد الإلكتروني، مثل joe@company.com
    • Slack - عنوان URL لقناة Slack، مثل https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty - رمز PagerDuty، مثل abcd1234efgh56789
    • الردّ التلقائي على الويب - عنوان URL للردّ التلقائي على الويب، مثل https://apigee.com/test-webhook

      ملاحظة: يمكنك تحديد وجهة واحدة فقط لكل إشعار. لتحديد وجهات متعددة لنوع القناة نفسه، يجب إضافة إشعارات إضافية.

  6. لإضافة إشعارات إضافية، كرِّر الخطوة السابقة.
  7. إذا أضفت إشعارًا، اضبط الحقول التالية:
    الحقل الوصف
    دليل إرشادي (اختياري) حقل نصي حر الشكل لتقديم وصف موجز للإجراءات الموصى بها لحل التنبيهات عند تنشيطها. يمكنك أيضًا تحديد رابط لموقع wiki الداخلي أو صفحة المنتدى التي ترجع فيها إلى أفضل الممارسات. ستكون المعلومات في هذا الحقل الواردة في الإشعار. لا يمكن أن يتجاوز المحتوى في هذا الحقل 1500 حرف.
    صمام الوقود معدل تكرار إرسال الإشعارات. اختَر قيمة من القائمة المنسدلة.
  8. انقر على حفظ.

عرض التنبيهات في لوحة بيانات "الأحداث"

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

لعرض تنبيه:

  1. انقر على تحليل > (تحليل) > الأحداث في واجهة مستخدم Edge. تظهر لوحة بيانات الأحداث الجديدة:

  2. يمكنك فلترة لوحة بيانات "الأحداث" حسب:

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

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

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

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

إنشاء تنبيه بحركة المرور أو تحديثه

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

  • أضِف السمات الجديدة التالية لتحديد أنّ التنبيه تنبيه بحركة المرور:

    "alertType": "runtime"
    "alertSubType": "trafficfixed"

    القيم التلقائية لهذه السمات هي:

    "alertType": "runtime"
    "alertSubType": "fixed"
  • في العنصر dimensions من مصفوفة conditions:
    • يجب ضبط قيم org وenv وproxy. وregion. يُسمح باستخدام هذه السمات فقط. يمكنك ضبط proxy وregion على ALL.
    • يجب ضبط قيمة السمة traffic على total.
  • في مصفوفة conditions:

    • يجب أن تكون قيمة السمة metrics هي trafficChange.
    • يجب ضبط السمة comparator على increasedBy أو decreasedBy.
    • تحتوي السمة threshold على قيمة موجبة تحدّد نسبة الزيادة أو الانخفاض في عدد الزيارات. حيث تتجاوب قيمة 1.0 مع 100%. بالنسبة إلى increasedBy، ستكون القيمة يجب أن تكون أكبر من أو تساوي 0.0 (0%). بالنسبة إلى decreasedBy، يجب أن تكون القيمة أكبر من أو يساوي 0.0 (0%) وأقل من أو يساوي 1.0 (100%).
    • يجب ضبط السمة durationSeconds على إحدى القيم التالية: 3600 (ساعة واحدة)، 86400 (يوم واحد)، 604800 (7 أيام)، 1296000 (15 يومًا)، 2592000 (30 يومًا)
  • لا تتوفّر السمة reportEnabled لتنبيهات حركة المرور.
يوضح المثال التالي كيفية إعداد تنبيه يتم تشغيله عند دخول المؤسسة والبيئة بنسبة 50٪ خلال فترة ساعة واحدة. يتم إرسال إشعار إلى رمز PagerDuty المحدّد عند تشغيل التنبيه.
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":"My Traffic Alert",
     "description":"My traffic alert",
     "environment":"prod",
     "enabled":true,
     "alertType":"runtime",
     "alertSubType":"trafficfixed",
     "conditions":[
     {
        "description":"",
        "dimensions": {
            "org":"nyorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ALL",
            "traffic":"total"
        },
        "metric": "trafficChange",
        "threshold": 0.5,
        "durationSeconds": 3600,
        "comparator": "increasedBy"
     }
     ],
     "notifications":[{ "channel":"pagerduty", "destination":"abcd1234efgh56789"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

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

راجِع قسم عرض الأحداث للحصول على مزيد من المعلومات عن استخدام واجهة برمجة التطبيقات هذه.

الحصول على تنبيهات حركة المرور

تعرض واجهة برمجة التطبيقات Get Notifications تلقائيًا معلومات حول جميع التنبيهات المحدّدة. تستخدِم واجهة برمجة التطبيقات هذه الآن مَعلمات طلب البحث لتتيح لك فلترة النتائج:

  • enabled: في حال تحديد true لعرض التنبيهات المفعَّلة فقط. القيمة التلقائية هي false.
  • alertType: لتحديد نوع التنبيه المُراد عرضه. والقيم المسموح بإدراجها هي runtime، والقيم التلقائية، وcert.
  • alertSubType - لتحديد النوع الفرعي للتنبيه المراد عرضه. وتكون القيمة التلقائية بدون ضبط، ما يعني عرض جميع الأنواع الفرعية للتنبيه.

على سبيل المثال، يمكنك استخدام طلب البيانات التالي من واجهة برمجة التطبيقات لعرض التنبيهات فقط للمؤسسة المسماة 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=trafficfixed'

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