أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى
مستندات Apigee X. info
استخدِم تنبيهًا بشأن حركة المرور لإرسال إشعار عند تغيُّر حركة المرور في بيئة أو خادم وكيل أو منطقة بنسبة مئوية محدّدة خلال نطاق زمني.
اضبط النطاق الزمني على:
- ساعة واحدة
- يوم واحد
- 7 أيام
- 15 يومًا (واجهة برمجة التطبيقات فقط)
- 30 يومًا (واجهة برمجة التطبيقات فقط)
يعمل التنبيه من خلال مقارنة عدد الزيارات للنطاق الزمني الحالي بعدد الزيارات للنطاق الزمني السابق. على سبيل المثال، يمكنك تحديد نطاق زمني مدته ساعة واحدة. يقارن التنبيه بعد ذلك عدد الزيارات في الساعة الأخيرة بعدد الزيارات في الساعة السابقة لحساب النسبة المئوية للتغيّر في عدد الزيارات:
percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100
تشير القيمة الموجبة إلى زيادة عدد الزيارات، وتشير القيمة السالبة إلى انخفاض عدد الزيارات.
بعد ذلك، يمكنك ضبط الحدّ الذي يؤدي إلى تنبيه بشأن عدد الزيارات كزيادة أو انخفاض في النسبة المئوية لعدد الزيارات إلى واجهة برمجة التطبيقات خلال الفترة الزمنية المحدّدة.
قبل ضبط هذه النسبة، تأكَّد من أنّها تتوافق مع أنماط الزيارات العادية. على سبيل المثال، إذا كانت الزيارات إلى واجهة برمجة التطبيقات تتفاوت عادةً على مدار اليوم مع ارتفاعات في عدد الزيارات كل ساعة تصل إلى %100 في أوقات الذروة، تكون هذه الارتفاعات طبيعية ولا يجب أن تؤدي إلى تنبيه. ومع ذلك، إذا أعددت تنبيهًا ليتم تفعيله عند حدوث أي زيادة بنسبة% 50 في عدد الزيارات كل ساعة، ستتلقّى تنبيهات غير ضرورية بشأن عدد الزيارات العادي.
لمزيد من المعلومات حول التنبيهات، راجِع إعداد التنبيهات والإشعارات.
إضافة تنبيهات وإشعارات بشأن حركة المرور
لإضافة تنبيهات وإشعارات بشأن حركة المرور، اتّبِع الخطوات التالية:- انقر على تحليل > قواعد التنبيهات في واجهة مستخدم Edge.
- انقر على +تنبيه.
- أدخِل المعلومات العامة التالية عن التنبيه:
الحقل الوصف اسم التنبيه اسم التنبيه استخدِم اسمًا يصف المشغّل ويكون ذا معنى بالنسبة إليك. يجب ألا يتجاوز الاسم 128 حرفًا. الوصف وصف التنبيه نوع التنبيه اختَر إجمالي عدد الزيارات. يمكنك الاطّلاع على لمحة عن أنواع التنبيهات لمزيد من المعلومات. البيئة اختَر البيئة من القائمة المنسدلة. الحالة انقر على مفتاح التبديل لتفعيل التنبيه أو إيقافه. - حدِّد الحدّ والسمة للشرط الذي سيؤدي إلى ظهور التنبيه.
حقل الشرط الوصف الحد الأقصى حدِّد أن يتم إطلاق التنبيه عندما تزيد الزيارات أو تنخفض بنسبة مئوية معيّنة مقارنةً بفاصل زمني سابق.
اضبط النسبة المئوية لزيادة السعر بمقدار على قيمة أكبر من أو تساوي %0. اضبط النسبة المئوية انخفض بمقدار على قيمة أكبر من أو تساوي %0، وأقل من أو تساوي %100.
يمكنك اختيار فاصل زمني من:
- ساعة واحدة
- يوم واحد
- أسبوع واحد
السمة انقر على +إضافة سمة وحدِّد تفاصيل السمة التي تريد عرض النتائج لها، بما في ذلك خادم وكيل واجهة برمجة التطبيقات والمنطقة.
ضبط سمة معيّنة على:
- الخادم الوكيل: اضبطه على خادم وكيل معيّن أو على جميع الخوادم الوكيلة. لا يتيح الخادم الوكيل استخدام القيمة "أي". بدلاً من ذلك، يمكنك إضافة تنبيه منفصل لكل وكيل يهمّك.
- المنطقة: اضبطها على منطقة معيّنة أو على كل المناطق. لا يتيح المنطقة استخدام القيمة "أي". بدلاً من ذلك، يمكنك إضافة تنبيه منفصل لكل منطقة تهمّك.
- انقر على + إشعار لإضافة إشعار تنبيه.
تفاصيل الإشعار الوصف القناة اختَر قناة الإشعارات التي تريد استخدامها وحدِّد الوجهة: البريد الإلكتروني أو 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
ملاحظة: يمكنك تحديد وجهة واحدة فقط لكل إشعار. لتحديد وجهات متعددة لنوع القناة نفسه، أضِف إشعارات إضافية.
- البريد الإلكتروني: عنوان البريد الإلكتروني، مثل
- لإضافة إشعارات أخرى، كرِّر الخطوة السابقة.
- إذا أضفت إشعارًا، اضبط الحقول التالية:
الحقل الوصف دليل إرشادي (اختياري) حقل نصي حرّ لتقديم وصف موجز للإجراءات المقترَحة لحلّ التنبيهات عند ظهورها. يمكنك أيضًا تحديد رابط يؤدي إلى صفحة الويكي الداخلية أو صفحة المنتدى حيث تشير إلى أفضل الممارسات. سيتم تضمين المعلومات الواردة في هذا الحقل في الإشعار. يجب ألا يتجاوز عدد الأحرف في هذا الحقل 1,500 حرف. صمام الوقود معدّل تكرار إرسال الإشعارات اختَر قيمة من القائمة المنسدلة. - انقر على حفظ.
عرض التنبيهات في لوحة بيانات "الأحداث"
عندما يرصد Edge حالة تنبيه، يسجِّل هذه الحالة تلقائيًا في لوحة بيانات الأحداث في واجهة مستخدم Edge. تتضمّن قائمة الأحداث المعروضة في لوحة بيانات "الأحداث" جميع التنبيهات، سواء كانت ثابتة أو مرتبطة بشهادة.
لعرض تنبيه:
انقر على تحليل > الأحداث في واجهة مستخدم Edge. تظهر لوحة بيانات "الأحداث" الجديدة:
فلترة لوحة بيانات "الأحداث" حسب:
- البيئة
- المنطقة
- الفترة الزمنية
- اختَر صفًا في "لوحة بيانات الأحداث" لعرض Keystore الذي يحتوي على الشهادة التي ستنتهي صلاحيتها، وذلك لمزيد من التحقيق في التنبيه. من صفحة "ملف تخزين المفاتيح"، يمكنك تحميل شهادة جديدة وحذف الشهادة التي ستنتهي صلاحيتها.
استخدام واجهات برمجة التطبيقات الخاصة بالتنبيهات مع تنبيهات حركة المرور
معظم واجهات برمجة التطبيقات التي تستخدمها لإنشاء تنبيهات بشأن حركة المرور وإدارتها هي نفسها التي تستخدمها مع أنواع التنبيهات الأخرى:
- الحصول على تنبيه: للحصول على تعريف تنبيه ثابت أو تنبيه بشأن قيمة شاذة
- الحصول على سجلّ التنبيه: للحصول على مقاييس سجلّ التنبيه
- حذف تنبيه: لحذف تعريف تنبيه ثابت أو تنبيه بشأن القيم الشاذة
- الحصول على مثيل تنبيه: للحصول على معلومات حول تنبيه تم تشغيله.
- الحصول على عدد التنبيهات: للحصول على إجمالي عدد التنبيهات.
ومع ذلك، تحتوي بعض واجهات برمجة التطبيقات على سمات إضافية تُستخدَم لتوفير تنبيهات بشأن الحالات الشاذة، بما في ذلك:
- تلقّي التنبيهات: تعرض هذه القائمة جميع التنبيهات، بما في ذلك التنبيهات التي تم إصلاحها وتنبيهات الحالات الشاذة.
- إنشاء تنبيه: يمكنك إنشاء تنبيه ثابت أو تنبيه بشأن القيم الشاذة.
- تعديل تنبيه: لتعديل تعريف تنبيه ثابت أو تنبيه بشأن قيمة غير طبيعية
إنشاء تنبيه بشأن حركة المرور أو تعديله
استخدِم واجهات برمجة التطبيقات نفسها لإنشاء أو تعديل تنبيه بشأن حركة المرور كما تفعل حاليًا مع أنواع التنبيهات الأخرى. يكون نص طلب البيانات من واجهة برمجة التطبيقات لإنشاء تنبيه بشأن حركة المرور أو تعديله هو نفسه النص المستخدَم مع التنبيهات الأخرى، مع إجراء التغييرات التالية:
أضِف السمات الجديدة التالية لتحديد أنّ التنبيه هو تنبيه بشأن حركة المرور:
"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.
لمزيد من المعلومات حول استخدام واجهة برمجة التطبيقات هذه، اطّلِع على عرض الأحداث.
تلقّي تنبيهات بشأن حركة المرور
تعرض واجهة برمجة التطبيقات Get Alerts تلقائيًا معلومات عن جميع التنبيهات المحدّدة. تتلقّى واجهة برمجة التطبيقات هذه الآن مَعلمات طلب البحث لتتيح لك فلترة النتائج:
-
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.