Revision as of 11:23, 6 January 2026

Dashboard

Dashboard allows placing panels with various types of data which can be refreshed on regular basis. The main purpose of this feature is to have realtime overview on the whole system or part of it. You can create your own panel layout templates and load them whenever you need them. Each user can create his own layouts which will be visible only to him or admin can creates global layouts visible for all users.

You can open dashboard template with direct URL:

http://localhost/voipmon/admin.php?user=yourUser&password=yourPass&dashboard=Default&hidemenu=1

Add panel

You can add as many panels as you can fit to the main layout window. The panel can be resized and moved. The panel can be locked or unlocked so you cannot move or resize them. Current layout can be saved as template by clicking on "save" button providing name of the template. If you choose existing name of a previously created panel you will be asked if you want to replace the old one. Panels on current layout can be deleted at once by clicking on "remove all panels" button. When you click on "hide menu" the current layout will hide the left menu and current layout will have maximized size.

Panel types

When adding new panel you can choose between various panel types:

CDR charts

This is analogical to the Charts section.

SIP responses (pie chart)

Top IP addresses

Custom CDR grid - by SIP IP

Custom grids allows to see total numbers of CDR grouped by source IP or destination IP and configure custom columns like MOS, Loss, Delay etc. You can also choose which column will be sorted by default.

Custom CDR grid - by SIP response

Custom CDR grid by SIP responses are identical to Custom CDR grid - by SIP IP except the CDR rows are grouped by SIP responses instead of IP addresses. This is handful in case you need to see SIP responses numbers.

Register charts (beta)

This panel type visualizes SIP registration statistics on the dashboard. You can display various registration metrics including successful registrations, failed registrations, and registration states.

To create a dashboard with register charts:

Navigate to GUI > Dashboard view
Click "new" or "create" to create a new dashboard
Select a desired layout for the dashboard
For each new panel, choose the panel type "Register charts beta" from the dropdown menu
After creating the panel, edit its settings to select a template or specific register series to display

Register charts require the SIP Register feature to be enabled. See Register for detailed configuration steps.

AI Summary for RAG

Summary: The Dashboard feature provides a customizable real-time monitoring interface with multiple panel types. Users can create personal layouts or admins can create global templates visible to all users. Available panel types include: CDR charts (similar to Charts section), SIP responses pie chart, Top IP addresses, Custom CDR grids grouped by SIP IP or SIP response (with configurable columns for MOS, Loss, Delay), and Register charts (beta) for SIP registration statistics. Panels can be resized, moved, locked/unlocked, and saved as templates. Direct URL access is supported with parameters for user authentication, dashboard name, and menu hiding.

Keywords: dashboard, panels, real-time monitoring, CDR charts, SIP responses, pie chart, top IP, custom grid, MOS, Loss, Delay, register charts, layout templates, global layouts, user layouts, hidemenu

Key Questions:

How do I create a custom dashboard in VoIPmonitor?
What panel types are available in the Dashboard?
How do I save a dashboard layout as a template?
How do I access the dashboard via direct URL?
How do I add register charts to the dashboard?
Can I create a dashboard visible to all users?
How do I display MOS/Loss/Delay metrics on the dashboard?
How do I group CDR data by SIP response on the dashboard?

