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

{% block title %}Traffic Calculation{% 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 use Traffic Calcullation</h4>
                    <hr>
                    <h5 style="margin-top: 30px;"> Calculating Traffic </h5>
                    <p class = "text-justify">
                        There are two ways available how the data traffic sent by and received by a device or a group of devices over a period of time can be calculated and visualized.
                    <ul>
                        <li>Visualization in Grafana dashboard - allows for interactive overview of daily traffic and sums over period of time.</li>
                        <li>Calculation on server - produces tabular and CSV output based on parameters.</li>
                    </ul>
                    </p>
                    <h5>Visualization in Grafana dashboard</h5>
                    <p class = "text-justify">
                        Grafana is a software for interactive visualization of data. If Grafana integration has been enabled for your DWARFG_LONG deployment, you should have the free edition of Grafana installed and configured and the Traffic Counter dashboard imported into Grafana. Also, the Traffic Counter page in DWARFG_LONG UI will redirect you on the dashboard automatically.
                    </p>
                    <p class = "text-justify">
                        To login into Grafana use:
                        <ul>
                            <li>Username: <b>{{ grafanaLoginUsername }}</b></li>
                            <li>Password: <b>{{ grafanaLoginPassword }}</b></li>
                        </ul>
                    </p>
                    <p class = "text-justify">
                        Once in Traffic Counter dashboard, you are able to select either of any Monitoring Group or any single device. You can also select the range you are interested in.
                    </p>
                    <p class = "text-justify">
                        The dashboard shows daily traffic of the selected Monitoring Group and single device over a period of time, together with the sums for Received, Transmitted and Total traffic for the selected group and device.
                    </p>
                    <p class = "text-justify">
                        The graphs and sums are provided separately for:
                    </p>
                    <p class = "text-justify">
                    <ul>
                        <li>Cellular traffic</li>
                        <li>Non-cellular traffic</li>
                        <li>All traffic</li></ul>
                    </p>
                    <p class = "text-justify">
                        If you need to set which interfaces on your device are of cellular nature and which not, please visit <b>Network Interfaces</b> table in <b>Device details</b>. Update the settings by checking (or unchecking) the <b>Cellular</b> checkbox for the network interfaces reported by the device and do not forget to click <b>Update Settings</b> button below the interfaces table. The changes in network interface type are immediately reflected in data though you may want to hit <b>Refresh</b> button to force Grafana to reread the updated data from the database.
                    </p>
                    <p class = "text-justify">
                        If you are interested in reviewing daily traffic or seeing counters for all of your devices, simply select the <b>All devices</b> monitoring group, as that encompasses all devices all the time.
                    </p>
                    <p class = "text-justify">
                        The traffic counters are stored in the database once per day and kept there for around 120 days. If you want to go further in the past, you need to create another Grafana dashboard for that, based around <b>netdevs_monthly_traffic</b> in database (as opposed to the Traffic Counter dashboard that takes the data from the <b>netdevs_daily_traffic</b>). Naturally, the granularity of the data there are one entry per device network interface per month.
                    </p>
                    <p class = "text-justify">
                        Devices are organized into Monitoring groups. You are able to calculate traffic for a monitoring group. To calculate traffic for all devices, use <b>All devices</b> monitoring group.
                    </p>
                    <h5>Enabling Grafana integration</h5>
                    <p class = "text-justify">
                    <ul>
                        <li>Grafana integration can be performed anytime after the DWARFG_LONG deployment completes.</li>
                        <li>The integration must be done by server administrator.</li>
                        <li>If you have On-premise version of DWARFG_LONG and have a single deployment installed, contact your admin to execute the <b>dwarfg_grafint</b> command as root user on the server command line. That's all that is needed. For multi-deployment scenario see below.</li>
                        <li>If you have hosted (SaaS) version, you would be not able to detect if you have single or multi-deployment scenario. You need to contact your SaaS operator to enable the Grafana integration.</li>
                        <li>For multi-deployment scenario:
                            <ul>
                                <li>Grafana integration can be enabled only for one DWARFG_LONG deployment on one machine/VM automatically.</li>
                                <li>As Grafana itself is a separate SW, you may opt to perform manual configuration of Grafana, but that is up to you and it is not supported by Dwarf Technologies.</li>
                                <li>For SaaS, it is highly recommended to have separate VM for every DWARFG_LONG deployment for many reasons, primarily security. This way also assures that the Grafana integration can be enabled for every deployment as one VM per deployment means single-deployment scenario from the VM/machine point of view. In this scenario, enabling the Grafana integration for a deployment/VM consist of simply running the <b>dwarfg_grafint</b> command on the particular VM.</li>
                            </ul>
                        </li>
                    </ul>
                    </p>
                    <br>
                    <h5>Calculation on the server</h5>
                    <p class = "text-justify">
                        Calulation of the devices traffic can be done on the server by executing the <b>dwarfg_trafcnt</b> command as server admin.
                    </p>
                    <p class = "text-justify">
                        The <b>dwarfg_trafcnt</b> command shows help if run without parameters. The following description is for reference only.
                    </p>
                    <p class = "text-justify">
                        You need to specify a few options to the command:
                    </p>
                    <ul>
                        <li>Traffic type you want to count:
                            <ul>
                                <li>-a ... any traffic type. Counts cellular and non-celluar traffic together. If you do not specify traffic type, this option is the default.</li>
                                <li>-c ... count cellular traffic only.</li>
                                <li>-n ... count non-cellular traffic only.</li>
                            </ul>
                        </li>
                        <li>Select if you want to count traffic per group or a device and provide that group/device identification:
                            <ul>
                                <li>-g "group name" ... e.g. -g "All devices"</li>
                                <li>-d deviceID ... e.g. -g ABAB</li>
                            </ul>
                        </li>
                        <li>Choose whether you want table with daily counters, monthly counters or just totals over the selected time period.
                            <ul>
                                <li>-D ... show daily traffic couters (this is chosen if you do not provide selection)</li>
                                <li>-M ... show monthly traffic counter</li>
                                <li>-T ... show totals over the selected time period</li>
                            </ul>
                        </li>
                        <li>Provide start and end date.
                            <ul>
                                <li>-s 2024-06-05 ... choose starting day of a time period</li>
                                <li>-e 2024-11-30 ... choose ending day of a time period</li>
                            </ul>
                        </li>
                        <li>-C ... produce CSV format</li>
                    </ul>
                    </p>
                    <hr>

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

{% endblock body %}