یکپارچگی Slack
اعلان‌های لحظه‌ای خطای ابرووا تریس را با incoming webhook در workspace مربوط به Slack بگیرید. webhook را بسازید، در کنسول ابرووا وصلش کنید و تستش کنید.
اعلان‌های لحظه‌ای خطا را در workspace مربوط به Slack بگیرید. یاد بگیرید چطور webhook بسازید، آن را وصل کنید و اعلان‌ها چه شکلی دارند.
- ساختن incoming webhook در Slack
- پیکربندی اعلان‌های Slack در ابرووا تریس
- محتوای اعلان‌ها
- تست یکپارچگی Slack
Slack سرویسی بیرون از ایران است و ممکن است از برخی شبکه‌های داخل ایران در دسترس نباشد. برای راه‌اندازی و خواندن هشدارها به اتصالی نیاز دارید که به Slack برسد، و پیام‌ها فقط وقتی می‌رسند که hooks.slack.com پاسخ دهد؛ ارسال‌های ناموفق در لاگ ارسال یکپارچگی نمایش داده می‌شوند. اگر این برای تیم شما مشکل است، به‌جای آن یا در کنارش از یکپارچگی ایمیل یا Webhook استفاده کنید.
این‌که پروژه‌ی شما از کدام کانال‌ها می‌تواند استفاده کند، در صفحه‌ی ابرووا تریس ← یکپارچه‌سازی‌ها در کنسول ابرووا نمایش داده می‌شود.
ساختن webhook در Slack#
- به api.slack.com/apps بروید
- روی «Create New App» ← «From scratch» کلیک کنید
- نام اپ را «AbrovaTrace» بگذارید و workspace خود را انتخاب کنید
- در نوار کناری به «Incoming Webhooks» بروید
- «Activate Incoming Webhooks» را روشن کنید
- روی «Add New Webhook to Workspace» کلیک کنید
- کانالی را که می‌خواهید اعلان‌ها به آن بروند انتخاب کنید
- URL مربوط به webhook را کپی کنید
URL مربوط به webhook شما این شکلی است: https://hooks.slack.com/services/...
پیکربندی در ابرووا تریس#
- در کنسول ابرووا، ابرووا تریس ← یکپارچه‌سازی‌ها را باز کنید (یکپارچگی‌ها متعلق به پروژه‌ی انتخاب‌شده‌اند)
- روی «افزودن یکپارچه‌سازی» کلیک کنید و Slack را انتخاب کنید (یا روی کارت Slack «اتصال» را بزنید)
- یک نام وارد کنید و URL مربوط به webhook را جای‌گذاری کنید
- روی «ذخیره و ارسال تست» کلیک کنید تا ذخیره و بررسی شود (یا «ذخیرهٔ کانال»)
| گزینه | نوع | اجباری | توضیح |
|---|---|---|---|
| Name | string | بله | نامی آشنا (مثلاً #alerts) |
| Incoming webhook URL | string | بله | URL کامل webhook در Slack از مرحله‌ی ۱. باید روی hooks.slack.com باشد (https://hooks.slack.com/...) |
بعد از ذخیره
مدیریت یکپارچگی‌ها (افزودن، ویرایش، روشن و خاموش کردن، حذف، تست) نقش admin یا owner می‌خواهد؛ همه‌ی نقش‌ها می‌توانند آن‌ها و لاگ ارسالشان را ببینند. نقش‌ها و دسترسی‌ها را ببینید.
URL مربوط به webhook بعد از ذخیره دیگر هرگز نمایش داده نمی‌شود: فرم آن را «تنظیم‌شده» نشان می‌دهد و فقط https://hooks.slack.com/… دیده می‌شود. دست نزنید تا URL ذخیره‌شده بماند، یا جایگزینی را بزنید تا URL تازه‌ای جای‌گذاری کنید. فقط آدرس‌های webhook خود Slack (https://hooks.slack.com/...) پذیرفته می‌شوند.
قالب اعلان#
پیام‌های Slack از ابرووا تریس شامل این‌هاست:
- سرتیتر: نام کاربری ربات AbrovaTrace همراه با آیکون ⚠️
- عنوان هشدار:
New Error: <error message>، با لینک به خطا - متادیتا: پروژه، محیط، زمان اولین دیده شدن و تعداد رخدادها
پیام‌های خطای جدید اولین باری که خطا دیده می‌شود فرستاده می‌شوند. تشخیص جهش هم اینجا پیام می‌گذارد، و قوانین هشدار و مانیتورهای cron هم وقتی این کانال را برایشان انتخاب کنید.
بهترین روش‌ها#
برای محیط‌های مختلف کانال‌های جداگانه داشته باشید (#prod-errors، #dev-errors)
خطاهای پرسروصدای شناخته‌شده را حذف کنید تا هرگز اعلان ندهند
بحث درباره‌ی خطاها را در threadهای Slack مرتب نگه دارید
عیب‌یابی#
اعلانی نمی‌رسد؟
- مطمئن شوید URL مربوط به webhook درست است؛ باید با https://hooks.slack.com/ شروع شود
- مطمئن شوید یکپارچگی در ابرووا تریس ← یکپارچه‌سازی‌ها روشن است
- مطمئن شوید اپ Slack در workspace شما نصب است
- دوباره دکمه‌ی «ارسال تست» را امتحان کنید
- لاگ ارسال یکپارچگی را ببینید: timeout یا خطای اتصال یعنی Slack در دسترس نبوده است
پیام‌ها به کانال اشتباه می‌روند؟
- URL مربوط به webhook کانال را تعیین می‌کند
- برای کانال درست یک webhook تازه بسازید
- یکپارچگی را در ابرووا تریس ← یکپارچه‌سازی‌ها ویرایش کنید و روی URL مربوط به webhook «جایگزینی» را بزنید
به محدودیت نرخ می‌خورید؟
- Slack برای incoming webhookها محدودیت نرخ دارد
- از گروه‌بندی خطاها برای کم کردن تعداد اعلان‌ها استفاده کنید
- با قوانین نادیده‌گیری، خطاهای پرسروصدا را حذف کنید