@@ Line 1: / Line 1: @@
-== This doc describes order of GeoIP location services used with voipmonitor GUI ==
+[[Category:Configuration]]
+= Dashboard =
-'''In the GUI settings''' -> system config -> '''GeoIP''' (You can define your keys for maxmind or ipinfodb.)
+Dashboard allows placing panels with various types of data which can be refreshed on regular basis. The main purpose of this feature is to have realtime overview on the whole system or part of it. You can create your own panel layout templates and load them whenever you need them. Each user can create his own layouts which will be visible only to him or admin can creates global layouts visible for all users.
-* If you define keys for both providers the 'maxmind' have precedence.
-* In case you don't define a key, the local db will be used instead (this local db is updated with each GUI release, its stored into local db.)
-* In case you have no GeoIP data downloaded in local db (voipmonitor.org unacessible from GUI server), it will use following free(demo) portals in following order:
-** ipinfodb
-** freegeoip
-** maxmind
-== Manually Updating the Local GeoIP Database ==
+You can open dashboard template with direct URL:
-If you cannot upgrade the GUI directly but need to update the local GeoIP database, you can manually copy the GeoIP tables from a system that has the latest data (e.g., a server with a recently upgraded GUI).
+<code>http://localhost/voipmon/admin.php?user=yourUser&password=yourPass&dashboard=Default&hidemenu=1</code>
-'''Procedure to copy GeoIP tables:'''
+[[File:dashboardv2.png|Dashboard default template]]
-# On the source system (with the latest GUI version), backup the GeoIP tables:
+== Add panel ==
-<pre>
-mysqldump -u username -p voipmonitor geoip_country geoipv6_country > geoip_tables.sql
-</pre>
-# Restore the backup on the target system:
-<pre>
-mysql -u username -p voipmonitor < geoip_tables.sql
-</pre>
-# Update the GeoIP version record in the `system` table to match the source version:
-<pre>
-# First, check the current version on the source system
-mysql -u username -p -e "SELECT * FROM voipmonitor.system WHERE type = 'geoip_country_version';"
-# Then set the same version on the target system (example: version 14)
+You can add as many panels as you can fit to the main layout window. The panel can be resized and moved. The panel can be locked or unlocked so you cannot move or resize them. Current layout can be saved as template by clicking on "save" button providing name of the template. If you choose existing name of a previously created panel you will be asked if you want to replace the old one. Panels on current layout can be deleted at once by clicking on "remove all panels" button. When you click on "hide menu" the current layout will hide the left menu and current layout will have maximized size.
-mysql -u username -p -e "INSERT INTO voipmonitor.system (type, content) VALUES ('geoip_country_version', '14') ON DUPLICATE KEY UPDATE content = '14';"
-</pre>
-After completing these steps, the GeoIP warning popup should no longer appear, as the local database will now be up-to-date.
+== Panel types ==
-'''Note:''' This procedure is useful when:
+When adding new panel you can choose between various panel types:
-* Direct GUI upgrade is not possible
-* You have multiple systems and want to ensure consistent GeoIP data across them
-* You need to quickly update GeoIP data without waiting for a new GUI release
-== Correcting Incorrect GeoIP Data ==
+=== CDR charts ===
-The GeoIP location data is sourced from MaxMind. If you encounter incorrect IP location information, you can help improve the database accuracy by submitting a correction request to MaxMind directly.
+This is analogical to the [[Charts]] section.
-'''Procedure to submit a correction:'''
+[[File:dashboardv2-cdrcharts.png|CDR charts]]
-# Go to the MaxMind GeoIP Update Form: [https://www.maxmind.com/en/geoip-correction Submit a Correction Request]
-# Fill out the form with the IP address, country, and other location details that need to be corrected
-# Submit the correction request to MaxMind
-After MaxMind updates their database:
-# Notify the VoIPmonitor support team about the correction you submitted
-# The support team will release a new version of the GUI that includes the updated MaxMind database
-# Upgrade to the latest GUI version to get the corrected GeoIP data
-=== AI Summary for RAG ===
+=== SIP responses (pie chart) ===
-'''Summary:''' Describes the priority order for GeoIP services in VoIPmonitor (MaxMind API keys, local database, or free demo portals), how to manually update the local GeoIP database by copying tables between systems, and how to correct incorrect GeoIP data.
-'''Keywords:''' GeoIP, MaxMind, IPInfoDB, geolocation, IP location, map, CDR, correction, update database, geoip_country, geoipv6_country, manual restore, copy tables
+[[File:dashboardv2-piechart.png|SIP responses pie chart]]
+=== Top IP addresses ===
+[[File:dashboardv2-topip.png|Top IP addresses]]
+=== Custom CDR grid - by SIP IP ===
+Custom grids allows to see total numbers of CDR grouped by source IP or destination IP and configure custom columns like MOS, Loss, Delay etc. You can also choose which column will be sorted by default.
+[[File:dashboardv2-customcdrform.png|Custom CDR grid - form]]
+[[File:dashboardv2-customcdrgridbyip.png|Custom CDR grid - by SIP IP]]
+=== Custom CDR grid - by SIP response ===
+Custom CDR grid by SIP responses are identical to Custom CDR grid - by SIP IP except the CDR rows are grouped by SIP responses instead of IP addresses. This is handful in case you need to see SIP responses numbers.
+[[File:dashboardv2-customcdrgridbyresponse.png|Custom CDR grid - by SIP response]]
+=== Register charts (beta) ===
+This panel type visualizes SIP registration statistics on the dashboard. You can display various registration metrics including successful registrations, failed registrations, and registration states.
+To create a dashboard with register charts:
+# Navigate to '''GUI > Dashboard''' view
+# Click "new" or "create" to create a new dashboard
+# Select a desired layout for the dashboard
+# For each new panel, choose the panel type "Register charts beta" from the dropdown menu
+# After creating the panel, edit its settings to select a template or specific register series to display
+Register charts require the SIP Register feature to be enabled. See [[Register]] for detailed configuration steps.
+== AI Summary for RAG ==
+'''Summary:''' The Dashboard feature provides a customizable real-time monitoring interface with multiple panel types. Users can create personal layouts or admins can create global templates visible to all users. Available panel types include: CDR charts (similar to Charts section), SIP responses pie chart, Top IP addresses, Custom CDR grids grouped by SIP IP or SIP response (with configurable columns for MOS, Loss, Delay), and Register charts (beta) for SIP registration statistics. Panels can be resized, moved, locked/unlocked, and saved as templates. Direct URL access is supported with parameters for user authentication, dashboard name, and menu hiding.
+'''Keywords:''' dashboard, panels, real-time monitoring, CDR charts, SIP responses, pie chart, top IP, custom grid, MOS, Loss, Delay, register charts, layout templates, global layouts, user layouts, hidemenu
 '''Key Questions:'''
-* What is the order of GeoIP services used by VoIPmonitor?
+* How do I create a custom dashboard in VoIPmonitor?
-* How do I manually update the local GeoIP database without upgrading the GUI?
+* What panel types are available in the Dashboard?
-* How do I copy GeoIP tables from one system to another?
+* How do I save a dashboard layout as a template?
-* What is the geoip_country_version in the system table?
+* How do I access the dashboard via direct URL?
-* How do I correct incorrect GeoIP location data?
+* How do I add register charts to the dashboard?
+* Can I create a dashboard visible to all users?
+* How do I display MOS/Loss/Delay metrics on the dashboard?
+* How do I group CDR data by SIP response on the dashboard?