يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات
Apigee X. المعلومات
استخدم تنبيه حركة المرور لرفع إشعار عندما تتغير حركة المرور في بيئة أو خادم وكيل أو منطقة بنسبة مئوية محددة خلال نطاق زمني.
يمكنك ضبط النطاق الزمني على:
- ساعة واحدة
- يوم واحد
- 7 أيام
- 15 يومًا (واجهة برمجة التطبيقات فقط)
- 30 يومًا (واجهة برمجة التطبيقات فقط)
ويعمل التنبيه من خلال مقارنة زيارات النطاق الزمني الحالي بعدد زيارات النطاق الزمني السابق. على سبيل المثال، يمكنك تحديد نطاق زمني مدته ساعة واحدة. يقارن التنبيه بعد ذلك حركة المرور في آخر ساعة مقابل حركة المرور في الساعة السابقة لحساب النسبة المئوية للتغيير في عدد الزيارات:
percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100
تعني القيمة الموجبة زيادة عدد الزيارات، بينما تعني القيمة السالبة أن عدد الزيارات قد انخفض.
بعد ذلك، يمكنك ضبط الحدّ الذي يؤدي إلى ظهور تنبيه بشأن عدد الزيارات كزيادة أو انخفاض في عدد زيارات واجهة برمجة التطبيقات خلال الفترة الزمنية المحدّدة.
قبل تحديد هذه النسبة، تأكد من أنها تتوافق مع أنماط الزيارات العادية. على سبيل المثال، إذا كانت زيارات واجهة برمجة التطبيقات تتقلّب عادةً على مدار اليوم مع ارتفاع في عدد الزيارات كل ساعة بنسبة تصل إلى 100% في أوقات ذروة معيّنة، تكون هذه الارتفاعات طبيعية ومن المفترض ألا تؤدي إلى ظهور تنبيه. ومع ذلك، إذا ضبطت بعد ذلك تنبيهًا لتشغيل أي زيادة بنسبة 50% في عدد الزيارات كل ساعة، ستتلقّى تنبيهات غير ضرورية للزيارات العادية.
للحصول على مزيد من المعلومات عن التنبيهات، يُرجى الاطّلاع على إعداد التنبيهات والإشعارات.
إضافة تنبيهات وإشعارات بشأن حركة المرور
لإضافة تنبيهات وإشعارات بشأن حركة المرور:- انقر على تحليل > قواعد التنبيه في واجهة مستخدم Edge.
- انقر على +تنبيه.
- أدخِل المعلومات العامة التالية عن التنبيه:
الحقل الوصف اسم التنبيه اسم التنبيه. استخدِم اسمًا يصف المشغِّل ويكون مفيدًا لك. يجب ألا يتجاوز الاسم 128 حرفًا. الوصف وصف التنبيه. نوع التنبيه اختَر إجمالي عدد الزيارات. راجِع لمحة عن أنواع التنبيهات للحصول على مزيد من المعلومات. البيئة اختَر البيئة من القائمة المنسدلة. الحالة مفتاح التبديل لتفعيل التنبيه أو إيقافه. - حدِّد الحد الأدنى والسمة للشرط الذي سيؤدي إلى ظهور التنبيه.
حقل الشرط الوصف الحد الأقصى يجب تحديد هذا الخيار لرفع التنبيه عندما يزداد عدد الزيارات بنسبة أو ينخفض بنسبة معيّنة مقارنةً بفاصل زمني سابق.
اضبط النسبة المئوية للزيادة بنسبة على قيمة أكبر من أو تساوي 0%. اضبط مخفض بنسبة على قيمة أكبر من أو تساوي 0%، وأقل من أو تساوي 100%.
يمكنك اختيار فاصل زمني من:
- ساعة واحدة
- يوم واحد
- أسبوع واحد
السمة انقر على +إضافة سمة وحدِّد تفاصيل السمة التي تريد عرض نتائج لها، بما في ذلك الخادم الوكيل لواجهة برمجة التطبيقات والمنطقة.
ضبط سمة معيّنة على:
- الخادم الوكيل - التعيين على خادم وكيل محدد أو على كل الخوادم الوكيلة. لا يتيح الخادم الوكيل استخدام القيمة "أي". وبدلاً من ذلك، يمكنك إضافة تنبيه منفصل لكل خادم وكيل مع اهتمامك.
- المنطقة - يتم ضبطها على منطقة محدّدة أو على كل المناطق. لا تسمح القيمة Region بالقيمة "أي". وبدلاً من ذلك، يمكنك إضافة تنبيه منفصل لكل منطقة تهتم بها.
- انقر على + إشعار لإضافة إشعار تنبيه.
تفاصيل الإشعار الوصف القناة اختَر قناة الإشعارات التي تريد استخدامها وحدِّد الوجهة: البريد الإلكتروني أو Slack أو PagerDuty أو الردّ التلقائي على الويب. الحساب حدِّد الوجهة استنادًا إلى نوع القناة المحدّد: - البريد الإلكتروني: عنوان البريد الإلكتروني، مثل
joe@company.com
- Slack - عنوان URL لقناة Slack، مثل
https://hooks.slack.com/services/T00000000/B00000000/XXXXX
- PagerDuty - رمز PagerDuty، مثل
abcd1234efgh56789
- الردّ التلقائي على الويب - عنوان URL للردّ التلقائي على الويب، مثل
https://apigee.com/test-webhook
ملاحظة: يمكنك تحديد وجهة واحدة فقط لكل إشعار. لتحديد وجهات متعددة لنوع القناة نفسه، أضِف إشعارات أخرى.
- البريد الإلكتروني: عنوان البريد الإلكتروني، مثل
- لإضافة إشعارات أخرى، كرِّر الخطوة السابقة.
- إذا أضفت إشعارًا، اضبط الحقول التالية:
الحقل الوصف دليل إرشادي (اختياري) حقل نصي مرن لتقديم وصف موجز للإجراءات المقترَحة لحل التنبيهات عند تنشيطها. ويمكنك أيضًا تحديد رابط يؤدي إلى صفحة المنتدى أو موقع wiki الداخلية التي تشير إلى أفضل الممارسات. سيتم تضمين المعلومات الواردة في هذا الحقل في الإشعار. يجب ألا يتجاوز المحتوى في هذا الحقل 1500 حرف. صمام الوقود معدل تكرار إرسال الإشعارات. اختَر قيمة من القائمة المنسدلة. - انقر على حفظ.
عرض التنبيهات في لوحة بيانات الأحداث
عندما يرصد Edge حالة تنبيه، يسجّل تلقائيًا هذا الشرط في لوحة بيانات الأحداث في واجهة مستخدم Edge. تتضمن قائمة الأحداث المعروضة في لوحة بيانات الأحداث جميع التنبيهات، الثابتة والمستندة إلى الشهادة.
لعرض تنبيه:
انقر على تحليل > الأحداث في واجهة مستخدم Edge. تظهر لوحة بيانات الأحداث الجديدة:
فلترة لوحة بيانات "الأحداث" حسب:
- البيئة
- المنطقة
- الفترة الزمنية
- اختَر صفًا في لوحة بيانات الحدث لعرض ملف تخزين المفاتيح الذي يحتوي على الشهادة منتهية الصلاحية لإجراء مزيد من التحقيق في التنبيه. من صفحة ملف تخزين المفاتيح، يمكنك تحميل شهادة جديدة وحذف الشهادة ستنتهي صلاحيتها قريبًا.
استخدام واجهات برمجة تطبيقات التنبيهات مع تنبيهات حركة المرور
وتتطابق معظم واجهات برمجة التطبيقات التي تستخدمها لإنشاء تنبيهات حركة المرور وإدارتها مع تلك التي تستخدمها مع أنواع التنبيهات الأخرى:
- الحصول على تنبيه: احصل على تعريف لتنبيه ثابت أو تنبيه حالة شاذة.
- الحصول على سجلّ التنبيهات: الحصول على مقاييس سجلّ التنبيهات
- حذف تنبيه: لحذف تعريف تنبيه ثابت أو حالة شاذة.
- الحصول على مثيل التنبيه: يمكنك الحصول على معلومات حول تنبيه تم تشغيله.
- الحصول على عدد التنبيهات: يتيح لك هذا الخيار الحصول على إجمالي عدد التنبيهات.
ومع ذلك، تحتوي بعض واجهات برمجة التطبيقات على خصائص إضافية تُستخدَم لدعم تنبيهات القيم الشاذة، بما في ذلك:
- الحصول على تنبيهات: يمكنك إدراج جميع التنبيهات، بما في ذلك التنبيهات الثابتة والشاذة.
- إنشاء تنبيه: يمكنك إنشاء تنبيه ثابت أو حالة شاذة.
- تعديل تنبيه: يتيح تعديل تعريف تنبيه ثابت أو حالة شاذة.
إنشاء تنبيه بشأن حركة المرور أو تعديله
استخدِم واجهات برمجة التطبيقات نفسها لإنشاء أو تعديل تنبيه بحركة مرور كما تفعل حاليًا لأنواع التنبيهات الأخرى. يكون نص طلب البيانات من واجهة برمجة التطبيقات لإنشاء تنبيه بشأن حركة المرور أو تعديله هو نفسه المستخدَم في التنبيهات الأخرى مع التغييرات التالية:
أضِف السمات الجديدة التالية لتحديد أنّ التنبيه هو تنبيه بحركة المرور:
"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
غير متاح لتنبيهات حركة المرور.
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.
اطّلِع على عرض الأحداث للحصول على مزيد من المعلومات عن استخدام واجهة برمجة التطبيقات هذه.
الحصول على تنبيهات بشأن حركة المرور
بشكلٍ تلقائي، تعرض واجهة برمجة تطبيقات الحصول على تنبيهات معلومات حول جميع التنبيهات التي تم تحديدها. تستخدم واجهة برمجة التطبيقات هذه الآن معلَمات طلب البحث لتتيح لك فلترة النتائج:
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.