مستندات ویرالینک

هشدار‌ها (Alarms)

ویرالینک امکان ایجاد و مدیریت هشدار‌های مرتبط به موجودیت‌های متفاوت را دارد. موجودیت‌هایی از قبیل دستگاه‌ها، دارایی‌ها، مشتری‌ها و غیره. برای مثال می‌توانید پیکربندی کنید، در صورتی که دمای سنسور از حد آستانه فراتر رود، یک هشدار ایجاد شود. البته این مثال بسیار ساده‌ای از هشدار‌ها است درحالیکه در سناریو‌های دنیای واقعی می‌توانند بسیار پیچیده‌تر باشد.

مفاهیم اصلی #

مفاهیم اصلی موجود در هشدار ها عبارت است از:

مولد (Originator) #

مولد هشدار موجودیتی است که باعث به وجود آمدن هشدار میشود. برای مثال دستگاه A یک مولد است اگر پلتفرم دمای بیش از حد مجاز را از دستگاه دریافت کرده و هشدار “HighTemperature” را به صدا درآورد.

نوع (Type) #

نوع هشدار کمک می‌کند تا دلیل هشدار را بتوان از یکدیگر تشخیص داد. به عنوان مثال “LowHumidity” و “HighTemperature” دو هشدار متفاوت از یکدیگر هستند.

سطح (Severity) #

هر هشدار دارای یک سطح هشدار می‌باشد که یکی از سطح های مقابل است: بحرانی [Critical]، مهم [Major]، جزئی [Minor]، اخطار [Warning] و نامشخص [Indeterminate]

چرخه عمر (Lifecycle) #

یک هشدار میتواند فعال (active) یا پاک شده (cleared) باشد. زمانیکه یک هشدار توسط پلتفرم ایجاد می‌شود زمان شروع (start) و پایان یک پیام ثبت می‌شود. به صورت پیشفرض زمان شروع و پایان آن یکسان است. اما در صورتی که شرایط یک هشدار چندین بار تکرار شود ویرالینک زمان پایان (end time) هشدار را بروزرسانی خواهد کرد. در صورتی که روایدادی منطبق با شرایط پاک شدن هشدار رخ دهد پلتفرم به صورت خودکار هشدار را پاک می کند. پاک شدن خودکار هشدار‌ها اختیاری و با پیکربندی شرایط پاک شدن هشدار فعال می‌شود. همچنین کاربر میتواند یک هشدار را به صورت دستی نیز پاک کند.
یک هشدار در کنار وضعیت فعال یا پاک شده، حالت تصدیق (acknowledgment) یک هشدار را نیز ذخیره می‌کند. تصدیق یک هشدار به منزله دیده شدن و بررسی هشدار توسط یک شخص می‌باشد. تصدیق یک هشدار از طریق ابزارک داشبورد و یا تب جزییات موجودیت امکان پذیر است. به طور خلاصه یک هشدار ۴ حالت ممکن برای فیلد وضعیت (status) خود دارد.

  • تصدیق نشده فعال (ACTIVE_UNACK) – هشدار پاک نشده و تصدیق نشده است
  • تصدیق شده فعال‌ (ACTIVE_ACK) – هشدار پاک نشده اما تصدیق شده
  • تصدیق نشده پاک شده (CLEARED_UNACK) – هشدار پاک شده اما هنوز تصدیق نشده
  • تصدیق شده پاک شده (CLEARED_ACK) – هشدار پاک شده و تصدیق شده

یکتایی هشدار #

هشدار ها با ۳ مولفه مولد، نوع و زمان شروع هشدار از یکدیگر متمایز می‌شوند. بنابراین دو هشدار فعال با مولفه‌های یکسان مولد، نوع و زمان شروع وجود نخواهد داشت.
فرض کنیم که یک قاعده هشدار ایجاد کردیم تا در زمان افزایش دما به بیش از ۲۰ درجه، یک هشدار “HighTemperature” ایجاد کند. همچنین شرط پاک شدن هشدار را نیز رسیدن دما به ۲۰ درجه یا کمتر از آن پیکربندی کردیم. ترتیب رویدادهای ورودی به این شکل است:

  • ساعت ۱۲:۰۰ – دما برابر ۱۸ درجه
  • ساعت ۱۲:۳۰ – دما برابر ۲۲ درجه
  • ساعت ۱۳:۰۰ – دما برابر ۲۵ درجه
  • ساعت ۱۳:۳۰ – دما برابر ۱۸ درجه

در مثال بالا پس از اتفاق افتادن رویداد ها شما یک هشدار “HighTemperature” با زمان شروع ۱۲:۳۰ و زمان پایان ۱۳:۰۰ خواهید داشت.

انتشار (Propagation) #

فرض کنیم که شما ۱۰۰۰ مشتری و هر مشتری ۱۰۰۰ دستگاه دارند پس شما ۱ میلیون دستگاه دارید. در صورتی که بخواهید یک داشبورد برای نمایش تمام هشدار های فعال داشته باشید ممکن است با حجم بسیار زیادی از داده های کم ارزش و غیر مهم رو به رو شوید. ویرالینک به شما امکان میدهد تا در زمان ایجاد یک هشدار مشخص کنید که آیا این هشدار برای موجودیت های بالادستی قابل مشاهده باشد یا خیر. ما همچنین می‌توانیم روابطی را که باید بین موجودیت های بالادستی و مولد وجود داشته باشد تا هشدار منتشر شود، به صورت اختیاری مشخص کنیم.

سوالات متداول و روش کار #

چگونه هشدار ایجاد کنیم؟ #

ساده ترین راه برای ایجاد هشدار استفاده از قواعد هشدار در بخش پروفایل دستگاه‌ها است.

همچنین می‌توانید به کمک قواعد سناریو نویسی و گره‌های ایجاد هشدار و پاک کردن هشدار منطق خود را در زمینه ایجاد و حذف هشدار‌ها پیکربندی کنید.

چگونه هشدار‌های مربوط به یک دستگاه یا موجودیت را پیدا کنم؟ #

برای اینکار کافیست بر روی دستگاه یا دارایی خود کلیک کرده و در تب هشدار‌ها با انتخاب بازه زمانی مد نظر هشدار های خود را ببینید.

چگونه هشدار‌های خود را در داشبورد مصورسازی کنیم؟ #

در مستندات شروع به کار دیدیم که چگونه می‌توان یک ابزارک هشدار را به داشبورد اضافه کنیم.
در قسمت تنظیمات ابزارک میتوانید تنظیمات زیر قابل پیکربندی است:

  • برحسب وضعیت فیلتر کنید. تجمیع هر یک وضعیت‌های فعال / پاک شده / تصدیق شده / تصدیق نشده
  • برحسب شدت هشدار فیلتر کنید.
  • فیلتر لیست انواع هشدار را مشخص کنید.
  • فعال یا غیر فعال سازی جستجوی هشدار‌های انتشار یافته (به صورت پیشفرض غیرفعال میباشد).

چگونه در زمان ایجاد یا پاک شدن هشدار، نوتیفیکیشن (اطلاع رسانی از طریق کانال هایی مثل ایمیل یا پیامک) ارسال کنیم؟ #

برای این کار مستندات ارسال اطلاع رسانی در پروفایل دستگاه‌ها را مطالعه بفرمایید.

چگونه از طریق API در هشدار های خود پرس و جو (Query) کنیم؟ #

می‌توانید از قسمت Alarm-Controller مربوط به مستندات REST API هشدار‌های خود را از طریق API مدیریت نمایید.