{% extends "base.html.twig" %}

{% block title %}How to manage Alerts{% endblock %}

{% block body %}

    <div class="container-fluid">
        <div class="row">
            <div class="col-md-12">
                <div class="bgc-white bd bdrs-3 p-20 mB-20">
                    <h4 class="c-grey-900"><i class="c-yellow-500 fas fa-question-circle"></i> How to manage Alerts</h4>
                    <hr>
<h5 style="margin-top: 30px;"> Alerts in general </h5>
                    <hr>
<p class = "text-justify">
Alerts purpose is to monitor the defined criteria (e.g. device temperature, availability, free disk space, number of reboots) and trigger, siwtching to the <b>Raised</b> state when criteria are met. Based on <a href="{{ path('admin_help', {page: 'notifications'}) }}"> notification settings</a>, a notification can be send via one or more notification channels as well.
</p>
<p class = "text-justify">
List of alerts is sortable and searchable, similar to the devices listing.
</p>
<p class = "text-justify">
The table shows some of the alert definitions, but it takes some time to learn how to read it. Before getting to the definitions, note these columns:
<ul>
<li><b>Triggered</b> ... Shows if the alert is triggered <i>at the moment</i>.</li>
<li><b>Triggered time</b> ... Shows time of the most recent allert triggering.</li>
<li><b>Count</b> ... Shows how many times was the alert triggered.</li>
<li><b>Enabled</b> ... Tells if alert is enabled (default) or not. This way you can deactivate any alert.</li>
<li><b>Active</b> ... Tells if the alert is actually being checked during alert evaluation. In case there is an error in definition, alert may become non-active (also called <i>Invalid</i>). Also, there is a brief moment the alert stays Inactive just after alert definition change and before the system picks up the new definition and validates it, setting the alert to Active.</li>
</ul>
</p>
<h5 style="margin-top: 30px;">Notification channels</h5>
                    <hr>
<p class = "text-justify">
You need to <a href="{{ path('admin_help', {page: 'notifications'}) }}">setup notification channels</a> in <a href="{{ path('admin_settings') }}">System -&gt Settings</a> so that notification can be delivered to you once alert triggers.<br> Currently supported notification channels are:
<ul>
<li>Slack</li>
<li>E-mail - an opt-in channel. Should you want to get e-mails, you need to check <b>Enable Email Notification</b> checkbox and provide a valid e-mail address.</li>
</ul>
                    </p>
                    <p>Once you setup your channels, notification for any triggered alert is sent to all enabled notification channels.</p>
<h5 style="margin-top: 30px;">Alert target</h5>
                    <hr>
<p class = "text-justify">
Alert can check one target type. The most used target types are:
<ul>
<li><b>Device</b> ... Alert is checking a particular device (e.g. monitoring one particular device availability).</li>
<li><b>Number (#) of devices in a group</b> ... Alert is checking all devices in a group (e.g. monitoring temperature of every device in a group) and if the number of devices matching the condition matches or exceeds the defined number, the alert triggers (e.g. trigger when at least one device in a group X temperature goes out of range 20 .. 60 degrees of celsius).</li>
</ul>
</p>
<h5 style="margin-top: 30px;">Defining alert</h5>
                    <hr>
<p class = "text-justify">
To define an alert, you need to click on <b>Create Alert</b> first. Once on the alert creation page, you should select:
<ul>
<li><b>Name</b> ... alert name is used in notification so you should select something recognizable enough to tell you in the notification which alert was triggered.</li>
<li><b>Target type</b> ... Select if you want to monitor a particular device or a number of devices in a group.</li>
<ul>
<li>If you select a device, you need to select particular device by DevId or device name (if you are naming you devices)</li>
<li>If you select to monitor a number of devices in a group, you need to select a group and a number/amount of devices (in the sense of <i>at least a # (number) of devices in this group...</i></li>
</ul>
<li><b>Target specification</b> ... here you select what characteristic/metric are you monitoring. (e.g. <i>device temperature</i>)</li>
<li><b>Operator</b> ... here you select logical operation which is checked against one or more values mentioned below. (e.g. <i>outside of</i>)</li>
<li><b>First Number</b> ... enter/select first threshold (enter a number, e.g. 20 (as in 20 degrees))</li>
<li><b>Second Number</b> ... enter/select second threshold - if applicable - (enter a number, e.g. 60 (as in 60 degrees))</li>
</ul>
</p>
<h5 style="margin-top: 30px;">Example alert</h5>
                    <hr>
<p class = "text-justify">
The following alert triggers whenever a device in DWARFG_LONG system fails to contact server for 5 or more minutes.
<ul>
<li>Click on <b>Create Alert</b> button</li>
<li><b>Name</b> ... enter text, e.g. <b>Device lingering</b></li>
<li><b>Target type</b> ... select <b>at least # devs in grp</b></li>
<li><b>Target monitoring group</b> ... select the <i>'All devices'</i> group: <b>All devices</b></li>
<li><b>Target amount</b> ... enter 1 so that a single device matching condition can trigger the alert: <b>1</b></li>
<li><b>Target spec</b> ... select <b>Data Age</b></li>
<li><b>Oper first</b> ... select <b>greater than</b></li>
<li><b>Num first</b> ... select <b>5 minutes</b></li>
<li>Click on <b>Create Alert</b> confirmation button</li>
</ul>
                    </p>
<p>Note that the alert is listed as <i>Enabled</i> but <i>Inactive</i>. It takes a few seconds for alert validation before switching to the <i>Active</i> state. Please reload the page after a short while. If you still see the alert as <i>Inactive</i>, there is a problem with alert definition.
</p>


                </div>
            </div>
        </div>
    </div>

{% endblock body %}