تهيئة إشعارات Slack
يعلن Excubius عن التنبيهات في Slack: عندما يُفتح تنبيه، وعندما ترتفع خطورته، وعندما يُحل. تختار القنوات لكل كيان، ويرثها كل كيان تحته إلى أن يحدد قنواته الخاصة. يوضح هذا الدليل كيفية ربط تطبيق Slack مرة واحدة، وإضافة قنوات لكيان، واختبارها، وكيف تُوجَّه الرسالة.
قبل البدء
- لإضافة قنوات، تحتاج إلى دور Entity admin (مسؤول الكيان) على الكيان.
- لإنشاء تطبيق Slack، تحتاج إلى إذن بتثبيت التطبيقات في مساحة عمل Slack لديك.
- لتسليم الرمز المميز للتطبيق إلى Excubius، تحتاج إلى الوصول إلى الخادم:
sudoعليه، أو حزمة التثبيت.
ربط تطبيق Slack
تنفذ هذا مرة واحدة لكل تثبيت.
-
انتقل إلى
https://api.slack.com/apps، وحدد Create New App، واختر From scratch، وسمِّه باسم يتعرف عليه فريقك، واختر مساحة العمل لديك. -
ضمن OAuth & Permissions، أضف نطاق رمز البوت
chat:write. لا يحتاج Excubius إلى أي شيء آخر. -
حدد Install to Workspace واسمح به. انسخ Bot User OAuth Token، الذي يبدأ بـ
xoxb-. -
على الخادم، انتقل إلى حساب الخدمة بالأمر
sudo -iu excubiusواضبط الرمز المميز في/opt/excubius/.env:SLACK_BOT_TOKEN=xoxb-…SLACK_DEFAULT_CHANNEL=#alertsتتلقى
SLACK_DEFAULT_CHANNELالتحذيرات والتنبيهات الحرجة لكل كيان ليس له قناة خاصة في أي موضع فوقه. وهي#alertsعندما تتركها. -
أعد تشغيل المنصة:
export XDG_RUNTIME_DIR=/run/user/$(id -u)systemctl --user restart excubius.service
يطلب المثبّت أيضًا رمز بوت Slack والقناة الافتراضية؛ ويطلبهما sudo ./install.sh --reconfigure مرة أخرى. وإلى أن يُضبط الرمز المميز، تعرض Settings › Notifications العبارة Slack is not configured on the server ولا يُرسل شيء.
إضافة قناة لكيان
- في Slack، افتح القناة، مثل
#ciguapa-alerts، وادعُ التطبيق إليها، مثلًا بالأمر/invite @Monitoring. لا يستطيع التطبيق النشر إلا في القنوات التي ينتمي إليها. - في Excubius، افتح Settings › Notifications واختر الكيان في أداة الاختيار، مثل شركة خان الخليلي.
- حدد Add Slack channel.
- املأ الحقول:
- Name: لفريقك، مثل تنبيهات خان الخليلي.
- Slack channel:
#nameبأحرف صغيرة، أو معرّف القناة، مثلC0123456789. - Minimum: أدنى خطورة تُنشر، وهي Info أو Warning أو Critical. لا تُنشر التنبيهات الأقل منها.
- Message language: English أو Español. تتطلب الإسبانية الميزة
ui.i18n؛ ومن دونها يذكر الحقل أن الرسائل بالإنجليزية.
- حدد Add Slack channel.
- حدد Test على القناة الجديدة.
تظهر رسالة اختبار في قناة Slack ويعرض Excubius العبارة Test message sent. إذا رفضها Slack، يذكر الخطأ السبب، مثل not_in_channel: ادعُ التطبيق إلى القناة، وتحقق من اسم القناة، ثم أعد الاختبار.
تذهب الآن تنبيهات شركة خان الخليلي وكل ما تحتها إلى تلك القناة. ويمكن أن تكون للكيان عدة قنوات، مثل قناة للتحذيرات وأخرى للتنبيهات الحرجة فقط.
تعطيل قناة أو تعديلها أو إزالتها
في صف القناة:
- استخدم مفتاحها لتعطيلها دون إزالتها، ثم تفعيلها مرة أخرى لاحقًا. وما دامت كل قنوات الكيان معطلة، يستخدم الكيان القنوات الموروثة من أعلى.
- حدد Edit لتغيير أي حقل، ثم Save.
- حدد Remove لإيقاف الإرسال إليها. وتبقى القناة نفسها في Slack.
كيف تجد الرسالة قناتها
تعرض الصفحة النتيجة للكيان المحدد ضمن Where alerts go: قنواته الخاصة، أو القنوات الموروثة مع الكيان الذي ترثها منه، أو القناة الافتراضية للخادم.
| الحالة | وجهة التنبيه |
|---|---|
| لكيان التنبيه قنوات مفعّلة | قنواته الخاصة، وتُرشَّح كل منها بحسب Minimum الخاص بها |
| لا قنوات له، لكن لأحد أسلافه قنوات | قنوات أقرب سلف لديه أي قنوات |
| لا قناة لأي كيان على المسار | SLACK_DEFAULT_CHANNEL، للتحذيرات والتنبيهات الحرجة |
| لا قناة ولا قناة افتراضية | لا وجهة؛ وتذكر الصفحة ذلك |
تحمل كل رسالة المورد ومسار كيانه، والفحص، والقيمة مقابل الحد وموضع ضبط ذلك الحد، ومدة استمرار الحالة، والإجراء المقترح من كتالوج الفحوصات إن وُجد، ورابطًا إلى التنبيه. ولا تذكر الرسائل اسم المنتج أبدًا.
ما يُبقي القناة هادئة:
- تنبيه واحد لكل حالة. تحدّث التكرارات التنبيه ولا ترسل شيئًا.
- فترة الهدوء. رسالة واحدة على الأكثر لكل حالة كل 10 دقائق، ما لم ترتفع الخطورة. ويغيّر إعداد الخادم
EXCUBIUS_NOTIFY_QUIET_MINUTESهذه الفترة. - السبب الجذري. عندما يتعذر الوصول إلى مورد، يُرسل تنبيه حرج واحد Cannot reach وتنتظر التنبيهات الأخرى للمورد إلى أن يُحل.
- الكتم ونوافذ الصيانة. لا يُرسل شيء طوال مدتها؛ وما لم تعلم به القناة بعد يُرسل عند انتهائها، إن كان لا يزال ساريًا.
- لا إشعار بالتخفيف. يُسجَّل الانخفاض من حرج إلى تحذير في الخط الزمني للتنبيه ولا يُرسل. ولا يُرسل الحل إلا إذا أُرسل الفتح.
- الميزات المعطلة. لا تُرسل أبدًا تنبيهات الوحدات التي تكون ميزتها معطلة، ولا توصيات الأمان كذلك.
لا يعترض Slack المراقبة أبدًا: تُخزَّن النتائج وتُقيَّم أولًا، ثم تخرج الرسائل بعد ذلك مباشرة ومن مسح في الخلفية كل 15 ثانية. ويُسجَّل التسليم الفاشل في الخط الزمني للتنبيه وتعيد المحاولة عمليات المسح التالية، بثلاث محاولات في المجموع.
نفّذ ذلك عبر API
| المهمة | الطلب |
|---|---|
| عرض قنوات كيان وتوجيهه الفعلي | GET /api/v1/entities/{id}/channels |
| إضافة قناة | POST /api/v1/entities/{id}/channels |
| تغيير قناة أو تعطيلها أو تفعيلها | PATCH /api/v1/channels/{id} مع أي من name وconfig وmin_severity وlocale وenabled |
| إزالة قناة | DELETE /api/v1/channels/{id} |
| إرسال رسالة اختبار | POST /api/v1/channels/{id}/test. يجيب بـ {"ok": true}، أو {"ok": false, "error": "not_in_channel"} مع سبب Slack |
curl -s "${H[@]}" -X POST "$BASE/entities/$CIGUAPA/channels" -d '{
"kind": "slack", "name": "Ciguapa alerts", "config": {"channel": "#ciguapa-alerts"},
"min_severity": "warning", "locale": "es"
}'