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

{% block title %}Dashboard Explained{% 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> Dashboard Explained</h4>
					<hr>
<p class = "text-justify">
<a href="{{ path('admin_dashboard') }}"><b>The Dashboard page</b></a> is meant as a quick status overview of the system. While it compiles the most important health information about your devices on one place, it may get a little time to get used to. Let's explain the main elements of the page.
</p>
<h5 style="margin-top: 30px;">Global status</h5>
					<hr>
<p class = "text-justify">
The global DWARFG_LONG service status is the first light on the page. You may notice that the color matches the color of the light on the top status bar - and that clicking on the status light bar will always get you to the Dashboard.
</p>
<p class = "text-justify">
The different light meanings are:
<ul>
	<li>Green ... all good. Global status detailed explanation: DWARFG_LONG service is 100% healthy and none of the registered devices are misbehaving above a reasonable margin (slight connection delays are tolerated).</li>
	<li>Yellow ... warning, some action is pending or something is not ok. Global status detailed explanation: While DWARFG_LONG service is running fine, there are either some pending actions, some devices that are misbehaving, late to the report, alerts raised or we expect a problem to come in future. Examples:
		<ul><li>There are alerts raised for some devices/groups.</li>
		<li>There is a configuration update pending for a device (device configuration is not matching the desired configuration).</li>
		<li>There are no free device seats available.</li>
		<li>The license is close to expiration date.</li></ul></li>
	<li>Red ... error. Global status detailed explanation: DWARFG_LONG service is not running or having problems, determining device real status is not reliable.</li>
	<li>Grey (only in the top bar) ... DWARFG_LONG UI has issues determining DWARFG_LONG service state.</li>
</ul>
</p>
<p class = "text-justify">
Please note that the Dashboard is not refreshed automatically. It may happen that after some while, the actual status of the system changes. To see the update, you need to refresh the page. To indicate the changes in the global state, the global state top bar icon could be used - the icon <i> does </i> refresh regularly. In case the color in the top bar differs from the one you are seeing on the Dashboard, simply reload the Dashboard page.
</p>
<p class = "text-justify">
If the Dashboard page global status is not green, DWARFG_LONG tries to help you by giving a quick indicator of what is not ok in the caption below the global status light.
</p>
<h5 style="margin-top: 30px;">Global component lights</h5>
					<hr>
<p class = "text-justify">
Next to the global status light, the status is further decomposed into additional four lights:
<ul>
	<li>Number of free device slots ... when there are free device slots, the light is green and it is showing the number of free slots. If you are at the capacity and no new devices are trying to get registered, the light is yellow. If there are declined registrations of new devices because there are no free spots left, light is red and shows negative number - counter of declined registration attempts since service startup.</li>
	<li>Number of days left until the license expires ... red if license is expired, yellow when the license is about to expire (<20 days left) and green otherwise.</li>
	<li>Tunnel status indicator ... shows number of defined tunnels together with worst of their status - green if no issue is found, red if there is a problem with any tunnel detected.</li>
	<li>Group status indicator ... shows counter of groups and the worst status among the groups. Because groups are composed of devices, this actually translates to device performing as expected or not. If there is a sync error or raised alert, this light goes red. If there is e.g. a past alert (not raised at the moment but triggered since last manual alert cleanup), the light goes yellow. If all groups (and thus all devices) are ok, light is green.</li>
</ul>
</p>
<h5 style="margin-top: 30px;">Problem summary</h5>
					<hr>
<p class = "text-justify">
If no problem has been detected, you will not see anything between component lights and Groups breakdown. In the other case, DWARFG_LONG will try to give a one-sentence summary for every type of problem detected in the hope that it could help you with identifying where is the problem coming from.
</p>
<h5 style="margin-top: 30px;">Monitoring groups breakdown</h5>
					<hr>
<p class = "text-justify">
Every defined monitoring group has its own entry in the Dashboard. Until you define your own groups, you would see here only the very special <b><i>All devices</i></b> system group that simply contains all of the devices.
</p>
<p class = "text-justify">
Every group status breaks down to three components, each sporting a three-lights in a semaphore fashion. Before getting to the semaphores description, please note that each of the component lights caption is clickable so that you can quickly access the exact list of devices in that state.
<ul>
	<li><b>Freshness</b> ... shows if some devices are lingering or late
		<ul><li><b>Online</b> ... the number of devices that are on-time with data updates.</li>
		<li><b>Delayed</b> ... the number of devices that are slightly delayed with data update. NOTE: when not all of your devices are Delayed, semaphore intentionally shows green color as slight delays are not considered a warning state for the whole Monitoring Group.</li>
		<li><b>Late</b> ... the number of devices that are considered too late with data update, thus causing an error being reported.</li></ul></li>
	<li><b>Sync status</b> ... shows if there are configuration updates or update errors
		<ul><li><b>Synced</b> ... the number of devices that are in fully synchronized state - that is, there is no pending configuration change waiting for these.</li>
		<li><b>Pending</b> ... the number of devices for those there is a configuration change ready to be picked up on their next data exchange.</li>
		<li><b>Error</b> ... the number of devices that picked up the configuration change but did not applied the change (that is detected on their next data exchange).</li></ul></li>
	<li><b>Alerts</b> ... shows number of alerts relevant for this particular Monitoring Group
		<ul><li><b>Active</b> ... the number of valid and regularly evaluated alerts</li>
		<li><b>Past+Inv</b> ... the sum of:
			<ul><li>number of alerts triggered in past (and not acknowledged since) but not raised at the moment</li>
			<li>number of Invalid alerts - these are alerts that cannot be evaluated</li></ul></li>
		<li><b>Raised</b> ... number of alerts raised <i>at the moment</i></li></ul>
<i><b>NOTE</b> regarding alerts:</i> alerts that are defined against individual devices (not against any group) are being reported among the <b>All devices</b> group alerts.</li>
</ul>
</p>
</p>
<h5 style="margin-top: 30px;">Triggered alerts list</h5>
					<hr>
<p class = "text-justify">
If there are any triggered alerts (both alerts raised at the moment and raised in past but not cleaned up), their breakdown is given under the groups:
<ul>
	<li>For raised alerts, following is given:
		<ul><li>Name/link to the alert definition.</li>
		<li>Link to table of all devices for which the alert is raised.</li>
		<li>Several of such devices are listed directly - if the list is too long, it is clipped.</li></ul></li>
	<li>For past alerts:
		<ul><li>Name/link to the alert definition</li>
		<li>Link to clear the alert trigger counter ... by clicking on the link, the alert trigger counter is reset and the alert is no longer reported as triggered in past.</li></ul></li>
</ul>
                </div>
            </div>
        </div>
    </div>

{% endblock body %}