Skip to main content

Dashboard

Dashboard

Overview

The Dashboard is the first page of Zenarmor (Sensei) and allows you to view the most critical network activity at a glance.

During Zenarmor's development, we did our best to use everyday plain English and explicit texts on the UI. If you're familiar with your home router's management user interface, you may feel home :)

Zenarmor Dashboard

Figure 1. Zenarmor's Dashboard

It consists of the following areas:

  1. Notifications Bar: When the application database is updated automatically or an update is available for the engine, notifications are displayed on the bar.

Notifications on the Dashboard

Figure 2. Notifications on the Dashboard

  1. Configuration Bar: You may configure your dashboard by setting the configuration parameters on this bar. The following parameters may be set:

    1. Add Filter
    2. Refresh Interval
    3. Report Interval
    4. Reporting Criteria
    5. Add & Sort Charts

Dashboard Configuration Bar

Figure 3. Dashboard Configuration Bar

  1. Interactive Charts: Zenarmor provides information rich charts and graphs for monitoring activities in your network. By clicking or hovering over charts, you will see additional information or follow links to other pages. For more information about the charts, please refer to Charts.

To view the Dashboard, in the OPNsense GUI navigate to Zenarmor --> Dashboard.

Customizing your Dashboard

You may customize your Dashboard to suit your preferences.

Dashboard

Figure 4. Dashboard

Adding New Charts or Sorting Charts

You may add or sort the available charts on the Dashboard from the list by clicking Add & Sort Charts. Select the reports which are the most useful for managing your network. More than 60 charts are available for reporting.

Adding or Sorting Charts

Figure 5. Adding or Sorting Charts

Adding Filters to Narrow Down Results

Filters may be applied to narrow down the displayed results.

For example, if you select Application Category from the Add Filter menu, and filter the Remote Access category, the dashboard will show only remote access sessions. You may also invert the match by selecting not equal to to exclude remote access sessions from the results.

Add filter to chart

Figure 6. Add filter to chart

After you add the filter, graphs will only display the matching information as shown in figure 7 below.

Filtered Chart

Figure 7. Filtered Chart

Charts may alternatively be filtered using the Drill Down menu which is displayed when you click on any chart.

Report Drill Down

Figure 8. Report Drill Down

For more information on adding filters, refer to Reporting.

Changing Dashboard Refresh Time Interval

You may refresh the dashboard by manually clicking Refresh Reports or you may set a time interval for automatic refreshing. Below are the listed time intervals available in the Refresh Interval dropdown box.

  • 15 secs
  • 1 min
  • 5 mins
  • 15 mins

Setting the refresh interval

Figure 9. Setting the refresh interval

Setting Report Time Range

The Reports Interval is the time interval of the data which is displayed in the reports. The Last 24 Hours time interval, for instance, will show only data that was captured within the last 24 hours.

You may select from the list of predefined time intervals or you may set a custom one.

Predefined reports intervals

Figure 10. Predefined Reports Intervals

Custom Report Interval

Figure 11. Custom Report Interval

After you set a custom time interval for the reports, you will see a notification including the time interval at the top header bar.

Custom Time Interval Notification

Figure 12. Custom Time Interval Notification

caution

You may need more system memory for reporting long time intervals. You may encounter some performance issues when you do not have enough RAM.

Changing Reporting Criteria

You may monitor your network traffic by

  • Number of sessions
  • Volume of data
  • Number of packets

By default, reports show the number of sessions.

Reporting criteria

Figure 13. Reporting Criteria

Add/Sort Charts On Dashboard

To add/sort charts on a dashboard:

  1. Click Add & Sort Charts. This will open a window with the available charts listed.
  2. To add a chart, click on the check box to select the chart you wish to add.
  3. To move a chart up or down in the list, drag and drop the chart that you wish to move as shown in figure 14.
  4. Click Save Changes at the bottom of the Add & Sort Charts window. This will display a notification window indicating that the dashboard has been changed as shown in figure 15.
  5. Click Refresh on the notification window to close it and return to the dashboard. The new chart will now be included on the dashboard.

Reordering the charts on the dashboard

Figure 14. Reordering the charts on the dashboard

A message indicating that the dashboard has changed

Figure 15. A message indicating that the dashboard has changed

Another way to change the order of the charts on the Dashboard is to click on the header of each chart pane and drag it to a new location.

Drag and drop chart pane on the dashboard

Figure 16. Drag and drop chart pane on the dashboard