Settings: Difference between revisions
(Add info about international number configuration (local number and international prefix settings)) |
(Add 'select occurrence' field documentation for CDR custom headers - controls first vs last found value when headers appear multiple times (e.g., P-Asserted-Identity in initial INVITE vs re-INVITEs)) |
||
| Line 510: | Line 510: | ||
;Restrict to Regex pattern | ;Restrict to Regex pattern | ||
:Optional regular expression pattern to filter which header values are stored in the database. Only headers matching this regex pattern will be captured. For example: <code>^[0-9]+$</code> to capture only numeric values. | :Optional regular expression pattern to filter which header values are stored in the database. Only headers matching this regex pattern will be captured. For example: <code>^[0-9]+$</code> to capture only numeric values. | ||
;Select occurrence | |||
:Controls which occurrence of a SIP header is stored when the same header appears multiple times in a call (common for headers like <code>P-Asserted-Identity</code> that appear in both the initial INVITE and subsequent re-INVITEs). | |||
:* '''First found value:''' Captures the header value from the first occurrence (typically the initial INVITE). This is recommended when you only want the original value from call setup and want to ignore changes during the call (e.g., re-INVITEs during hold, transfers, or session modifications). | |||
:* '''Last found value:''' Captures the header value from the last occurrence found. Use this when you need the most recent value if the header changes during the call. | |||
'''Example: P-Asserted-Identity in Re-INVITEs''' | |||
If calls include <code>P-Asserted-Identity</code> in both the initial INVITE and subsequent re-INVITEs (e.g., during hold operations), the system will capture the header for each occurrence. To capture only the initial INVITE value and ignore re-INVITEs: | |||
# In '''Settings > CDR Custom Headers''', set '''Select occurrence''' to '''First found value''' | |||
# This stores only the header value from the initial INVITE, ignoring values from subsequent SIP requests | |||
This is particularly useful for ensuring consistent Caller ID information based on the original call setup rather than later modifications during the call session. | |||
=== When is a Restart Required? === | === When is a Restart Required? === | ||
| Line 1,142: | Line 1,156: | ||
== AI Summary for RAG == | == AI Summary for RAG == | ||
'''Summary:''' This article documents VoIPmonitor GUI settings including sensor configuration (with SSL/TLS parameters for decrypting encrypted SIP traffic), sensor health monitoring via RRD charts (buffer usage and packet drops graphs to diagnose sniffer host overload), troubleshooting server instances that do not appear in the GUI after hardware replacement, disabling sensors to stop data collection, CDR custom headers with their limitations and performance optimization (database index creation), distributed architecture troubleshooting for custom headers not visible in central GUI, GeoIP data loading, system configuration (basic, database, national, intervals, email, license, GeoIP, advanced), localization, and custom CDR URLs. Advanced settings include Http proxy (for upgrades) for configuring proxy servers behind firewalls, Pcap deduplication before download which can cause packet count mismatches between GUI SIP History and downloaded PCAP files, and ENABLE_CSRF_CHECK for security hardening by enabling CSRF (Cross-Site Request Forgery) protection tokens in the GUI to mitigate web attacks. Key topics: Enable GUI to run in iframe setting in Settings > System Configuration > Advanced allows embedding the VoIPmonitor GUI in iframes for subfolders like /ucloud or /unite - by default the GUI sends security headers (X-Frame-Options) to prevent iframe embedding for clickjacking protection; GUI in iframe not loading properly with 301 redirect errors can be fixed by enabling the "Enable GUI to run in iframe" setting to true; ENABLE_CSRF_CHECK in Settings > System Configuration > Advanced enables CSRF token validation for state-changing operations to increase session security and mitigate web attacks including XSS vulnerabilities - set to TRUE to enable and recommended for production environments; LICENSE UPDATE: After purchasing or renewing a license through voipmonitor.org portal, navigate to Settings > License and click the "get/update license key" button - the GUI automatically fetches your updated license if payment has been processed (no manual entry needed); if automatic retrieval fails, retrieve license manually from portal: log in to voipmonitor.org, navigate to Services > My services, locate license, view details, copy full license key content (multi-line text), paste into License key field in Settings > License; license token is a short text string for retrieving license key; license key field accepts full multi-line license key content; "get/update license key" button fetches license from VoIPmonitor portal; SENSOR DISABLE: Disabling a sensor in the GUI does NOT stop it from collecting data - the sensor process continues to capture and write to the database regardless of GUI status. To stop data collection permanently, run "systemctl stop voipmonitor" on the sensor host machine. Alternatively, use capture rules with SKIP=ON to prevent CDRs from being written to the database while keeping the service running for selective blocking; custom headers store raw SIP header values without regexp extraction or delimiter aggregation; DATABASE INDEX OPTIMIZATION: Custom header columns in cdr_next_X tables are NOT indexed by default to maintain high database write performance - to optimize performance for frequent or large-scale queries on custom SIP headers, manually create a database index by first querying cdr_custom_headers to find dynamic_table and dynamic_column (e.g., header 'X-Custom-Header' stored in cdr_next_2, column custom_header_3), then execute CREATE INDEX idx_custom_header_3 ON cdr_next_2 (custom_header_3) - adding indexes increases database load during CDR insertion so only create indexes on frequently queried headers; use EXPLAIN to verify the database uses your index (type: ref is index lookup, type: ALL is full table scan); if using cdr_partition_by_hours or daily partitioning, index is automatically created on all partitions; sensor SSL settings (ssl_key, ssl_cert, ssl_ipport) can be configured via GUI wrench icon; sensor health monitoring via RRD charts (Settings > Sensors > chart icon) showing buffer usage and packet drops to diagnose sniffer overload vs network quality issues; sensor troubleshooting for non-deletable local sensors in server/probe deployments; server instance troubleshooting when replacing hardware (server/SBC) and reusing IP address - requires manually creating sensor entry in Settings > Sensors and configuring managerip/managerport in voipmonitor.conf on the new server instance; DISTRIBUTED ARCHITECTURE: Custom headers not visible in central GUI for specific sensor despite being configured - check sensor's server_destination, server_destination_port, and server_password in /etc/voipmonitor.conf; delete sensor entry from GUI Settings > Sensors and restart sniffer service to re-register; without correct server_destination configuration, sensor captures headers locally but does not transmit CDRs to central database; GUI and sensor upgrades behind proxy servers can be configured via Settings > System Configuration > Advanced > Http proxy (for upgrades) or via curlproxy in voipmonitor.conf for remote sensors; license notification emails can be disabled by removing the email address in Settings > License; license email supports multiple recipients by entering email addresses separated by a comma (e.g., user1@example.com,user2@example.com); troubleshooting CDR custom headers not being captured or showing truncated content - check snaplen parameter (increase to 3200 or higher for long SIP headers like STIR/SHAKEN P-Asserted-Identity with verstat parameters) and custom_headers_max_size parameter (increase from default 1024 if header content is truncated); CDR timezone configuration - use "Sensors Timezone" setting in Settings > System Configuration > National to fix CDR times displaying in UTC instead of local timezone; the regular "Timezone" setting is for GUI host (reports, alerts), not for CDR data; all sensors sending data to the same database should use the same timezone; sensor OS timezone can be overridden via timezone or utc options in voipmonitor.conf; INTERNATIONAL NUMBERS CONFIGURATION: For international numbers not displaying or being handled correctly (missing country codes, showing in local format when they should be international, numbers not being classified as international, international calls grouped incorrectly), configure the local number (country name) and international prefix settings in Settings > System Configuration > National; set Local number to your country name (e.g., Australia, United States, Czech Republic); set International prefix to the international dialing prefix for your country (e.g., 0011 for Australia, 011 for US/Canada, 00 for many European countries, 010 for Japan); example: Australia deployment should use Local number = Australia, International prefix = 0011; these settings ensure VoIPmonitor correctly normalizes and displays international numbers based on your local numbering plan. | '''Summary:''' This article documents VoIPmonitor GUI settings including sensor configuration (with SSL/TLS parameters for decrypting encrypted SIP traffic), sensor health monitoring via RRD charts (buffer usage and packet drops graphs to diagnose sniffer host overload), troubleshooting server instances that do not appear in the GUI after hardware replacement, disabling sensors to stop data collection, CDR custom headers with their limitations and performance optimization (database index creation), distributed architecture troubleshooting for custom headers not visible in central GUI, GeoIP data loading, system configuration (basic, database, national, intervals, email, license, GeoIP, advanced), localization, and custom CDR URLs. Advanced settings include Http proxy (for upgrades) for configuring proxy servers behind firewalls, Pcap deduplication before download which can cause packet count mismatches between GUI SIP History and downloaded PCAP files, and ENABLE_CSRF_CHECK for security hardening by enabling CSRF (Cross-Site Request Forgery) protection tokens in the GUI to mitigate web attacks. CDR CUSTOM HEADERS: Settings > CDR Custom Headers allows capturing custom SIP headers (like X-Cisco-Org-ID) into database columns for viewing and searching; require adding header name to custom_headers in voipmonitor.conf and restarting sniffer to create database columns; configuration fields include Header Field, Name, Match in SIP by Header, Show as Column, Restrict to Regex pattern, and Select occurrence; SELECT OCCURRENCE FIELD controls which occurrence of a SIP header is stored when the same header appears multiple times in a call (common for headers like P-Asserted-Identity that appear in both initial INVITE and subsequent re-INVITEs); First found value captures header from first occurrence (typically initial INVITE) and ignores re-INVITEs during hold/transfers/session modifications- recommended when only original value from call setup is needed; Last found value captures final occurrence if header changes during call; to capture only initial P-Asserted-Identity and ignore re-INVITE values, set Select occurrence to First found value in Settings > CDR Custom Headers; this ensures consistent Caller ID based on original call setup rather than later modifications; custom headers limitations include no regexp extraction, no delimiter aggregation for multiple header values, and no per-method filtering. Key topics: Enable GUI to run in iframe setting in Settings > System Configuration > Advanced allows embedding the VoIPmonitor GUI in iframes for subfolders like /ucloud or /unite - by default the GUI sends security headers (X-Frame-Options) to prevent iframe embedding for clickjacking protection; GUI in iframe not loading properly with 301 redirect errors can be fixed by enabling the "Enable GUI to run in iframe" setting to true; ENABLE_CSRF_CHECK in Settings > System Configuration > Advanced enables CSRF token validation for state-changing operations to increase session security and mitigate web attacks including XSS vulnerabilities - set to TRUE to enable and recommended for production environments; LICENSE UPDATE: After purchasing or renewing a license through voipmonitor.org portal, navigate to Settings > License and click the "get/update license key" button - the GUI automatically fetches your updated license if payment has been processed (no manual entry needed); if automatic retrieval fails, retrieve license manually from portal: log in to voipmonitor.org, navigate to Services > My services, locate license, view details, copy full license key content (multi-line text), paste into License key field in Settings > License; license token is a short text string for retrieving license key; license key field accepts full multi-line license key content; "get/update license key" button fetches license from VoIPmonitor portal; SENSOR DISABLE: Disabling a sensor in the GUI does NOT stop it from collecting data - the sensor process continues to capture and write to the database regardless of GUI status. To stop data collection permanently, run "systemctl stop voipmonitor" on the sensor host machine. Alternatively, use capture rules with SKIP=ON to prevent CDRs from being written to the database while keeping the service running for selective blocking; custom headers store raw SIP header values without regexp extraction or delimiter aggregation; DATABASE INDEX OPTIMIZATION: Custom header columns in cdr_next_X tables are NOT indexed by default to maintain high database write performance - to optimize performance for frequent or large-scale queries on custom SIP headers, manually create a database index by first querying cdr_custom_headers to find dynamic_table and dynamic_column (e.g., header 'X-Custom-Header' stored in cdr_next_2, column custom_header_3), then execute CREATE INDEX idx_custom_header_3 ON cdr_next_2 (custom_header_3) - adding indexes increases database load during CDR insertion so only create indexes on frequently queried headers; use EXPLAIN to verify the database uses your index (type: ref is index lookup, type: ALL is full table scan); if using cdr_partition_by_hours or daily partitioning, index is automatically created on all partitions; sensor SSL settings (ssl_key, ssl_cert, ssl_ipport) can be configured via GUI wrench icon; sensor health monitoring via RRD charts (Settings > Sensors > chart icon) showing buffer usage and packet drops to diagnose sniffer overload vs network quality issues; sensor troubleshooting for non-deletable local sensors in server/probe deployments; server instance troubleshooting when replacing hardware (server/SBC) and reusing IP address - requires manually creating sensor entry in Settings > Sensors and configuring managerip/managerport in voipmonitor.conf on the new server instance; DISTRIBUTED ARCHITECTURE: Custom headers not visible in central GUI for specific sensor despite being configured - check sensor's server_destination, server_destination_port, and server_password in /etc/voipmonitor.conf; delete sensor entry from GUI Settings > Sensors and restart sniffer service to re-register; without correct server_destination configuration, sensor captures headers locally but does not transmit CDRs to central database; GUI and sensor upgrades behind proxy servers can be configured via Settings > System Configuration > Advanced > Http proxy (for upgrades) or via curlproxy in voipmonitor.conf for remote sensors; license notification emails can be disabled by removing the email address in Settings > License; license email supports multiple recipients by entering email addresses separated by a comma (e.g., user1@example.com,user2@example.com); troubleshooting CDR custom headers not being captured or showing truncated content - check snaplen parameter (increase to 3200 or higher for long SIP headers like STIR/SHAKEN P-Asserted-Identity with verstat parameters) and custom_headers_max_size parameter (increase from default 1024 if header content is truncated); CDR timezone configuration - use "Sensors Timezone" setting in Settings > System Configuration > National to fix CDR times displaying in UTC instead of local timezone; the regular "Timezone" setting is for GUI host (reports, alerts), not for CDR data; all sensors sending data to the same database should use the same timezone; sensor OS timezone can be overridden via timezone or utc options in voipmonitor.conf; INTERNATIONAL NUMBERS CONFIGURATION: For international numbers not displaying or being handled correctly (missing country codes, showing in local format when they should be international, numbers not being classified as international, international calls grouped incorrectly), configure the local number (country name) and international prefix settings in Settings > System Configuration > National; set Local number to your country name (e.g., Australia, United States, Czech Republic); set International prefix to the international dialing prefix for your country (e.g., 0011 for Australia, 011 for US/Canada, 00 for many European countries, 010 for Japan); example: Australia deployment should use Local number = Australia, International prefix = 0011; these settings ensure VoIPmonitor correctly normalizes and displays international numbers based on your local numbering plan. | ||
'''Keywords:''' GUI settings, sensors, disable sensor, stop sensor, capture rules SKIP, skip CDRs, stop data collection, duplicate records, sensor disabled GUI, CDR custom headers, header limitations, GeoIP, system configuration, timezone, national prefix, date format, intervals, email settings, license settings, license notification emails, overage notification, multiple recipients, comma-separated emails, LICENSE UPDATE, update license after payment, get/update license key button, Settings > License, license token, license key, retrieve license from portal, voipmonitor.org portal, Services > My services, copy license key, paste license key, multi-line license key, license not received after payment, license update automatically, manual license update, advanced settings, localization, custom URL, CSV export, ssl_key, ssl_cert, ssl_ipport, tls decryption, ssl configuration, pcap deduplication, packet count mismatch, missing packets in PCAP, RRD charts, sensor health monitoring, buffer usage, packet drops, sniffer overload, choppy audio, poor call quality, MOS score, sensor capacity limits, server instance troubleshooting, hardware replacement, SBC replacement, reusing IP address, managerip, managerport, server not appearing in GUI, CDR warning about unknown sensor, proxy, http proxy, proxy server, firewall, corporate proxy, GUI upgrade, sensor upgrade, curlproxy, proxy authentication, custom headers troubleshooting, snaplen, custom_headers_max_size, header capture issues, SIP packet capture, STIR, SHAKEN, P-Asserted-Identity, verstat, truncated headers, long SIP headers, CDR timezone, sensors timezone, UTC time display, BST time display, incorrect CDR times, iframe, embed, X-Frame-Options, clickjacking, GUI in iframe, iframe 301 redirect, ucloud, unite, subfolder, security headers, distributed architecture, custom headers not visible central GUI, sensor not sending CDRs to central database, server_destination, server_destination_port, server_password, delete sensor from GUI, re-register sensor, sensor configuration wrong, headers captured locally not in central GUI, CSRF, ENABLE_CSRF_CHECK, CSRF protection, cross-site request forgery, web security, XSS vulnerability mitigation, session security, security hardening, database index, index custom header, database performance, cdr_custom_headers table, dynamic_table, dynamic_column, CREATE INDEX, query optimization, custom header queries slow, EXPLAIN query, database indexes not indexed by default, partitioned tables index, full table scan, index lookup performance, international numbers, local number, international prefix, country code, international calls display, numbers not displaying correctly, Settings > System Configuration > National, normalize international numbers, Australia 0011, US Canada 011, Europe 00, Japan 010, international number configuration | '''Keywords:''' GUI settings, sensors, disable sensor, stop sensor, capture rules SKIP, skip CDRs, stop data collection, duplicate records, sensor disabled GUI, CDR custom headers, header limitations, select occurrence, first found value, last found value, custom header occurrence, header multiple occurrences, re-INVITE header capture, initial INVITE header, P-Asserted-Identity re-INVITE, capture first header only, ignore re-INVITE headers, custom header occurrence selection, GeoIP, system configuration, timezone, national prefix, date format, intervals, email settings, license settings, license notification emails, overage notification, multiple recipients, comma-separated emails, LICENSE UPDATE, update license after payment, get/update license key button, Settings > License, license token, license key, retrieve license from portal, voipmonitor.org portal, Services > My services, copy license key, paste license key, multi-line license key, license not received after payment, license update automatically, manual license update, advanced settings, localization, custom URL, CSV export, ssl_key, ssl_cert, ssl_ipport, tls decryption, ssl configuration, pcap deduplication, packet count mismatch, missing packets in PCAP, RRD charts, sensor health monitoring, buffer usage, packet drops, sniffer overload, choppy audio, poor call quality, MOS score, sensor capacity limits, server instance troubleshooting, hardware replacement, SBC replacement, reusing IP address, managerip, managerport, server not appearing in GUI, CDR warning about unknown sensor, proxy, http proxy, proxy server, firewall, corporate proxy, GUI upgrade, sensor upgrade, curlproxy, proxy authentication, custom headers troubleshooting, snaplen, custom_headers_max_size, header capture issues, SIP packet capture, STIR, SHAKEN, P-Asserted-Identity, verstat, truncated headers, long SIP headers, CDR timezone, sensors timezone, UTC time display, BST time display, incorrect CDR times, iframe, embed, X-Frame-Options, clickjacking, GUI in iframe, iframe 301 redirect, ucloud, unite, subfolder, security headers, distributed architecture, custom headers not visible central GUI, sensor not sending CDRs to central database, server_destination, server_destination_port, server_password, delete sensor from GUI, re-register sensor, sensor configuration wrong, headers captured locally not in central GUI, CSRF, ENABLE_CSRF_CHECK, CSRF protection, cross-site request forgery, web security, XSS vulnerability mitigation, session security, security hardening, database index, index custom header, database performance, cdr_custom_headers table, dynamic_table, dynamic_column, CREATE INDEX, query optimization, custom header queries slow, EXPLAIN query, database indexes not indexed by default, partitioned tables index, full table scan, index lookup performance, international numbers, local number, international prefix, country code, international calls display, numbers not displaying correctly, Settings > System Configuration > National, normalize international numbers, Australia 0011, US Canada 011, Europe 00, Japan 010, international number configuration | ||
'''Key Questions:''' | '''Key Questions:''' | ||
| Line 1,158: | Line 1,172: | ||
* How do I stop voipmonitor service on sensor machine? | * How do I stop voipmonitor service on sensor machine? | ||
* Can I use capture rules to selectively stop data from a sensor? | * Can I use capture rules to selectively stop data from a sensor? | ||
* How do I configure the "select occurrence" field in CDR custom headers? | |||
* What is the difference between "first found value" and "last found value" for custom SIP headers? | |||
* How do I capture only the initial INVITE header and ignore re-INVITEs? | |||
* Why are my custom SIP headers capturing multiple values from re-INVITEs? | |||
* How do I use "select occurrence first found value" to prevent P-Asserted-Identity from being captured from re-INVITEs? | |||
* How do I update my license after payment in VoIPmonitor GUI? | * How do I update my license after payment in VoIPmonitor GUI? | ||
* Where do I click to get/update license key after purchasing a license? | * Where do I click to get/update license key after purchasing a license? | ||
Revision as of 09:17, 6 January 2026
Category:GUI manual
This page documents the configuration options available in the VoIPmonitor web GUI under the Settings menu. These settings control how the GUI interacts with sensors, displays data, and manages user preferences.
Sensors
If id_sensor is set in /etc/voipmonitor.conf (default is blank), you must create sensor entries here to enable downloading files like PCAP, graphs, and WAV recordings from the GUI.
| Field | Description |
|---|---|
| Sensor ID | The numeric ID matching id_sensor = N in voipmonitor.conf
|
| Name | A descriptive name for the sensor |
| Manager IP | IP address of the sensor for fetching data (PCAP, graph, audio files) |
| Manager Port | TCP port for the manager API (default: 5029) |
| Remote database | Database connection parameters for "Legs by CID/header" lookups when sensors use different databases. Leave blank if all sensors share the same database. |
Configuring Sensors for Multi-Sensor Deployments
When multiple VoIPmonitor instances (sniffers) feed data to a single GUI, you must configure unique sensor IDs to identify which specific instance processed a given CDR.
Workflow:
- On each sniffer instance, edit
/etc/voipmonitor.confand set a uniqueid_sensorvalue (e.g., 1, 2, 3...):
# On Sensor A
id_sensor = 2
# On Sensor B
id_sensor = 3
- In the GUI, navigate to Settings > Sensors and add a sensor entry for each instance with the following fields:
- Sensor ID: The numeric ID matching
id_sensorin voipmonitor.conf - Name: A descriptive name for the sensor
- Manager IP: IP address of the sensor for fetching data (PCAP, graph, audio files)
- Manager Port: TCP port for the manager API (default: 5029)
- Sensor ID: The numeric ID matching
Restart the sniffer service on each instance to apply the changes:
# On each sensor machine
systemctl restart voipmonitor
Newly captured CDRs will now display the source sensor ID in the GUI. The id_sensor is stored in the cdr.id_sensor database column, allowing you to filter and identify which sniffer processed each call.
SSL/TLS Configuration
Sensors can be configured to decrypt TLS-encrypted SIP traffic directly through the GUI. This is particularly useful when VoIPmonitor is not capturing all SIP traffic from specific TLS trunks (e.g., seeing only OPTIONS and 403 responses while INVITEs are missing).
To configure SSL/TLS settings for a sensor:
- Navigate to Settings > Sensors
- Click the wrench icon next to the affected sensor
- In the search field at the top right of the sensor settings dialog, enter ssl_
- Configure the required SSL/TLS parameters:
| Parameter | Description | Example Value |
|---|---|---|
| ssl_key | Path to the private key file (PEM format) for decrypting TLS traffic | /etc/pki/tls/private/server.key
|
| ssl_cert | Path to the SSL certificate file (PEM format) matching the private key | /etc/pki/tls/certs/server.crt
|
| ssl_ipport | IP address and TLS port of the SIP endpoint to decrypt (without key file path for SSL Key Logger mode, or IP:port /path/to/key for Private Key mode) |
192.168.1.10:5061
|
| ssl | Enable SSL/TLS decryption module on the sensor | yes
|
Important Notes:
- The sensor SSL settings correspond to the configuration parameters in /etc/voipmonitor.conf but are managed through the GUI interface
- This is an alternative to editing
voipmonitor.confdirectly - the GUI applies these settings to the sensor - After changing SSL settings, you may need to restart the sniffer service or use the "reload sniffer" button in the GUI control panel
- Important Warning for Sensor Configuration Changes: When modifying sensor-level settings (especially parameters loaded via
mysqlloadconfigsuch asdtmf2db,dtmf2pcap, or other sensor options), perform a manual restart instead of using reload. A reload may leave the sniffer in an inconsistent state with some processes holding old configuration values. To safely apply sensor configuration changes:
# Stop the sensor service
systemctl stop voipmonitor
# Check for remaining processes (kill if any)
ps ax | grep voipmonitor
# Start the sensor service
systemctl start voipmonitor
- For decryption of traffic using Perfect Forward Secrecy (PFS) ciphers like Diffie-Hellman (DHE/ECDHE), see the TLS decryption guide for the SSL Key Logger method
When to use GUI SSL configuration:
- You prefer managing TLS/SSL settings through the web interface instead of editing config files
- You have multiple sensors and want to manage SSL keys centrally
- You need to quickly enable/disable TLS decryption without editing
voipmonitor.conf
For detailed information on TLS decryption methods and limitations (including PFS ciphers), see Tls.
SIP Port Configuration
The sipport parameter controls which SIP signaling ports the sensor listens to. This is critical when you need to capture traffic from devices using non-standard SIP ports (not port 5060).
To configure SIP ports via GUI:
- Navigate to Settings > Sensors
- Click the wrench icon next to the affected sensor
- In the sensor settings dialog search field, enter sipport
- Configure the required value:
| Parameter | Description | Example Value |
|---|---|---|
| sipport | SIP ports to listen on (comma-separated or ranges) | 5060,5080 or 5060,5070-5080
|
- Default: Port 5060 only
- Multiple ports:** Use commas (e.g.,
5060,5061,5080) - Port ranges:** Use hyphens (e.g.,
5060,5070-5080)
When to change sipport:
- Certain carriers or devices use non-standard SIP ports (e.g., 5080, 6060)
- You see missing CDRs for calls from specific IP addresses
- Packet captures show SIP traffic on ports other than 5060
After changing sipport:
- Manual config file changes:
systemctl restart voipmonitor - GUI changes (via reload sniffer button): Settings are applied automatically by the sensor
Important for Client/Server deployments:
If using packetbuffer_sender = yes (packet mirroring mode), you must configure matching sipport settings on BOTH the remote probe and the central server. Different port lists will cause the central server to ignore forwarded packets on ports it does not recognize.
See Sniffer_distributed_architecture#Critical:_sipport_Must_Match_in_Distributed_Deployments for details.
=== Configuring RTP Storage Limits via GUI
The sensor wrench icon interface allows you to configure disk space limits specifically for RTP (audio) PCAP files. This helps manage disk usage by limiting RTP storage while preserving SIP signaling and chart data, which consume significantly less space.
To configure RTP retention limits for a specific sensor:
- Navigate to Settings > Sensors
- Click the wrench icon next to the problematic sensor
- In the search field at the top right, enter maxpoolrtp
- Configure the required RTP storage parameters:
| Parameter | Description | Example Value |
|---|---|---|
| maxpoolrtpsize | Maximum disk space in MB for RTP PCAP files. When this limit is reached, oldest RTP files are deleted. | 51200 (50 GB)
|
| maxpoolrtpdays | Maximum age in days for RTP PCAP files. Files older than this are deleted. Use either size or time limit (whichever is reached first triggers cleanup). | 30 (30 days)
|
When to use RTP limits:
- A specific sensor has limited disk space compared to others
- You want to preserve SIP signaling and chart data longer than audio
- Audio files are being deleted prematurely due to overall storage limits
- You need to balance storage allocation between RTP, SIP, and chart data
Important Notes:
- The first limit that is reached (size or days) triggers cleanup. You can use both parameters for flexible control.
- RTP files typically consume 5-10x more disk space than SIP files. Limiting RTP helps preserve smaller, more valuable data types.
- GUI settings configured here take priority over settings in
/etc/voipmonitor.confwhenmysqlloadconfigis enabled (default). - Settings are applied to the specific sensor. Configure RTP limits individually for sensors with different storage constraints.
For more information on data retention strategies, including size-based vs time-based retention, see Data_Cleaning.
Sensor Health Monitoring with RRD Charts
If you experience poor call quality (low MOS scores, choppy playback) and need to determine whether the issue is network-related or caused by the sniffer host being overloaded, use the RRD (Round Robin Database) charts available in the GUI.
- Accessing Sensor RRD Charts:**
- Navigate to Settings > Sensors
- Locate the sensor you want to monitor
- Click the chart icon next to the sensor entry
- This opens the RRD performance graphs for that sensor
- Key Metrics to Check:**
| Metric | Description | What It Indicates |
|---|---|---|
| Buffer usage | Shows the percentage of available packet buffer being used | Sensor is approaching capacity limits if consistently high |
| Packet drops | Counts of packets the sensor could not process | Sensor is overloaded and dropping packets due to high traffic load |
- Interpreting the Charts:**
If you observe:
- Buffer usage growing to 100% and remaining at maximum capacity
- Packet drops being recorded (non-zero values on the packet drops graph)
This indicates the sniffer host is overloaded and is the source of audio quality issues. The sensor cannot keep up with incoming packet rate, causing packets to be dropped before they can be processed and stored. This results in:
- Low MOS scores
- Choppy audio playback in the GUI
- Missing call data
- Solutions for Sensor Overload:**
- Increase the kernel packet ring buffer size in
voipmonitor.conf:ringbuffer = 200(default: 50, recommended: >= 500 for >100 Mbit traffic). This allows the operating system to buffer more packets before they are passed to VoIPmonitor, reducing kernel-level packet drops. - Add more sensors to distribute the load (Distributed Architecture)
- Use specialized capture hardware (DPDK, Native Napatech cards, PF_RING)
- Reduce capture scope (more restrictive capture rules)
- Upgrade sensor hardware (faster CPU, more RAM)
- Reduce PCAP file storage or enable compression
- When to Check RRD Charts:**
Use RRD charts to diagnose sensor overload when:
- Other platforms show clear audio but VoIPmonitor shows poor quality
- Only the sniffer host is affected, not the actual VoIP network
- Performance log shows high packet drops or buffer saturation
This diagnostic step helps distinguish between network quality issues (jitter, loss in the actual VoIP path) vs. sniffer capacity issues (capturing host overload).
Disabling a Sensor
If you need to temporarily or permanently stop a sensor from collecting data and writing CDRs to the database, you have two options depending on your requirements.
⚠️ Warning: Important: GUI actions do not stop data collection
Toggling "Disabled" or clicking "Delete" for a sensor in the Settings > Sensors interface does NOT stop the underlying VoIPmonitor service. The sensor process continues to capture packets and write to the database regardless of its GUI status. You must use one of the methods below to halt actual data collection.
Option 1: Stop the Service on the Sensor Machine (Complete Shutdown)
To completely stop a sensor from collecting data, you must stop the VoIPmonitor service on the sensor's host machine:
- Log into the sensor machine via SSH
- Stop the service:
systemctl stop voipmonitor
- Verify the sensor appears offline in the GUI
This method:
- Completely halts packet capture and database writes
- Works for decommissioning sensors permanently
- Requires command line access to the sensor host
Option 2: Use Capture Rules with SKIP=ON (Selective Blocking)
To prevent a specific sensor from sending CDRs to the database while keeping the service running, use capture rules:
- Navigate to GUI > Capture rules
- Create a new rule for the sensor's IP address or phone numbers
- Set the Skip option to ON
- Configure any additional filters as needed
- Save and apply the rule
With SKIP=ON:
- The sensor continues to capture packets from the network
- No CDRs are generated for matching traffic
- No files are created (PCAP, audio, graphs)
- RTP analysis is suppressed for matched calls
- Useful for selective blocking without stopping the entire service
Important notes on SKIP:
- The Skip option only works if the IP address or phone number appears in SIP signaling
- It does not work for IPs that are only used in RTP packets (media stream)
- For excluding RTP-only traffic, use the
filterdirective invoipmonitor.conf
For more information on capture rules, see Capture_rules.
Troubleshooting: Non-deletable Local Sensor
In server/probe deployments where the GUI server is not sniffing traffic itself, a "local sensor" may be automatically created in the sensor list. This sensor cannot be deleted through the normal GUI interface.
Workaround:
- In Settings > Sensors, add a new sensor with the same Sensor ID, name, and settings as the non-deletable local sensor
- After saving, the original automatically created sensor should either disappear or become deletable
- You can then remove the duplicate entry if both sensors appear
This occurs because the GUI automatically creates a sensor entry when it detects that id_sensor is set in the configuration but no active capture is configured on the GUI host.
Removing and Reconnecting Sensors
When decommissioning or replacing a sensor, or when you need to refresh the sensor configuration after an upgrade, use the following standard workflow.
Standard Decommissioning Workflow:
- Navigate to Settings > Sensors in the GUI
- Click the sensor entry you want to remove
- Click Delete or Remove to delete the sensor probe entry
- Log into the command line of the sensor machine (SSH)
- Restart the voipmonitor service on the sensor:
systemctl stop voipmonitor
systemctl start voipmonitor
- Return to Settings > Sensors in the GUI
- The sensor will automatically reappear in the list after the service restart
- Rename the sensor entry as needed if the IP or configuration has changed
How It Works:
When you restart the voipmonitor service on the sensor machine, it automatically re-registers with the GUI if id_sensor is configured in /etc/voipmonitor.conf. The GUI creates a new sensor entry with the current configuration. This workflow ensures that:
- The sensor configuration is refreshed with the latest sensor settings
- Old IP addresses or obsolete sensor entries are cleaned up
- The system automatically discovers the sensor again after restart
When to Use This Workflow:
- After an upgrade that caused errors referencing old/decommissioned sensor IP addresses
- When replacing hardware and reusing a new IP address
- When you need to refresh sensor configuration settings
- When CDRs show warnings about unknown sensors
Note: This standard workflow is different from the emergency cleanup procedure described below, which is used only when the GUI crashes due to thousands of obsolete records.
Troubleshooting: GUI Crashes When Accessing Settings > Sensors
If the web GUI becomes unresponsive or crashes when accessing Settings > Sensors, this is typically caused by a large number of obsolete sensor records in the sensors database table. The GUI processes all sensor entries from this table to render the page, and if there are thousands of stale records (from old sensors, decommissioned hardware, or duplicate IDs), the PHP process may run out of memory or exceed execution time limits.
Symptoms:
- Settings > Sensors page does not load or times out
- GUI becomes unresponsive when navigating to sensor configuration
- PHP error logs show memory exhaustion or timeout errors
Solution: Manually Delete Obsolete Records from Database
Use the MySQL command line to remove obsolete sensor records directly from the database. The standard GUI interface cannot handle the cleanup if the records are already causing the page to crash.
- Access the database:
mysql -u voipmonitor -p voipmonitor
- Identify obsolete records:
Inspect the
sensorstable to find entries that correspond to obsolete sensors. Look for rows with old interface names, missing sensor IDs, or duplicates.-- Example: Find entries referencing old or duplicate IDs SELECT * FROM sensors WHERE id_sensor IN (1,2,3); -- -- Check total count of sensors SELECT COUNT(*) FROM sensors;
- Delete obsolete records:
Execute
DELETEstatements for the identified obsolete rows. Be careful with theWHEREclause to ensure you only delete obsolete data.-- Delete records by id_sensor (replace with actual values after inspection) DELETE FROM sensors WHERE id_sensor IN (<id1>, <id2>, <id3>); -- Delete by specific criteria DELETE FROM sensors WHERE host LIKE '%old-sensor-name%';
- Verify cleanup:
-- Check remaining sensor count SELECT COUNT(*) FROM sensors;
Exit the database:
EXIT;
- Critical: Users must log out and log back in All users currently logged into the GUI must log out and then log back in for the sensor list to be refreshed. Simply reloading the page is not sufficient.
Note: The sensors table contains GUI sensor configuration entries, distinct from the sensor_config table which is used for sensor-level parameter overrides when the mysqlloadconfig feature is enabled.
Troubleshooting: Server Instance Not Appearing in GUI
After replacing a server/SBC and reusing its IP address, the server instance may disappear from the GUI sensor list, even though it is sending data and appears in CDRs with a warning.
Problem: Sensor Appears in CDRs With Warning But Not in GUI List
When you replace hardware (server, SBC, sensor host) but reuse the same IP address, the GUI may not automatically rediscover the server instance. CDRs from the new device appear in the database, but:
- The server instance is not visible in Settings > Sensors
- CDR records contain a warning about unknown sensor or manager connection
- The new server is working but not properly registered with the GUI
Solution: Manually Create Server Instance Entry
If your deployment uses server instances that connect directly to the MySQL database, follow these steps:
Step 1: Create the server instance entry in the GUI
- Navigate to Settings > Sensors
- Click Add new sensor or New sensor
- Configure the following fields:
- Sensor ID: Enter a unique identifier (e.g.,
2) - Name: Descriptive name for the server instance (e.g.,
SBC-Production) - Manager IP: IP address of the server instance (the new hardware's IP)
- Manager Port: TCP port for the manager connection (default:
5029)
- Sensor ID: Enter a unique identifier (e.g.,
Step 2: Configure managerip and managerport on the server instance
Edit the voipmonitor.conf file on the new server instance to point to the GUI:
# On the new server instance (/etc/voipmonitor.conf)
managerip = gui.server.ip # GUI server IP address
managerport = 5029 # Manager API port (matches GUI Manager Port)
Restart the voipmonitor service after making changes:
systemctl restart voipmonitor
Step 3: Verify network connectivity
Ensure bidirectional network connectivity:
- GUI host → Server instance: GUI must be able to reach the server instance on the configured Manager IP/Port (for data retrieval and control)
- Server instance → MySQL database: Server instance must be able to write CDRs to the MySQL database
Test connectivity from both directions:
# From GUI host to server instance (verify Manager IP/Port)
nc -zv server.instance.ip 5029
# From server instance to MySQL database
mysql -h mysql.server.ip -u voipmonitor -p voipmonitor -e "SELECT 1"
Check firewall rules on both systems to ensure:
- TCP/5029 (Manager port) is allowed from GUI to server instance
- MySQL port (usually 3306) is allowed from server instance to database
Step 4: Verify server instance status
After configuration, the server instance should appear in Settings > Sensors with a green status indicating it is connected. Any probes or sniffing interfaces connected to that server instance will be automatically discovered and listed under the server instance in the sensor tree.
Alternative: Using Modern Client-Server Mode
If you are planning a new deployment or can reconfigure your architecture, consider using the modern Client-Server mode which provides:
- Encrypted TCP connections between sensors and central server
- Automatic sensor registration (no manual GUI entry required)
- Simplified firewall configuration (single port: 60024 by default)
In Client-Server mode, sensors connect to a central server using server_destination and server_destination_port, and the central server handles SQL database writes. Sensors do not need direct MySQL database access.
CDR Charts
This section allows you to define predefined charts that appear in the CDR detail view's Charts tab. These charts provide quick visual analysis for specific call records based on caller/called information.
CDR Custom Headers
Since sniffer version 7.0RC7, VoIPmonitor can store custom SIP headers in the database for viewing and searching in the GUI. For the sniffer configuration, see Sniffer_configuration#custom_headers.
How to Add a New Custom SIP Header
To capture and display a custom SIP header (e.g., X-Cisco-Org-ID) in the CDR view, follow this workflow:
- 1. Configure the sniffer to capture the header
- Edit
/etc/voipmonitor.confand add the header name to thecustom_headersparameter: custom_headers = X-Cisco-Org-ID
- For multiple headers, separate with commas:
custom_headers = X-Cisco-Org-ID, X-Other-Header
- 2. Restart the sensor service
- Restart the sniffer service for the configuration to take effect and for the database columns to be created:
systemctl restart voipmonitor
- Important: Custom header data will only be captured for calls made AFTER the restart. Existing CDRs will not have this data.
- 3. Generate a test call
- Place a test call to verify that the header is being captured and stored in the database.
- 4. Configure GUI display settings
- Once the header appears in the database, configure the GUI:
- Navigate to Settings > CDR Custom Headers
- Select the header from the "Header Field" combo box (it will appear after restart)
- Set the display name in the "Name" field (e.g., "Cisco Org ID")
- Enable "Show as Column" to display it in the CDR list
- Click Save
Configuration Fields
- Header Field
- Combo box listing available headers from the
cdr_next.custom_header*database columns. These are automatically created when you add headers tocustom_headersinvoipmonitor.confand restart the sniffer.
- Name
- The display name for this header in the CDR view header panel.
- Match in SIP by Header
- When enabled, this header is used for matching CDRs in the Legs by header tab. This is useful when you have a unique correlation identifier that links multiple call legs (e.g., from phone to SBC, and from SBC to provider). Alternative method: matchheader in voipmonitor.conf.
- Show as Column
- When enabled, displays this header as a column in the CDR list view.
- Restrict to Regex pattern
- Optional regular expression pattern to filter which header values are stored in the database. Only headers matching this regex pattern will be captured. For example:
^[0-9]+$to capture only numeric values.
- Select occurrence
- Controls which occurrence of a SIP header is stored when the same header appears multiple times in a call (common for headers like
P-Asserted-Identitythat appear in both the initial INVITE and subsequent re-INVITEs).- First found value: Captures the header value from the first occurrence (typically the initial INVITE). This is recommended when you only want the original value from call setup and want to ignore changes during the call (e.g., re-INVITEs during hold, transfers, or session modifications).
- Last found value: Captures the header value from the last occurrence found. Use this when you need the most recent value if the header changes during the call.
Example: P-Asserted-Identity in Re-INVITEs
If calls include P-Asserted-Identity in both the initial INVITE and subsequent re-INVITEs (e.g., during hold operations), the system will capture the header for each occurrence. To capture only the initial INVITE value and ignore re-INVITEs:
- In Settings > CDR Custom Headers, set Select occurrence to First found value
- This stores only the header value from the initial INVITE, ignoring values from subsequent SIP requests
This is particularly useful for ensuring consistent Caller ID information based on the original call setup rather than later modifications during the call session.
When is a Restart Required?
Restarting the sensor service is only required in the following scenarios:
- After adding NEW headers to voipmonitor.conf: When you add new header names to the
custom_headersparameter in/etc/voipmonitor.conf, a restart is required to create the database columns and begin capturing data. - After changing sniffer capture parameters: If you modify
snaplen,custom_headers_max_size, or other capture-related parameters invoipmonitor.conf, restart to apply the changes.
Restart is NOT required for GUI-only changes such as:
- Modifying the display name ("Name" field)
- Toggling "Show as Column" or "Match in SIP by Header"
- Adding or changing regex patterns in "Restrict to Regex pattern"
To restart the sensor:
# Using systemd
systemctl restart voipmonitor
# Using init scripts
/etc/init.d/voipmonitor restart
Filtering Custom Headers
After configuring custom headers in the GUI, they appear in the CDR filter form where you can search for them using special values:
- Find all CDRs with this header present: Use the
%wildcard as the filter value. This matches any non-empty value. - Find all CDRs without this header: Type
NULL(or leave empty) as the filter value to find calls where this header was not present. - Specific value search: Enter the exact header value (or use
%as a wildcard for partial matches, e.g.,sip:%to find SIP URIs).
These filters appear in the CDR filter form after you have processed at least one call containing the custom header.
Troubleshooting: Header Capture Issues
If custom SIP headers are not being captured at all or are showing truncated content in the database, check the sniffer configuration parameters in voipmonitor.conf:
| Problem | Cause | Solution |
|---|---|---|
| Complete header not captured | In voipmonitor.conf, increase the snaplen parameter to capture larger packets: snaplen = 3200 (or higher for long headers). The default may be too low for extended SIP headers used in STIR/SHAKEN (e.g., P-Asserted-Identity with verstat parameters).
| |
| Header content truncated | In voipmonitor.conf, increase the custom_headers_max_size parameter (default: 1024 bytes): custom_headers_max_size = 2048. Headers longer than this value will be truncated during capture.
|
Performance Optimization: Database Index for Custom Headers
Custom header columns in cdr_next_X tables are not indexed by default to maintain high database write performance. If you plan to perform frequent or large-scale queries on a specific custom header, you should manually create a database index on that column to prevent full table scans.
Step 1: Find the table and column for your custom header
First, query the cdr_custom_headers lookup table to identify where your header is stored:
-- Find the dynamic table and column for your custom header
SELECT dynamic_table, dynamic_column
FROM cdr_custom_headers
WHERE header_field = 'X-Custom-Header';
Example Result:
| dynamic_table | dynamic_column |
|---|---|
| 2 | 3 |
This means your header is stored in cdr_next_2 table, column custom_header_3.
Step 2: Create the index manually
Execute the CREATE INDEX command using the table and column values found above:
-- Syntax: CREATE INDEX <index_name> ON <table_name> (<column_name>);
CREATE INDEX idx_custom_header_3 ON cdr_next_2 (custom_header_3);
Choose a descriptive index name following your naming convention (e.g., idx_header_X_Custom_Header).
Important Considerations:
⚠️ Warning: Performance Impact: Adding indexes increases database load during CDR insertion (write speed). Only create indexes on headers that are actively and frequently queried. Each additional index consumes disk space and slows down INSERT operations.
- Partitioned Tables: If you use
cdr_partition_by_hoursor daily partitioning, the index is created on all partitions automatically. This benefits query performance on recent data. - Query Validation: Use
EXPLAINto verify the database uses your new index:
EXPLAIN SELECT cdr_ID FROM cdr_next_2 WHERE custom_header_3 = 'test_value';
- **Good Result:**
type: ref(Index lookup is used) - **Bad Result:**
type: ALL(Full table scan - index is not being used)
Limitations
The GUI custom header feature has the following limitations:
| Limitation | Description |
|---|---|
| No Regexp extraction | Custom headers store the complete raw header value. While you can use the "Restrict to Regex pattern" field to filter which headers to capture, you cannot extract partial values such as just an IP address from a SIP URI (e.g., extracting 192.168.1.1 from sip:192.168.1.1).
|
| No Delimiter aggregation | If a SIP header appears multiple times in a message (e.g., multiple Contact headers in a SIP 300 response), only one value is stored. Controlled by custom_headers_last_value in voipmonitor.conf (first or last occurrence).
|
| No per-method filtering | Custom headers are captured from all SIP messages. There is no option to capture only from specific SIP methods (INVITE, BYE, etc.) or response codes (200, 300, etc.). |
For advanced header extraction needs, contact VoIPmonitor support to discuss custom development or alternative approaches such as external PCAP processing.
Distributed Architecture: Headers Not Visible in Central GUI
If your deployment uses multiple sensors connected to a central GUI, and custom SIP headers are not appearing for calls from a specific sensor despite being configured and present in the traffic, the issue is typically that the sensor is not sending CDRs to the central database.
Core Issue: Sensor Not Connected to Central Server
The sensor may be capturing custom headers locally but not transmitting them to the central GUI database because:
- The
server_destinationconfiguration is incorrect or missing on the sensor - The
server_destination_portdoes not match the central server'sserver_bind_port - The
server_passwordis incorrect - The sensor entry in the GUI has conflicting configuration
Solution Workflow:
- 1. Verify sensor configuration
On the affected sensor, check /etc/voipmonitor.conf:
# /etc/voipmonitor.conf on the SENSOR
id_sensor = 2
server_destination = central.server.ip
server_destination_port = 60024 # Must match server_bind_port on central server
server_password = your_strong_password
# For Local Processing mode (recommended)
packetbuffer_sender = no
Use a working sensor's configuration as a reference if available.
- 2. Delete and re-register the sensor in GUI
Sometimes stale sensor entries in the GUI database can cause connection issues.
- Navigate to Settings > Sensors
- Click the entry for the problematic sensor
- Click Delete to remove it
- Restart the sensor service:
systemctl restart voipmonitor
- The sensor will automatically re-register with the GUI
- 3. Verify connection
After restarting, check that the sensor appears in Settings > Sensors with a connected status. Generate a test call and verify the custom headers appear in the CDR list.
Key Point: The server_destination, server_destination_port, and server_password settings control the encrypted TCP connection from the sensor to the central server. Without this connection, CDRs (including custom headers) cannot be transmitted to the central database.
For complete distributed architecture documentation, see Distributed Architecture: Client-Server Mode.
Troubleshooting
If custom SIP header data is correctly stored in the database and available for filtering but not displayed in the CDR list, follow these diagnostic steps:
Verify the sniffer has loaded the custom header configuration:
Use the manager API to confirm that the custom headers are loaded into the sniffer's memory:
# Create a temporary path for the manager socket
echo 'manager_file start /tmp/vmsck' | nc <manager_ip> <manager_port>
# Check loaded CDR custom headers
echo 'custom_headers_dump cdr' | nc -U /tmp/vmsck
# Cleanup
rm -f /tmp/vmsck
Replace <manager_ip> and <manager_port> with your sensor's manager connection settings (configured in Settings > Sensors or in voipmonitor.conf with managerip and managerport). The default manager port is 5029.
If no headers are listed, verify that:
- You have added the header names to the
custom_headersdirective invoipmonitor.conf - You have restarted the voipmonitor service after adding headers
- The
cdr_custom_headerstable contains the expected entries
Verify the data is present in the database:
Check that the custom header data is actually being captured and stored:
-- Step 1: Find the dynamic table and column for your custom header
SELECT dynamic_table, dynamic_column
FROM cdr_custom_headers
WHERE header_field = '<your_header_name>'\G
-- Step 2: Query the actual CDR data to confirm values are stored
SELECT cdr_ID, calldate, custom_header_<column_number>
FROM cdr_next_<table_number>
WHERE custom_header_<column_number> IS NOT NULL
ORDER BY cdr_ID DESC
LIMIT 1\G
Replace <your_header_name>, <table_number>, and <column_number> with the values returned by the first query.
Check for manual changes to the database:
⚠️ Warning:
Do NOT manually modify the cdr_custom_headers table outside of the GUI. Manual changes (inserting, updating, or deleting records directly in the database) can cause synchronization issues between the GUI, the sniffer, and the actual data storage. Always use the GUI Settings > CDR Custom Headers interface to manage custom header definitions.
If you suspect manual changes were made, compare the entries in cdr_custom_headers with the headers listed in the manager API output and the columns present in the cdr_next_* tables.
Check for GUI rendering issues:
If the header data exists in the database but does not display in the CDR list, enable GUI debug mode to check for JavaScript errors:
Append ?debug=31415 to any GUI URL (e.g., https://your-gui.com/cdr/?debug=31415)
Then open your browser's Developer Console (F12) and look for JavaScript errors that might indicate a rendering problem. Common issues include:
- Browser cache issues (try clearing cache or using incognito mode)
- JavaScript conflicts from browser extensions
- GUI service not restarted after configuration changes
Summary: Troubleshooting Checklist
- [ ] Header appears in
custom_headers_dump cdrmanager API output - [ ]
cdr_custom_headerstable has correct mapping - [ ] Data exists in the appropriate
cdr_next_*table - [ ] No manual modifications to
cdr_custom_headerswere made - [ ] "Show as Column" checkbox is enabled in Settings > CDR Custom Headers
- [ ] Voipmonitor service has been restarted after configuration changes
- [ ] No JavaScript errors in browser console (enable debug mode with
?debug=31415)
Load GeoIP Data
Loads GeoIP data into the internal database for the CDR detail Map tab, which displays geographic locations of call participants.
System Configuration
The System Configuration section contains core settings that affect the overall behavior of the GUI.
Basic
| Setting | Description |
|---|---|
| WEB URL | Base URL for the GUI, used in hypertext links (e.g., in email alerts) |
| Sniffer data path | Directory where sniffer stores data (default: /var/spool/voipmonitor)
|
| Default sensor hostname | Default hostname for connecting to the sniffer (default: localhost). For multiple sensors, configure them in Settings > Sensors |
| Default sensor TCP port | Default TCP port for the manager API (default: 5029) |
Database
Configuration for the MySQL/MariaDB database connection used by the GUI.
National
Settings for localizing call classification and date/time display formats.
| Setting | Description |
|---|---|
| Timezone | Server timezone for the GUI host (format: Country/City, e.g., Europe/Prague). This setting is used for scheduling reports and alerts generated by the GUI. It does NOT affect CDR data timestamps. |
| Sensors Timezone | Timezone for sensors sending CDR data to this database (format: Country/City, e.g., Europe/London). This setting controls how CDR timestamps are displayed in the GUI. Set this to match the timezone where your sensors are operating. All sensors sending data to this database should use the same timezone. This is the primary setting for correcting CDR timezone display issues. |
| National prefix, 2, 3 | Prefixes used to classify calls as national vs. international (used in Active calls view) |
| Max national number length | Numbers longer than this are classified as international regardless of prefix |
| International prefix | Prefix used for international calls from your country (e.g., 0011 for Australia, 00 for many countries, 011 for US/Canada)
|
| Local number | Your country name or local region for number normalization (e.g., Australia, United States, Czech Republic)
|
| Date format | PHP date format string (default: Y-m-d). See PHP DateTime format
|
| Time format | PHP time format string (default: G:i:s). See PHP DateTime format
|
| Week start | First day of the week for calendar displays |
Troubleshooting: International Numbers Not Displaying Correctly
If international numbers are not displaying or being handled correctly (e.g., missing country codes, showing in local format when they should be international), the local number and international prefix settings in the GUI may need to be configured.
Common Symptoms:
- International numbers appear in local format only
- Country codes are missing from displayed numbers
- Numbers are not being classified as international
- International calls are grouped incorrectly
Solution: Configure Local Number and International Prefix Settings
- Navigate to Settings > System Configuration > National
- Set the Local number field to your country name (e.g.,
Australia,United States,Czech Republic) - Set the International prefix field to the international dialing prefix for your country:
- Australia:
0011 - United States/Canada:
011 - Many European countries:
00 - Japan:
010
- Australia:
- Save the settings
Example: Australia For an Australian deployment:
- Local number:
Australia - International prefix:
0011
These settings ensure that VoIPmonitor correctly normalizes and displays international numbers based on your local numbering plan.
Intervals
Default time intervals for various GUI views and filters.
| Setting | Description |
|---|---|
| Default CDR interval | Default time filter when entering the CDR section. If set to "specified number of days", configure in the next option |
| Default CDR interval in days | Number of days for the CDR filter (only editable if above is set to "specified number of days") |
| Default dashboard interval | Default time filter when entering the dashboard |
| Default Legs by CID interval | Time window (+/-) for finding related calls in the Legs by CID tab (default: 5 seconds) |
| Default Legs by header interval | Time window (+/-) for finding related calls in the Legs by header tab (default: 5 seconds) |
Email / HTTP Referer
Email configuration settings.
| Setting | Description |
|---|---|
| DEFAULT_EMAIL_FROM | Default "From" address for outgoing emails |
| Disable email plain text | Enable to force HTML-only emails. Useful for mail clients that display only plain text incorrectly (e.g., older Outlook versions) |
License
License and notification email configuration.
| Setting | Description |
|---|---|
| License token | Short text token for retrieving license key from VoIPmonitor portal |
| License key | Full license key content (multi-line text) |
| get/update license key | Button to fetch or update the license from the VoIPmonitor portal |
| License email | Email address for receiving license issue and overage notification emails |
Updating License After Payment:
After purchasing or renewing a license through the voipmonitor.org portal, update your GUI license as follows:
- Navigate to Settings > License
- Click the get/update license key button
The GUI will automatically fetch your updated license from the portal if the payment has been processed. You do not need to manually enter a license key or token unless automatic retrieval fails.
Manually Retrieving License from Portal:
If the automatic update does not work, retrieve your license directly from the portal:
- Log in to https://www.voipmonitor.org
- Navigate to Services > My services
- Locate your VoIPmonitor license
- Click to view the license details
- Copy the full license key content
- Paste it into the License key field in Settings > License
Note: The license key is displayed as multi-line text. Ensure you copy the entire content when pasting.
To configure the license expiry notification for multiple recipients, enter all email addresses separated by a comma (e.g., user1@example.com,user2@example.com).
Disabling License Notification Emails:
To stop receiving license issue and overage notification emails:
- Navigate to Settings > License
- Remove the email address from the "License email" field
- Save the changes
Note: This only disables license-related notification emails. Other automated emails (QoS alerts, daily reports, sensor health alerts) will continue to function.
GeoIP
Configuration for GeoIP services used in the CDR Map view.
| Setting | Description |
|---|---|
| Use GeoIP local database | Enable/disable the internal GeoIP database (if loaded via Load GeoIP Data) |
| GeoIP maxmind.com KEY | API key for MaxMind GeoIP service |
| GeoIP ipinfodb.com KEY | API key for IPInfoDB service |
Advanced
Advanced configuration options for power users and specific use cases.
| Setting | Description |
|---|---|
| Enable CDR group panel | Show/hide the group panel at the bottom of the CDR view |
| ENABLE_CDR_FORCE_INDEX_CALLDATE | Force use of the calldate index on CDR queries. Enable only for unoptimized MySQL installations experiencing slow queries |
| ENABLE_CSRF_CHECK | Enable CSRF (Cross-Site Request Forgery) protection in the GUI. When enabled, the GUI validates CSRF tokens for state-changing operations, increasing session security and mitigating certain types of web attacks. Set to TRUE to enable. Recommended for production environments
|
| Enable database IP reverse lookup | Resolve IP addresses to names using the internal IP lookup table |
| Enable DNS reverse lookup | Resolve IP addresses to names using DNS |
| Enable database number lookup | Resolve phone numbers to names using the internal prefix lookup table |
| Disable rtpfirstleg param | Disable the --rtp-firstleg parameter for PCAP audio decoding. Enable only if experiencing audio issues
|
| Disable URL wav protection | Skip session authentication for WAV file downloads. Use with WAV download key for secure external access |
| WAV download key | Secret key required for WAV downloads when URL protection is disabled |
| Hide SIP domain in CDR | Hide SIP domains in the CDR display |
| Hide live play | Hide live playback buttons in Active calls |
| Hide WAV play | Hide WAV playback buttons in CDR view |
| Upload sniffer conf path | Path to voipmonitor.conf for PCAP upload functionality |
| CDR share key | Secret string used to generate unique hashes for CDR share URLs |
| Folder for export CSV | Directory where CSV files from crontab scheduler tasks are saved |
| CSV name prefix | Optional prefix for CSV filenames generated by crontab tasks |
| Delete CSV after X days | Auto-delete CSV files older than specified days |
| Pcap deduplication before download | Enable to remove duplicate and retransmitted SIP/RTP packets when downloading PCAP files from the GUI. This may cause a mismatch between the packet count shown in the GUI SIP History and the packet count in the downloaded PCAP file. Disable to ensure the downloaded PCAP contains all captured packets including duplicates |
| Http proxy (for upgrades) | Proxy server address and port for automatic GUI and sniffer upgrades via the web interface. Required when the VoIPmonitor server is behind a corporate firewall or proxy and cannot connect directly to download.voipmonitor.org or github.com. Format: http://proxy-server-ip:port or http://username:password@proxy-server-ip:port for authenticated proxies
|
| Enable GUI to run in iframe | Allow the GUI to be loaded in an iframe (embed the VoIPmonitor interface in other web applications). Set to true to enable. This is required when hosting the GUI in subfolders (e.g., /ucloud, /unite) within an iframe. By default, the GUI sends security headers that prevent iframe embedding for clickjacking protection
|
Troubleshooting: GUI Upgrades Behind Proxy Servers
If the GUI or sensor upgrade process fails due to network restrictions or firewall blocking direct internet access:
Solution 1: Configure HTTP Proxy in GUI (Recommended)
- Navigate to Settings > System Configuration > Advanced
- Find the Http proxy (for upgrades) field
- Enter your proxy server address:
http://proxy-server-ip:port - If authentication is required, include credentials:
http://username:password@proxy-server-ip:port - Save the settings
- Retry the GUI upgrade (Settings > System > Upgrade) or sensor upgrade (Settings > Sensors)
Solution 2: Proxy for Remote Sensors (curlproxy)
For remote sensors that need to download packages independently, configure the curlproxy parameter directly on the sensor:
- SSH into the remote sensor server
- Edit the sensor configuration:
sudo nano /etc/voipmonitor.conf - Add or modify the
curlproxyline in the[general]section:
[general]
curlproxy = http://proxy-server-ip:port
- Restart the sensor service:
sudo systemctl restart voipmonitor - Retry the upgrade from the GUI (Settings > Sensors)
References:
Troubleshooting: GUI in iframe Not Loading Properly
If the VoIPmonitor GUI is embedded in an iframe (e.g., from another web application) and fails to load or shows 301 redirect errors:
Symptoms:
- Iframe displays error messages or blank content
- 301 redirect when accessing subfolder URLs (e.g.,
/ucloud,/unite) - Browser console shows refused to load in iframe errors
Solution: Enable iframe Support in System Configuration
The GUI sends security headers (such as X-Frame-Options) by default to prevent clickjacking attacks. To allow the GUI to run in an iframe:
- Navigate to Settings > System Configuration > Advanced
- Find the Enable GUI to run in iframe setting
- Set it to
true - Save the settings
- Re-test the iframe functionality
Apply this setting to all relevant GUI installations/folders if you have multiple instances (e.g., /ucloud and /unite).
Additional Notes:
- This is a GUI-level setting for security header configuration, not a web server configuration
- After enabling, the browser should be able to load the GUI content within the iframe
- For security reasons, only enable this if you trust the parent application hosting the iframe
Troubleshooting: License Key Renewal Failures
If the "get/update license key" button fails or the license cannot be renewed automatically, the most common cause is a firewall blocking outbound HTTPS connections to the VoIPmonitor portal.
Primary Solution: Configure Firewall Rules
The GUI requires outbound access to the VoIPmonitor portal servers via HTTPS (TCP port 443). Configure your firewall to allow:
# Example: Allow outbound HTTPS to voipmonitor.org
sudo firewall-cmd --permanent --add-service=https
# Or allow specific traffic
sudo firewall-cmd --permanent --add-rich-rule='rule family="ipv4" destination address="voipmonitor.org" port protocol="tcp" port="443" accept'
sudo firewall-cmd --reload
For iptables-based firewalls:
# Allow outbound HTTPS to voipmonitor.org
sudo iptables -A OUTPUT -p tcp -d voipmonitor.org --dport 443 -j ACCEPT
sudo iptables -A INPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT
# Save rules (distribution-specific)
sudo iptables-save | sudo tee /etc/iptables/rules.v4
For corporate environments with restrictive firewalls or outbound web proxies, contact your network administrator to:
- Allow outbound HTTPS (port 443) to
voipmonitor.org - Allow access to
download.voipmonitor.organdgithub.com(for upgrades) - Configure any necessary proxy settings (see GUI Upgrades Behind Proxy Servers)
Alternative Solutions
If you cannot configure firewall rules or have no internet access:
- Option 1: Use HTTP Proxy
Configure the Http proxy (for upgrades) setting in Settings > System Configuration > Advanced if a corporate proxy is available. This setting routes HTTPS requests including license renewal through an approved proxy server.
- Option 2: Offline Activation (Last Resort)
If network access is completely blocked, use offline activation:
- Log in to https://www.voipmonitor.org
- Navigate to Services > My services
- Locate your VoIPmonitor license
- Click the license button
- Copy the full license key content (multi-line text including Expires, id, hwid, maxcalls, etc.)
- Paste the full content into the License key field in Settings > License
- Click Save
Verification After configuring firewall rules or updating the license:
- Return to Settings > License
- Click the get/update license key button
- Verify the license status shows as current and not expired
Localization
Create custom translations for the GUI interface. Localizations are not 100% complete; please report missing translation items.
- Red numbers indicate untranslated items, which is useful after upgrading to identify new strings
- Changes take effect after logout/login
CDR View Custom URL
Add custom hyperlinks to the CDR view Commands column. This is useful for integrating external monitoring or CRM systems.
Configuration
Navigate to GUI > Settings > CDR view custom URL.
You can include CDR parameters in the URL using two methods:
- Via Parameters and Custom headers items: Values are appended as query parameters (e.g.,
?paramName=value) - Directly in URL: Use {{paramName}} syntax, which is replaced with the actual value
Display
Configured custom URLs appear as links in the Commands column of the CDR view.
AI Summary for RAG
Summary: This article documents VoIPmonitor GUI settings including sensor configuration (with SSL/TLS parameters for decrypting encrypted SIP traffic), sensor health monitoring via RRD charts (buffer usage and packet drops graphs to diagnose sniffer host overload), troubleshooting server instances that do not appear in the GUI after hardware replacement, disabling sensors to stop data collection, CDR custom headers with their limitations and performance optimization (database index creation), distributed architecture troubleshooting for custom headers not visible in central GUI, GeoIP data loading, system configuration (basic, database, national, intervals, email, license, GeoIP, advanced), localization, and custom CDR URLs. Advanced settings include Http proxy (for upgrades) for configuring proxy servers behind firewalls, Pcap deduplication before download which can cause packet count mismatches between GUI SIP History and downloaded PCAP files, and ENABLE_CSRF_CHECK for security hardening by enabling CSRF (Cross-Site Request Forgery) protection tokens in the GUI to mitigate web attacks. CDR CUSTOM HEADERS: Settings > CDR Custom Headers allows capturing custom SIP headers (like X-Cisco-Org-ID) into database columns for viewing and searching; require adding header name to custom_headers in voipmonitor.conf and restarting sniffer to create database columns; configuration fields include Header Field, Name, Match in SIP by Header, Show as Column, Restrict to Regex pattern, and Select occurrence; SELECT OCCURRENCE FIELD controls which occurrence of a SIP header is stored when the same header appears multiple times in a call (common for headers like P-Asserted-Identity that appear in both initial INVITE and subsequent re-INVITEs); First found value captures header from first occurrence (typically initial INVITE) and ignores re-INVITEs during hold/transfers/session modifications- recommended when only original value from call setup is needed; Last found value captures final occurrence if header changes during call; to capture only initial P-Asserted-Identity and ignore re-INVITE values, set Select occurrence to First found value in Settings > CDR Custom Headers; this ensures consistent Caller ID based on original call setup rather than later modifications; custom headers limitations include no regexp extraction, no delimiter aggregation for multiple header values, and no per-method filtering. Key topics: Enable GUI to run in iframe setting in Settings > System Configuration > Advanced allows embedding the VoIPmonitor GUI in iframes for subfolders like /ucloud or /unite - by default the GUI sends security headers (X-Frame-Options) to prevent iframe embedding for clickjacking protection; GUI in iframe not loading properly with 301 redirect errors can be fixed by enabling the "Enable GUI to run in iframe" setting to true; ENABLE_CSRF_CHECK in Settings > System Configuration > Advanced enables CSRF token validation for state-changing operations to increase session security and mitigate web attacks including XSS vulnerabilities - set to TRUE to enable and recommended for production environments; LICENSE UPDATE: After purchasing or renewing a license through voipmonitor.org portal, navigate to Settings > License and click the "get/update license key" button - the GUI automatically fetches your updated license if payment has been processed (no manual entry needed); if automatic retrieval fails, retrieve license manually from portal: log in to voipmonitor.org, navigate to Services > My services, locate license, view details, copy full license key content (multi-line text), paste into License key field in Settings > License; license token is a short text string for retrieving license key; license key field accepts full multi-line license key content; "get/update license key" button fetches license from VoIPmonitor portal; SENSOR DISABLE: Disabling a sensor in the GUI does NOT stop it from collecting data - the sensor process continues to capture and write to the database regardless of GUI status. To stop data collection permanently, run "systemctl stop voipmonitor" on the sensor host machine. Alternatively, use capture rules with SKIP=ON to prevent CDRs from being written to the database while keeping the service running for selective blocking; custom headers store raw SIP header values without regexp extraction or delimiter aggregation; DATABASE INDEX OPTIMIZATION: Custom header columns in cdr_next_X tables are NOT indexed by default to maintain high database write performance - to optimize performance for frequent or large-scale queries on custom SIP headers, manually create a database index by first querying cdr_custom_headers to find dynamic_table and dynamic_column (e.g., header 'X-Custom-Header' stored in cdr_next_2, column custom_header_3), then execute CREATE INDEX idx_custom_header_3 ON cdr_next_2 (custom_header_3) - adding indexes increases database load during CDR insertion so only create indexes on frequently queried headers; use EXPLAIN to verify the database uses your index (type: ref is index lookup, type: ALL is full table scan); if using cdr_partition_by_hours or daily partitioning, index is automatically created on all partitions; sensor SSL settings (ssl_key, ssl_cert, ssl_ipport) can be configured via GUI wrench icon; sensor health monitoring via RRD charts (Settings > Sensors > chart icon) showing buffer usage and packet drops to diagnose sniffer overload vs network quality issues; sensor troubleshooting for non-deletable local sensors in server/probe deployments; server instance troubleshooting when replacing hardware (server/SBC) and reusing IP address - requires manually creating sensor entry in Settings > Sensors and configuring managerip/managerport in voipmonitor.conf on the new server instance; DISTRIBUTED ARCHITECTURE: Custom headers not visible in central GUI for specific sensor despite being configured - check sensor's server_destination, server_destination_port, and server_password in /etc/voipmonitor.conf; delete sensor entry from GUI Settings > Sensors and restart sniffer service to re-register; without correct server_destination configuration, sensor captures headers locally but does not transmit CDRs to central database; GUI and sensor upgrades behind proxy servers can be configured via Settings > System Configuration > Advanced > Http proxy (for upgrades) or via curlproxy in voipmonitor.conf for remote sensors; license notification emails can be disabled by removing the email address in Settings > License; license email supports multiple recipients by entering email addresses separated by a comma (e.g., user1@example.com,user2@example.com); troubleshooting CDR custom headers not being captured or showing truncated content - check snaplen parameter (increase to 3200 or higher for long SIP headers like STIR/SHAKEN P-Asserted-Identity with verstat parameters) and custom_headers_max_size parameter (increase from default 1024 if header content is truncated); CDR timezone configuration - use "Sensors Timezone" setting in Settings > System Configuration > National to fix CDR times displaying in UTC instead of local timezone; the regular "Timezone" setting is for GUI host (reports, alerts), not for CDR data; all sensors sending data to the same database should use the same timezone; sensor OS timezone can be overridden via timezone or utc options in voipmonitor.conf; INTERNATIONAL NUMBERS CONFIGURATION: For international numbers not displaying or being handled correctly (missing country codes, showing in local format when they should be international, numbers not being classified as international, international calls grouped incorrectly), configure the local number (country name) and international prefix settings in Settings > System Configuration > National; set Local number to your country name (e.g., Australia, United States, Czech Republic); set International prefix to the international dialing prefix for your country (e.g., 0011 for Australia, 011 for US/Canada, 00 for many European countries, 010 for Japan); example: Australia deployment should use Local number = Australia, International prefix = 0011; these settings ensure VoIPmonitor correctly normalizes and displays international numbers based on your local numbering plan.
Keywords: GUI settings, sensors, disable sensor, stop sensor, capture rules SKIP, skip CDRs, stop data collection, duplicate records, sensor disabled GUI, CDR custom headers, header limitations, select occurrence, first found value, last found value, custom header occurrence, header multiple occurrences, re-INVITE header capture, initial INVITE header, P-Asserted-Identity re-INVITE, capture first header only, ignore re-INVITE headers, custom header occurrence selection, GeoIP, system configuration, timezone, national prefix, date format, intervals, email settings, license settings, license notification emails, overage notification, multiple recipients, comma-separated emails, LICENSE UPDATE, update license after payment, get/update license key button, Settings > License, license token, license key, retrieve license from portal, voipmonitor.org portal, Services > My services, copy license key, paste license key, multi-line license key, license not received after payment, license update automatically, manual license update, advanced settings, localization, custom URL, CSV export, ssl_key, ssl_cert, ssl_ipport, tls decryption, ssl configuration, pcap deduplication, packet count mismatch, missing packets in PCAP, RRD charts, sensor health monitoring, buffer usage, packet drops, sniffer overload, choppy audio, poor call quality, MOS score, sensor capacity limits, server instance troubleshooting, hardware replacement, SBC replacement, reusing IP address, managerip, managerport, server not appearing in GUI, CDR warning about unknown sensor, proxy, http proxy, proxy server, firewall, corporate proxy, GUI upgrade, sensor upgrade, curlproxy, proxy authentication, custom headers troubleshooting, snaplen, custom_headers_max_size, header capture issues, SIP packet capture, STIR, SHAKEN, P-Asserted-Identity, verstat, truncated headers, long SIP headers, CDR timezone, sensors timezone, UTC time display, BST time display, incorrect CDR times, iframe, embed, X-Frame-Options, clickjacking, GUI in iframe, iframe 301 redirect, ucloud, unite, subfolder, security headers, distributed architecture, custom headers not visible central GUI, sensor not sending CDRs to central database, server_destination, server_destination_port, server_password, delete sensor from GUI, re-register sensor, sensor configuration wrong, headers captured locally not in central GUI, CSRF, ENABLE_CSRF_CHECK, CSRF protection, cross-site request forgery, web security, XSS vulnerability mitigation, session security, security hardening, database index, index custom header, database performance, cdr_custom_headers table, dynamic_table, dynamic_column, CREATE INDEX, query optimization, custom header queries slow, EXPLAIN query, database indexes not indexed by default, partitioned tables index, full table scan, index lookup performance, international numbers, local number, international prefix, country code, international calls display, numbers not displaying correctly, Settings > System Configuration > National, normalize international numbers, Australia 0011, US Canada 011, Europe 00, Japan 010, international number configuration
Key Questions:
- How do I disable a sensor in the GUI?
- Why is the sensor still collecting data when disabled in the GUI?
- How do I stop a sensor from writing to the database?
- How do I use capture rules with SKIP to stop data collection?
- What is the difference between disabling a sensor in GUI vs systemctl stop?
- How do I prevent duplicate records from a disabled sensor?
- How do I temporarily stop a sensor without SSH access?
- What happens when I click Disable on a sensor in Settings?
- Why does deleting a sensor in GUI not stop data collection?
- How do I stop voipmonitor service on sensor machine?
- Can I use capture rules to selectively stop data from a sensor?
- How do I configure the "select occurrence" field in CDR custom headers?
- What is the difference between "first found value" and "last found value" for custom SIP headers?
- How do I capture only the initial INVITE header and ignore re-INVITEs?
- Why are my custom SIP headers capturing multiple values from re-INVITEs?
- How do I use "select occurrence first found value" to prevent P-Asserted-Identity from being captured from re-INVITEs?
- How do I update my license after payment in VoIPmonitor GUI?
- Where do I click to get/update license key after purchasing a license?
- How do I manually retrieve my license key from the VoIPmonitor portal?
- My license key was not received after payment, what should I do?
- How do I use the get/update license key button in Settings > License?
- Do I need to manually enter the license key after payment?
- How do I paste the full license key content in Settings > License?
- What is the license token field used for in Settings > License?
- How do I copy my license key from voipmonitor.org portal?
- How do I configure sensors in the VoIPmonitor GUI?
- How do I enable CSRF protection in the GUI?
- Where do I find the ENABLE_CSRF_CHECK setting?
- How do I enable CSRF token validation to mitigate XSS vulnerabilities?
- What is ENABLE_CSRF_CHECK and how does it increase session security?
- How do I enable the GUI to run in an iframe?
- How do I fix 301 redirect errors when loading the GUI in an iframe?
- Where is the "Enable GUI to run in iframe" setting located?
- Why does the GUI not load when embedded in an iframe from another application?
- How do I enable iframe support for subfolders like /ucloud or /unite?
- How do I fix CDR times displaying in UTC instead of local timezone?
- Where do I set the sensors timezone for CDR data?
- What is the difference between "Timezone" and "Sensors Timezone" in Settings?
- How do I configure timezone for multiple sensors sending to the same database?
- How do I configure SSL/TLS settings for a sensor using the GUI?
- How do I enable TLS decryption for specific trunks through the web interface?
- Where do I find SSL/TLS parameters (ssl_key, ssl_cert, ssl_ipport) in the GUI?
- How do I access sensor RRD charts for health monitoring?
- How do I check if the sniffer host is overloaded using RRD charts?
- What do buffer usage and packet drops graphs indicate in sensor RRD charts?
- How can I tell if poor call quality is caused by the sniffer host vs network issues?
- What does buffer usage at 100% mean for VoIPmonitor sensor performance?
- How do I delete a non-deletable local sensor in a server/probe deployment?
- How do I create and configure CDR custom headers?
- Can I extract part of a SIP header using regexp in custom headers?
- Can I aggregate multiple occurrences of a SIP header?
- What are the limitations of CDR custom headers?
- Why are my custom SIP headers not being captured or showing truncated content?
- How do I capture long SIP headers like P-Asserted-Identity for STIR/SHAKEN?
- What is the snaplen parameter in voipmonitor.conf and how does it affect custom header capture?
- What is the custom_headers_max_size parameter in voipmonitor.conf?
- How do I fix truncated custom header content in the database?
- How do I create alerts based on CDR custom headers?
- How do I add a database index to a custom SIP header for better query performance?
- Why are queries on custom SIP headers slow?
- Are custom header columns in the database indexed by default?
- How do I create a database index on custom_header_3 in cdr_next_2?
- How do I find which table and column stores my custom SIP header?
- What is the cdr_custom_headers table used for?
- How does adding indexes on custom headers affect database performance?
- How do I verify the database is using an index for custom header queries?
- What is the difference between type: ref and type: ALL in EXPLAIN results?
- Should I create indexes on all custom SIP headers?
- How does partitioning affect database indexes on custom headers?
- How do I load GeoIP data for the map view?
- What system configuration options are available?
- How do I set national prefixes and date/time formats?
- What interval settings control CDR and dashboard filters?
- How do I configure GeoIP services?
- How do I create GUI localizations?
- How do I add custom URLs to the CDR view?
- How do I export CDRs to CSV via crontab scheduler?
- Why are custom SIP headers not visible in the central GUI for a specific sensor in a distributed deployment?
- How do I fix custom headers not appearing in central GUI when they capture locally on the sensor?
- Where are server_destination, server_destination_port, and server_password configured in distributed architecture?
- How do I re-register a sensor with the central GUI after configuration changes?
- International numbers are not displaying or being handled correctly - how do I fix this?
- How do I configure local number and international prefix settings in the GUI?
- Where do I set the international dialing prefix for my country in VoIPmonitor?
- What international prefix should I use for Australia?
- What international prefix should I use for United States or Canada?
- What international prefix should I use for European countries?
- How do I configure VoIPmonitor for Australian international number display?
- What is the local number setting used for in Settings > System Configuration > National?
- International calls are grouped incorrectly - what settings need to be configured?
- Country codes are missing from displayed numbers - how do I fix this?
- When should I delete and recreate a sensor entry in Settings > Sensors?
- Why does the downloaded PCAP file have fewer packets than shown in the GUI SIP History?
- How do I disable Pcap deduplication before download to include all packets in downloaded PCAP?
- Where do I configure license notification email addresses?
- How do I configure multiple recipients for license expiry notification emails?
- How do I stop receiving license issue and overage notification emails?
- What should I do if a server/SBC does not appear in the GUI after replacing hardware and reusing the IP address?
- How do I manually create a server instance entry in the GUI?
- What are managerip and managerport configuration options in voipmonitor.conf?
- After replacing a server/SBC, why does data appear in CDRs with warnings but the sensor is not visible in Settings > Sensors?
- How do I configure network connectivity for server instances that connect directly to MySQL database?
- Can I switch from the old server instance architecture to modern Client-Server mode?
- How do I configure HTTP proxy for GUI and sensor upgrades?
- Where is the Http proxy (for upgrades) setting in the GUI?
- How do I configure proxy server in Settings > System Configuration?
- How do I fix GUI upgrade failures behind a corporate proxy or firewall?
- How do I configure curlproxy for remote sensors?
- What is the format for HTTP proxy configuration in VoIPmonitor?














