Settings: Difference between revisions

From VoIPmonitor.org
(Add hostname support for sensors with dynamic IPs and client-server mode alternatives)
(10 intermediate revisions by one other user not shown)
Line 2: Line 2:
[[Category:GUI manual]]
[[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.
This page documents the configuration options available in the VoIPmonitor web GUI under the '''Settings''' menu.


== Sensors ==
= Sensors =


If <code>id_sensor</code> is set in <code>/etc/voipmonitor.conf</code> (default is blank), you must create sensor entries here to enable downloading files like PCAP, graphs, and WAV recordings from the GUI.
Configure sensor connections for multi-sensor deployments. Required when <code>id_sensor</code> is set in <code>/etc/voipmonitor.conf</code>.


{| class="wikitable"
{| class="wikitable"
Line 12: Line 12:
! Field !! Description
! Field !! Description
|-
|-
| Sensor ID || The numeric ID matching <code>id_sensor = N</code> in <code>voipmonitor.conf</code>
| Sensor ID || Numeric ID matching <code>id_sensor</code> in voipmonitor.conf
|-
|-
| Name || A descriptive name for the sensor
| Name || Descriptive name for the sensor
|-
|-
| Manager IP || IP address of the sensor for fetching data (PCAP, graph, audio files)
| Manager IP || IP address (or hostname) for fetching data (PCAP, audio files)
|-
|-
| Manager Port || TCP port for the manager API (default: 5029)
| Manager Port || TCP port for 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.
| Remote database || Database connection for "Legs by CID/header" lookups when sensors use different databases
|}
|}


[[File:settings-sensors.png]]
== Multi-Sensor Deployment ==
 
=== 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.


<kroki lang="mermaid">
<kroki lang="mermaid">
Line 35: Line 31:
         S1["Sensor A<br/>id_sensor=2"]
         S1["Sensor A<br/>id_sensor=2"]
         S2["Sensor B<br/>id_sensor=3"]
         S2["Sensor B<br/>id_sensor=3"]
        S3["Sensor C<br/>id_sensor=4"]
     end
     end
     subgraph Central["Central Server"]
     subgraph Central["Central Server"]
         GUI["Web GUI<br/>Settings > Sensors"]
         GUI["Web GUI"]
         DB[(MySQL/MariaDB<br/>cdr.id_sensor)]
         DB[(MySQL)]
     end
     end
     S1 -->|CDR + id_sensor| DB
     S1 -->|CDR| DB
     S2 -->|CDR + id_sensor| DB
     S2 -->|CDR| DB
    S3 -->|CDR + id_sensor| DB
     GUI -->|"Port 5029"| S1
     GUI -->|"Port 5029"| S1
     GUI -->|"Port 5029"| S2
     GUI -->|"Port 5029"| S2
    GUI -->|"Port 5029"| S3
</kroki>
</kroki>


'''Workflow:'''
'''Setup:'''
 
# On each sniffer instance, edit <code>/etc/voipmonitor.conf</code> and set a unique <code>id_sensor</code> value (e.g., 1, 2, 3...):
<syntaxhighlight lang="ini">
# On Sensor A
id_sensor = 2
 
# On Sensor B
id_sensor = 3
</syntaxhighlight>
 
# 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 <code>id_sensor</code> 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)
 
'''Restart the sniffer service''' on each instance to apply the changes:
<syntaxhighlight lang="bash">
# On each sensor machine
systemctl restart voipmonitor
</syntaxhighlight>
 
Newly captured CDRs will now display the source sensor ID in the GUI. The <code>id_sensor</code> is stored in the <code>cdr.id_sensor</code> database column, allowing you to filter and identify which sniffer processed each call.
 
=== Using Hostnames for Sensors with Dynamic IPs ===
 
If a sensor is connected via a dynamic IP address (e.g., home broadband, 4G/5G, or DHCP), its IP may change periodically, causing the GUI connection to be lost. Instead of configuring a static IP, you can use a hostname to resolve the sensor's current IP automatically.
 
{{Tip|This approach works for sensors where the GUI initiates the connection to the sensor (fetching PCAP, graphs, audio files). For bidirectional communication where the sensor must connect to the GUI, use [[Sniffer_distributed_architecture|Client-Server mode]] instead.}}
 
'''To configure a sensor using a hostname:'''
 
# Ensure the sensor has a hostname that resolves to its current IP address (configure via DNS, /etc/hosts, or Dynamic DNS services)
# In the GUI, navigate to '''Settings > Sensors'''
# Click the sensor entry (or create a new one)
# In the '''Manager IP''' field, enter the sensor's '''hostname''' instead of its IP address (e.g., <code>sensor-ny.example.com</code>)
# Save the configuration


The GUI will resolve the hostname to the current IP each time it connects, allowing the sensor to maintain connectivity even when its IP changes.
# Set unique <code>id_sensor</code> in each sensor's <code>/etc/voipmonitor.conf</code>
# Add sensor entries in '''Settings > Sensors''' with matching Sensor ID
# Restart sensors: <code>systemctl restart voipmonitor</code>


{{Warning|The sensor must still have a stable <code>id_sensor</code> configured in <code>/etc/voipmonitor.conf</code> to ensure CDRs are correctly attributed to the same sensor across IP changes.}}
{{Tip|For sensors with dynamic IPs, enter a hostname in the Manager IP field, or use [[Sniffer_distributed_architecture|Client-Server mode]].}}


=== Alternative: Client-Server Mode for Dynamic Addresses ===
== Sensor Configuration via Wrench Icon ==


[[Sniffer_distributed_architecture|Client-Server mode]] is recommended for sensors with dynamic IPs because the sensor (client) initiates the connection to a central server with a static IP address. This architecture has several advantages for dynamic IP environments:
Click the '''wrench icon''' next to a sensor to configure parameters. Use the search field to find settings.
 
* The sensor connects to a known central server IP
* The central server maintains the connection regardless of sensor IP changes
* Uses encrypted TCP connections (port 60024 by default)
* Simplified firewall configuration compared to bidirectional connections
 
In Client-Server mode, the GUI communicates with the central server, and the server maintains connections to multiple sensor clients. The sensor's dynamic IP address is irrelevant for connection stability.
 
For detailed configuration instructions, see [[Sniffer_distributed_architecture|Distributed Architecture: Client-Server Mode]].
 
=== 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:


{| class="wikitable"
{| class="wikitable"
|-
|-
! Parameter !! Description !! Example Value
! Parameter !! Description !! Values
|-
|-
| ssl_key || Path to the private key file (PEM format) for decrypting TLS traffic || <code>/etc/pki/tls/private/server.key</code>
| <code>ssl</code> || Enable TLS decryption || <code>yes</code> / <code>no</code>
|-
|-
| ssl_cert || Path to the SSL certificate file (PEM format) matching the private key || <code>/etc/pki/tls/certs/server.crt</code>
| <code>ssl_ipport</code> || IP:port and key path for TLS || <code>192.168.1.10:5061 /path/to/key.pem</code>
|-
|-
| ssl_ipport || IP address and TLS port of the SIP endpoint to decrypt (without key file path for SSL Key Logger mode, or <code>IP:port /path/to/key</code> for Private Key mode) || <code>192.168.1.10:5061</code>
| <code>sipport</code> || SIP ports to capture || <code>5060,5080</code> or <code>5060,5070-5080</code>
|-
|-
| ssl || Enable SSL/TLS decryption module on the sensor || <code>yes</code>
| <code>savertp</code> || RTP recording mode || <code>yes</code> (full), <code>no</code> (none), <code>header</code> (stats only)
|}
 
'''Important Notes:'''
 
* The sensor SSL settings correspond to the configuration parameters in [[Tls|/etc/voipmonitor.conf]] but are managed through the GUI interface
* This is an alternative to editing <code>voipmonitor.conf</code> directly - 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 <code>mysqlloadconfig</code> such as <code>dtmf2db</code>, <code>dtmf2pcap</code>, 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:
 
<syntaxhighlight lang="bash">
# 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
</syntaxhighlight>
* For decryption of traffic using Perfect Forward Secrecy (PFS) ciphers like Diffie-Hellman (DHE/ECDHE), see [[Tls|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 <code>voipmonitor.conf</code>
 
For detailed information on TLS decryption methods and limitations (including PFS ciphers), see [[Tls]].
 
=== SIP Port Configuration ===
 
The <code>sipport</code> 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:
 
{| class="wikitable"
|-
! Parameter !! Description !! Example Value
|-
| sipport || SIP ports to listen on (comma-separated or ranges) || <code>5060,5080</code> or <code>5060,5070-5080</code>
|}
 
* '''Default:''' Port 5060 only
* '''Multiple ports:''' Use commas (e.g., <code>5060,5061,5080</code>)
* '''Port ranges:''' Use hyphens (e.g., <code>5060,5070-5080</code>)
 
'''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: <code>systemctl restart voipmonitor</code>
* GUI changes (via '''reload sniffer''' button): Settings are applied automatically by the sensor
 
'''Important for Client/Server deployments:'''
 
If using <code>packetbuffer_sender = yes</code> (packet mirroring mode), you must configure matching <code>sipport</code> 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:
 
{| class="wikitable"
|-
! Parameter !! Description !! Example Value
|-
|-
| maxpoolrtpsize || Maximum disk space in MB for RTP PCAP files. When this limit is reached, oldest RTP files are deleted. || <code>51200</code> (50 GB)
| <code>maxpoolrtpsize</code> || Max RTP storage in MB || <code>51200</code>
|-
|-
| 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). || <code>30</code> (30 days)
| <code>maxpoolrtpdays</code> || Max RTP age in days || <code>30</code>
|}
|}


'''When to use RTP limits:'''
{{Warning|1=GUI settings override <code>voipmonitor.conf</code> when <code>mysqlloadconfig</code> is enabled (default). Changes require a full restart (<code>systemctl stop/start</code>), not reload.}}
 
* 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 <code>/etc/voipmonitor.conf</code> when <code>mysqlloadconfig</code> is 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:'''
 
{| class="wikitable"
|-
! 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 <code>voipmonitor.conf</code>: <code>ringbuffer = 200</code> (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 ([[Sniffer_distributed_architecture|Distributed Architecture]])
* Use specialized capture hardware ([[DPDK|DPDK]], [[Napatech|Native Napatech cards]], [[PF_RING|PF_RING]])
* Reduce capture scope (more restrictive [[Capture_rules|capture rules]])
* Upgrade sensor hardware (faster CPU, more RAM)
* Reduce PCAP file storage or enable compression
 
'''Historical Comparison for Troubleshooting Spikes'''
 
When investigating sudden issues like "packetbuffer: MEMORY IS FULL" alarms or bad MOS scores on one sensor:
 
1. Navigate to '''Settings > Sensors''' and click the '''chart icon''' next to the affected sensor
2. Once the charts load, locate the '''From''' date field in the chart controls
3. Adjust the '''From''' date to a period '''before the issue started''' (e.g., 1-2 days earlier)
4. Compare the '''buffer usage''' chart between the normal and problematic periods
5. Look for sudden spikes or patterns that correlate with the error times
 
This historical comparison helps identify whether the issue is a gradual buildup (resource exhaustion) or a sudden traffic pattern change (bursty traffic from specific sources).
 
'''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
* Buffer usage chart shows a sudden increase correlating with error messages like "packetbuffer: MEMORY IS FULL"
 
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:
<syntaxhighlight lang="bash">
systemctl stop voipmonitor
</syntaxhighlight>
# 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 <code>filter</code> directive in <code>voipmonitor.conf</code>
 
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 (GUI + Database only), a "local sensor" (often named <code>localhost</code>) may be automatically created in the sensor list. This sensor cannot be deleted through the normal GUI interface.
 
{{Note|
'''The auto-created local sensor is counted in SUM counters and charts even if it is not sniffing any traffic.''' To prevent this from skewing your statistics on a central server that functions solely as a GUI and Database receiver, use the <code>id_sensor</code> override method below.
}}
 
'''Solution: Override with Manual Sensor Configuration (Recommended)'''
 
To effectively replace the auto-created default local sensor with a manually configured one:
 
# Edit the <code>/etc/voipmonitor.conf</code> file on the central server and set a specific <code>id_sensor</code>:
<syntaxhighlight lang="ini">
# On the central GUI + DB only server
id_sensor = 1
</syntaxhighlight>
 
# In the GUI, navigate to '''Settings > Sensors'''
# Add a new sensor record with the following details:
** Manager IP: <code>127.0.0.1</code>
** Sensor ID: The same ID set in the <code>voipmonitor.conf</code> file (e.g., <code>1</code>)
** Manager Port: <code>5029</code> (or your configured manager port)
** Enable the checkbox for "is server in client/server mode"
** Disable the checkbox for "show active calls from all sensors in active call view"
 
# Save the new sensor configuration
 
This replaces the default auto-created <code>localhost</code> entry with your manual sensor configuration, preventing the default sensor from appearing in statistics and charts.
 
'''Alternative Workaround: Duplicate Sensor Method'''
 
If you simply need to delete an existing non-deletable sensor entry:
 
# 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
 
{{Note|
This method creates a sensor entry that the GUI recognizes instead of the auto-created one. The <code>id_sensor</code> override method (above) is preferred for central GUI+DB servers as it gives you full control over the sensor configuration and prevents the default sensor from being counted in statistics.
}}
 
This occurs because the GUI automatically creates a sensor entry when it detects that <code>id_sensor</code> is set in the configuration but no active capture is configured on the GUI host.
 
=== Troubleshooting: Cannot Delete Sensor Due to Capture Rules ===
 
If you attempt to delete a sensor from the GUI and receive a pop-up error message, or if the delete action has no effect, the most common cause is that the sensor has '''capture rules assigned to it'''. Sensors with active capture rules cannot be deleted until those rules are removed first.
 
'''Resolution Steps:'''
 
# Navigate to '''Control Panel > Capture Rules'''
# Find any capture rules that are assigned to the sensor you are trying to delete
# Rules may be assigned by IP address, phone number, or network range
# Delete or reassign the capture rules to a different sensor
# After all rules have been removed or reassigned, return to '''Settings > Sensors'''
# You can now successfully delete the sensor
 
'''Why this happens:'''
 
Capture rules link to specific sensors for traffic filtering purposes. The GUI enforces referential integrity to prevent orphaned capture rules that would reference non-existent sensors. This safety mechanism ensures deleted rules do not leave behind dangling references that could cause system errors.
 
'''Alternative Solution: If You Need to Keep the Rules'''
 
If you want to delete a sensor but preserve its capture rules for use with a different sensor:
 
# Navigate to '''Control Panel > Capture Rules'''
# Edit each capture rule currently assigned to the sensor
# Reassign the rule to a different sensor (if your deployment has multiple sensors)
# Save the changes
# After all rules are reassigned, delete the original sensor
 
This approach is useful when migrating traffic filtering from one sensor to another without recreating the rules from scratch.
 
=== 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:
<syntaxhighlight lang="bash">
systemctl stop voipmonitor
systemctl start voipmonitor
</syntaxhighlight>
# 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 <code>id_sensor</code> is configured in <code>/etc/voipmonitor.conf</code>. 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:'''
For TLS decryption with PFS ciphers, see [[Tls|TLS Decryption Guide]].


* After an upgrade that caused errors referencing old/decommissioned sensor IP addresses
== RRD Health Charts ==
* 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.
Click the '''chart icon''' next to a sensor to view performance metrics:


=== Troubleshooting: GUI Crashes When Accessing Settings > Sensors ===
* '''Buffer usage:''' Approaching 100% indicates capacity limits
* '''Packet drops:''' Non-zero values indicate sensor overload


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 <code>sensors</code> 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.
{{Note|High buffer/drops cause low MOS and choppy audio. Solutions: increase <code>ringbuffer</code> in config, add sensors, use [[DPDK]] or [[Napatech]].}}


'''Symptoms:'''
== Disabling a Sensor ==
* 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'''
{{Warning|1=The GUI "Disabled" checkbox does NOT stop data collection. The sniffer continues running regardless of GUI status.}}


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.
'''To stop data collection:'''
* '''Complete shutdown:''' <code>systemctl stop voipmonitor</code> on the sensor host
* '''Selective blocking:''' Create capture rule with '''Skip = ON''' in '''Control Panel > Capture Rules'''


<ol>
== Deleting Sensors ==
<li>'''Access the database:'''
<syntaxhighlight lang="bash">
mysql -u voipmonitor -p voipmonitor
</syntaxhighlight></li>


<li>'''Identify obsolete records:'''
If deletion fails, the sensor likely has capture rules assigned. Remove rules first via '''Control Panel > Capture Rules'''.
Inspect the <code>sensors</code> table to find entries that correspond to obsolete sensors. Look for rows with old interface names, missing sensor IDs, or duplicates.
<syntaxhighlight lang="sql">
-- 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;
</syntaxhighlight></li>


<li>'''Delete obsolete records:'''
'''Non-deletable local sensor (GUI+DB only servers):'''
Execute <code>DELETE</code> statements for the identified obsolete rows. Be careful with the <code>WHERE</code> clause to ensure you only delete obsolete data.
<syntaxhighlight lang="sql">
-- 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
On central servers that don't capture traffic, an auto-created "localhost" sensor may appear. To replace it:
DELETE FROM sensors WHERE host LIKE '%old-sensor-name%';
</syntaxhighlight></li>


<li>'''Verify cleanup:'''
# Set <code>id_sensor = 1</code> in <code>/etc/voipmonitor.conf</code> on the central server
<syntaxhighlight lang="sql">
# In GUI: Add new sensor with Manager IP <code>127.0.0.1</code>, same Sensor ID, Port <code>5029</code>
-- Check remaining sensor count
# Enable "is server in client/server mode" checkbox
SELECT COUNT(*) FROM sensors;
# Disable "show active calls from all sensors in active call view" checkbox
</syntaxhighlight>
Exit the database:
<syntaxhighlight lang="sql">EXIT;</syntaxhighlight></li>


<li>'''Critical: Users must log out and log back in'''
= CDR Charts =
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.</li>
</ol>


'''Note:''' The <code>sensors</code> table contains GUI sensor configuration entries, distinct from the <code>sensor_config</code> table which is used for sensor-level parameter overrides when the <code>mysqlloadconfig</code> feature is enabled.
Define predefined charts for the [[Call_Detail_Record_-_CDR#Charts|CDR detail Charts tab]].


=== Troubleshooting: Server Instance Not Appearing in GUI ===
= CDR Custom Headers =


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.
Capture and display custom SIP headers in CDR views. Requires sniffer version 7.0RC7+.


=== Problem: Sensor Appears in CDRs With Warning But Not in GUI List ===
== Setup Workflow ==
 
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., <code>2</code>)
** Name: Descriptive name for the server instance (e.g., <code>SBC-Production</code>)
** Manager IP: IP address of the server instance (the new hardware's IP)
** Manager Port: TCP port for the manager connection (default: <code>5029</code>)
 
'''Step 2: Configure managerip and managerport on the server instance'''
 
Edit the <code>voipmonitor.conf</code> file on the new server instance to point to the GUI:
 
<syntaxhighlight lang="ini">
# 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)
</syntaxhighlight>
 
Restart the voipmonitor service after making changes:
 
<syntaxhighlight lang="bash">systemctl restart voipmonitor</syntaxhighlight>
 
'''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:
 
<syntaxhighlight lang="bash">
# 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"
</syntaxhighlight>
 
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 [[Sniffer_distributed_architecture|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 <code>server_destination</code> and <code>server_destination_port</code>, 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 [[Call_Detail_Record_-_CDR#Charts|CDR detail view's Charts tab]]. These charts provide quick visual analysis for specific call records based on caller/called information.
 
[[File:settings-cdrcharts.png]]
 
== 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]].


<kroki lang="mermaid">
<kroki lang="mermaid">
Line 598: Line 124:
</kroki>
</kroki>


=== How to Add a New Custom SIP Header ===
# Add header to <code>/etc/voipmonitor.conf</code>:
 
<syntaxhighlight lang="ini">
To capture and display a custom SIP header (e.g., <code>X-Cisco-Org-ID</code>) in the CDR view, follow this workflow:
 
;1. Configure the sniffer to capture the header
:Edit <code>/etc/voipmonitor.conf</code> and add the header name to the <code>custom_headers</code> parameter:
:<syntaxhighlight lang="ini">
custom_headers = X-Cisco-Org-ID
custom_headers = X-Cisco-Org-ID
</syntaxhighlight>
</syntaxhighlight>
:For multiple headers, separate with commas: <code>custom_headers = X-Cisco-Org-ID, X-Other-Header</code>
# Restart sensor: <code>systemctl restart voipmonitor</code>
 
# Generate a test call
;2. Restart the sensor service
# Configure in '''Settings > CDR Custom Headers''': select header, set Name, enable "Show as Column"
:Restart the sniffer service for the configuration to take effect and for the database columns to be created:
:<syntaxhighlight lang="bash">
systemctl restart voipmonitor
</syntaxhighlight>
:'''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
== Configuration Fields ==
: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'''
 
[[File:customheaderform.png]]
 
=== Configuration Fields ===
 
;Header Field
:Combo box listing available headers from the <code>cdr_next.custom_header*</code> database columns. These are automatically created when you add headers to <code>custom_headers</code> in <code>voipmonitor.conf</code> and 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 [[Call_Detail_Record_-_CDR#Legs_by_header|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: [[Sniffer_configuration#matchheader|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: <code>^[0-9]+$</code> to capture only numeric values.
 
;Boundary start
:Optional text marker to define where substring extraction should begin. When specified, only the portion of the SIP header value starting after this text will be stored. For example, if your SIP <code>Contact</code> header is <code>sip:1000@192.168.1.1;user=phone</code> and you want to extract only the username (1000), set <code>Boundary start</code> to <code>sip:</code>.
 
;Boundary end
:Optional text marker to define where substring extraction should end. Used together with <code>Boundary start</code> to extract the portion between two delimiters. For example, to extract just the IP from <code>sip:1000@192.168.1.1;tag=as12345</code>, set <code>Boundary start</code> to <code>@</code> and <code>Boundary end</code> to <code>;</code>.
 
;Regexp
:Optional regular expression pattern to extract specific substring(s) from the SIP header value. Unlike the <code>Restrict to Regex pattern</code> field (which filters which headers to capture), this field extracts a portion of the captured header. The regex should include '''capture groups''' using parentheses. Only the first matched capture group will be stored in the database. For example: <code>User-Agent: Asterisk/([0-9.]+)</code> to extract only the version number from the User-Agent header.
 
{{Warning|1=The <code>Regexp</code> extraction method is more CPU-intensive than the <code>Boundary</code> method. After enabling Regexp extraction, monitor the system load via <code>Settings > Sensors</code> during peak traffic to assess the impact. The performance impact is generally expected to be minor, but should be monitored for high-volume deployments.}}
 
;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.
 
=== Extracting Substrings from SIP Headers ===
 
In addition to storing the complete header value, VoIPmonitor can extract specific substrings or parameters from SIP headers using two methods:
 
==== Method 1: Boundary Extraction (Recommended for Performance) ====
 
The Boundary method extracts the portion of the header value that appears between two text markers.
 
'''Example 1: Extracting a parameter from the SIP Contact header'''
 
If your SIP <code>Contact</code> header contains:
<syntaxhighlight lang="text">
Contact: <sip:1000@192.168.1.1:5060;+g.3gpp.icsi-ref="urn:urn-7:3gpp-application.ims.icsi.mscc:audio:1";tag=as12345>
</syntaxhighlight>
 
To extract only the <code>+g.3gpp.icsi-ref</code> parameter value:
 
# In <code>Settings > CDR Custom Headers</code>:
#* Set <code>Header Field</code> to <code>Contact</code>
#* Set <code>Boundary start</code> to <code>+g.3gpp.icsi-ref=</code>
#* Set <code>Boundary end</code> to <code>;</code> (semicolon)
#* Enable <code>Show as Column</code>
#* Click <code>Save</code>
 
Result: The column will store only <code>urn:urn-7:3gpp-application.ims.icsi.mscc:audio:1</code>
 
'''Example 2: Extracting the IP from a SIP URI'''
 
For a header like <code>sip:1000@192.168.1.1:5060;tag=123</code>:
 
# Set <code>Boundary start</code> to <code>@</code>
# Set <code>Boundary end</code> to <code>:</code>
 
Result: Stores only <code>192.168.1.1</code>
 
==== Method 2: Regexp Extraction ===
 
The Regexp method extracts values using regular expressions with capture groups. This is more flexible but CPU-intensive.
 
'''Important: The regex must include capture groups <code>(...)</code>. Only the first capture group will be stored in the database. Not using parentheses in the regex will result in storing the entire matched string instead of the desired substring. If you do not use parentheses, it will NOT work as expected.'''
 
'''Example 3: Extracting a parameter using regex'''
 
For the same SIP <code>Contact</code> header example:
<syntaxhighlight lang="text">
Contact: <sip:1000@192.168.1.1:5060;+g.3gpp.icsi-ref="urn:urn-7:3gpp-application.ims.icsi.mscc:audio:1";tag=as12345>
</syntaxhighlight>
 
To extract the <code>+g.3gpp.icsi-ref</code> value:
 
# In <code>Settings > CDR Custom Headers</code>:
#* Set <code>Header Field</code> to <code>Contact</code>
#* Set <code>Regexp</code> to: <code>\+g\.3gpp\.icsi-ref="([^"]+)"</code>
#  * <code>\+</code> escapes the plus sign
#  * <code>\.</code> escapes the dots (match literal periods)
#  * <code>"([^"]+)"</code> captures the text inside the quotes
#  * The parentheses <code>(...)</code> define the capture group - this is critical
#* Enable <code>Show as Column</code>
#* Click <code>Save</code>
 
Result: Stores only <code>urn:urn-7:3gpp-application.ims.icsi.mscc:audio:1</code>
 
{{Warning|1=Without capture groups (parentheses), the regex will match and store the entire matched string (e.g., <code>+g.3gpp.icsi-ref="value"</code>), not just the value inside. Always include parentheses around the part you want to extract.}}
 
'''Example 4: Extracting User-Agent version number'''
 
For a header like: <code>User-Agent: Asterisk/20.6.0</code>
 
Set <code>Regexp</code> to: <code>Asterisk/([0-9.]+)</code>
 
Result: Stores only <code>20.6.0</code>
 
==== Performance Comparison ===


{| class="wikitable"
{| class="wikitable"
|-
|-
! Method !! CPU Impact !! Flexibility !! Use Case
! Field !! Description
|-
| '''Boundary''' || Low || Moderate || Simple delimiter-based extraction (recommended for most cases)
|-
|-
| '''Regexp''' || Moderate to High || High || Complex patterns, data validation, special character handling
| Header Field || SIP header to capture (from dropdown after restart)
|}
 
{{Tip|The Boundary method is recommended for production deployments due to lower CPU impact. Use Regexp only when Boundary extraction is not sufficient for your use case. Monitor system load via <code>Settings > Sensors</code> after enabling Regexp extraction.}}
 
=== 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 <code>custom_headers</code> parameter in <code>/etc/voipmonitor.conf</code>, a restart is required to create the database columns and begin capturing data.
*'''After changing sniffer capture parameters:''' If you modify <code>snaplen</code>, <code>custom_headers_max_size</code>, or other capture-related parameters in <code>voipmonitor.conf</code>, 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:
<syntaxhighlight lang="bash">
# Using systemd
systemctl restart voipmonitor
 
# Using init scripts
/etc/init.d/voipmonitor restart
</syntaxhighlight>
 
[[File:customheaderscdrpanel.png]]
 
=== 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 <code>%</code> wildcard as the filter value. This matches any non-empty value.
*'''Find all CDRs without this header:''' Type <code>NULL</code> (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 <code>%</code> as a wildcard for partial matches, e.g., <code>sip:%</code> 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 <code>voipmonitor.conf</code>:
 
{| class="wikitable"
|-
|-
! Problem !! Cause !! Solution
| Name || Display label in GUI
|-
|-
| '''Complete header not captured''' || SIP packets are truncated before the custom header content is fully captured | In <code>voipmonitor.conf</code>, increase the <code>snaplen</code> parameter to capture larger packets: <code>snaplen = 3200</code> (or higher for long headers). The default may be too low for extended SIP headers used in STIR/SHAKEN (e.g., <code>P-Asserted-Identity</code> with <code>verstat</code> parameters).
| Match in SIP by Header || Enable for [[Call_Detail_Record_-_CDR#Legs_by_header|Legs by header]] correlation
|-
|-
| '''Header content truncated''' || Custom header value exceeds the maximum allowed size | In <code>voipmonitor.conf</code>, increase the <code>custom_headers_max_size</code> parameter (default: 1024 bytes): <code>custom_headers_max_size = 2048</code>. Headers longer than this value will be truncated during capture.
| Show as Column || Display in CDR list view
|}
 
=== Performance Optimization: Database Index for Custom Headers ===
 
Custom header columns in <code>cdr_next_X</code> 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 <code>cdr_custom_headers</code> lookup table to identify where your header is stored:
 
<syntaxhighlight lang="sql">
-- 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';
</syntaxhighlight>
 
'''Example Result:'''
 
{| class="wikitable"
|-
|-
! dynamic_table !! dynamic_column
| Restrict to Regex pattern || Filter which values to capture
|-
|-
| 2 || 3
| Boundary start/end || Extract substring between delimiters
|}
 
This means your header is stored in <code>cdr_next_2</code> table, column <code>custom_header_3</code>.
 
'''Step 2: Create the index manually'''
 
Execute the <code>CREATE INDEX</code> command using the table and column values found above:
 
<syntaxhighlight lang="sql">
-- Syntax: CREATE INDEX <index_name> ON <table_name> (<column_name>);
CREATE INDEX idx_custom_header_3 ON cdr_next_2 (custom_header_3);
</syntaxhighlight>
 
Choose a descriptive index name following your naming convention (e.g., <code>idx_header_X_Custom_Header</code>).
 
'''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 <code>cdr_partition_by_hours</code> or daily partitioning, the index is created on all partitions automatically. This benefits query performance on recent data.
* '''Query Validation:''' Use <code>EXPLAIN</code> to verify the database uses your new index:
<syntaxhighlight lang="sql">
EXPLAIN SELECT cdr_ID FROM cdr_next_2 WHERE custom_header_3 = 'test_value';
</syntaxhighlight>
*  '''Good Result:''' <code>type: ref</code> (Index lookup is used)
*  '''Bad Result:''' <code>type: ALL</code> (Full table scan - index is not being used)
 
=== Limitations ===
 
The GUI custom header feature has the following limitations:
 
{| class="wikitable"
|-
|-
! Limitation !! Description
| Regexp || Extract using regex with capture groups <code>(...)</code>
|-
|-
| '''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 <code>custom_headers_last_value</code> in voipmonitor.conf (first or last occurrence).
| Select occurrence || <code>First found value</code>, <code>Last found value</code>, or <code>Nth occurrence</code>
|-
|-
| '''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.).
| Nth occurrence || '''(New in 2026.01)''' When "Nth occurrence" is selected, specify which occurrence number to extract (e.g., <code>2</code> for second occurrence). Uses packet timestamps for accurate ordering even when packet reordering is disabled.
|}
|}


{{Tip|You CAN extract partial values from SIP headers! Use the <code>Boundary start/end</code> or <code>Regexp</code> fields in <code>Settings > CDR Custom Headers</code>. See the [[#Extracting Substrings from SIP Headers|Extracting Substrings from SIP Headers]] section above for detailed examples.}}
== Extracting Substrings ==


=== Alternative: Populating Custom Headers from External Databases ===
'''Boundary method (recommended):''' Extract between delimiters.


When carrier or routing information is stored in an external database (not in SIP signaling), you can populate custom header columns using direct SQL updates from the external data source.
Example: From <code>sip:1000@192.168.1.1;tag=123</code>, extract IP:
* Boundary start: <code>@</code>
* Boundary end: <code>;</code>
* Result: <code>192.168.1.1</code>


{{Note|1='''Use Case vs SIP Capture:''' This method is useful when you have external data (e.g., carrier billing records) that is not available in SIP signaling. If you can add the carrier ID as a SIP header in the INVITE message, capturing via SIP traffic (see above) is preferred as it requires no external synchronization.}}
'''Regexp method:''' Use capture groups for complex patterns.
 
=== Step-by-Step: Import Carrier Data from External Database ===
 
'''Step 1: Create the Custom Header Column'''
 
Even if the data will be populated externally, you must define the header to create the database column:
 
1. Add to <code>/etc/voipmonitor.conf</code>:
<syntaxhighlight lang="ini">
custom_headers = x-termination-carrier
</syntaxhighlight>
2. Restart the sensor:
<syntaxhighlight lang="bash">
systemctl restart voipmonitor
</syntaxhighlight>
3. Configure in GUI > Settings > CDR Custom Headers (set Name and enable "Show as Column")
 
'''Step 2: Find the Table and Column Location'''
 
Query the <code>cdr_custom_headers</code> lookup table to identify where your custom header is stored:
 
<syntaxhighlight lang="sql">
SELECT dynamic_table, dynamic_column
FROM cdr_custom_headers
WHERE header_field = 'x-termination-carrier';
</syntaxhighlight>
 
''Example Result:'' <code>dynamic_table = 2</code>, <code>dynamic_column = 1</code>
 
This means the data is stored in table <code>cdr_next_2</code> and column <code>custom_header_1</code>.
 
'''Step 3: Create Synchronization Script'''
 
Create a script (Python, PHP, or shell) to populate the custom header from your external database. The script connects to both databases and updates records based on a matching key.
 
''' Matching Keys: '''
* <code>cdr_ID</code>: Internal VoIPmonitor CDR ID (most reliable if available in external DB)
* Time and numbers: <code>callend</code> time + <code>caller</code>/<code>called</code> (less reliable)
 
'''SQL Example''' (run via cron):
 
<syntaxhighlight lang="sql">
-- Update VoIPmonitor table with carrier data from external database
-- Assuming external table 'external_billing' has 'cdr_id' and 'carrier_name'
 
UPDATE cdr_next_2 cn
JOIN external_db.billing eb ON cn.cdr_ID = eb.cdr_id
SET cn.custom_header_1 = eb.carrier_name
WHERE eb.carrier_name IS NOT NULL;
</syntaxhighlight>
 
{{Warning|
'''Permissions Required:''' You must have UPDATE permissions on VoIPmonitor's <code>cdr_next_X</code> tables. Only update records you are certain match correctly. Test with SELECT queries first before running UPDATE statements.
}}
 
'''Step 4: Create Charts Using the Imported Data'''
 
Once the data is synchronized, create charts filtering by the custom header:
 
1. Navigate to <code>GUI > CDR > Charts</code>
2. Click <code>+</code> to create a new chart
3. Add series with filters like <code>x-termination-carrier = CarrierA</code>
4. Each carrier appears as a separate line on the chart
 
For detailed information on charting custom headers, see [[Charts#Creating_Percentage_Comparisons_for_Custom_SIP_Headers|Charts: Creating Percentage Comparisons for Custom SIP Headers]].
 
'''Performance Considerations'''
 
* Schedule sync scripts during off-peak hours to reduce database load
* Index the matching column (<code>cdr_ID</code>) in both databases if not already indexed
* Ensure <code>cdr_ID</code> is included in your external database for reliable matching
* Consider using database connection pooling for frequent sync operations
 
=== 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 <code>server_destination</code> configuration is incorrect or missing on the sensor
* The <code>server_destination_port</code> does not match the central server's <code>server_bind_port</code>
* The <code>server_password</code> is incorrect
* The sensor entry in the GUI has conflicting configuration
 
'''Solution Workflow:'''
 
;1. Verify sensor configuration:
On the affected sensor, check <code>/etc/voipmonitor.conf</code>:
<syntaxhighlight lang="ini">
# /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
</syntaxhighlight>
 
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:
<syntaxhighlight lang="bash">
systemctl restart voipmonitor
</syntaxhighlight>
# 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 <code>server_destination</code>, <code>server_destination_port</code>, and <code>server_password</code> 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 [[Sniffer_distributed_architecture|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:
 
<syntaxhighlight lang="bash">
# 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
</syntaxhighlight>
 
Replace <code>&lt;manager_ip&gt;</code> and <code>&lt;manager_port&gt;</code> with your sensor's manager connection settings (configured in [[Settings#Sensors|Settings > Sensors]] or in <code>voipmonitor.conf</code> with <code>managerip</code> and <code>managerport</code>). The default manager port is <code>5029</code>.
 
If no headers are listed, verify that:
* You have added the header names to the <code>custom_headers</code> directive in <code>voipmonitor.conf</code>
* You have restarted the voipmonitor service after adding headers
* The <code>cdr_custom_headers</code> table contains the expected entries
 
'''Verify the data is present in the database:'''
 
Check that the custom header data is actually being captured and stored:
 
<syntaxhighlight lang="sql">
-- 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
</syntaxhighlight>
 
Replace <code>&lt;your_header_name&gt;</code>, <code>&lt;table_number&gt;</code>, and <code>&lt;column_number&gt;</code> with the values returned by the first query.
 
'''Check for manual changes to the database:'''
 
{{Warning|
'''Do NOT manually modify''' the <code>cdr_custom_headers</code> 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 <code>cdr_custom_headers</code> with the headers listed in the manager API output and the columns present in the <code>cdr_next_*</code> 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:


<syntaxhighlight lang="text">
<syntaxhighlight lang="text">
Append ?debug=31415 to any GUI URL (e.g., https://your-gui.com/cdr/?debug=31415)
# Extract version from: User-Agent: Asterisk/20.6.0
Regexp: Asterisk/([0-9.]+)
Result: 20.6.0
</syntaxhighlight>
</syntaxhighlight>


Then open your browser's Developer Console (F12) and look for JavaScript errors that might indicate a rendering problem. Common issues include:
{{Warning|1=Regexp MUST include parentheses <code>(...)</code> to define what to capture. Without them, the entire match is stored.}}
* 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 <code>custom_headers_dump cdr</code> manager API output
* [ ] <code>cdr_custom_headers</code> table has correct mapping
* [ ] Data exists in the appropriate <code>cdr_next_*</code> table
* [ ] No manual modifications to <code>cdr_custom_headers</code> were 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 <code>?debug=31415</code>)
 
== Load GeoIP Data ==
 
Loads GeoIP data into the internal database for the [[Call_Detail_Record_-_CDR#Map|CDR detail Map tab]], which displays geographic locations of call participants.


[[File:settiongs-loadgeoip.png]]
== Filtering by SIP Method and Response Code ==


== System Configuration ==
You can filter custom header extraction to specific SIP methods (e.g., INVITE) or SIP response codes (e.g., 300, 404).
 
The System Configuration section contains core settings that affect the overall behavior of the GUI.
 
=== Basic ===
 
[[File:settings-sysbasic.png]]


{| class="wikitable"
{| class="wikitable"
|-
|-
! Setting !! Description
! Field !! Description !! Example Usage
|-
| 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: <code>/var/spool/voipmonitor</code>)
| CSeq method || Filter by SIP request method || <code>INVITE</code> to capture only from INVITE requests
|-
|-
| Sniffer second datapath || Path to the second spool directory (<code>spooldir_2</code>) configured in the sensor. This allows the GUI to access PCAP files stored in the secondary spool location. When configuring <code>spooldir_2</code> in <code>/etc/voipmonitor.conf</code>, set this field to the same path to enable the GUI to download PCAP, graph, and audio files from that location.
| response code || Filter by SIP response code number || <code>300</code> to capture only from 300 redirect responses
|-
| 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)
|}
|}


{{Warning|
=== Example: Extract Contact IP from 300 Redirect Responses ===
'''Troubleshooting: Sensors connect to wrong destination after upgrade'''
 
After a software upgrade, if sensors connect to the incorrect destination (e.g., the GUI server instead of the intended remote sensor), this is typically caused by '''default sensor hostname''' and '''default sensor TCP port''' being enabled.
 
When these default settings are enabled, sensors ignore their individual Manager IP/Port configuration from '''Settings > Sensors''' and use the default values instead. After an upgrade, this can cause sensors to connect to localhost or an outdated destination.
 
'''Solution:'''
# Navigate to '''Settings > System Configuration > Basic'''
# Disable '''default sensor hostname''' (clear the checkbox/field)
# Disable '''default sensor TCP port''' (clear the checkbox/field)
# Save the changes
# Restart the sniffer service on affected sensors:
<syntaxhighlight lang="bash">systemctl restart voipmonitor</syntaxhighlight>
 
After disabling these defaults, sensors will use their individual Manager IP and Manager Port settings from '''Settings > Sensors'''.
}}
 
=== Database ===
 
Configuration for the MySQL/MariaDB database connection used by the GUI.
 
[[File:settings-sysdb.png]]
 
==== Custom MySQL Port Configuration
 
By default, VoIPmonitor connects to MySQL/MariaDB using the standard port 3306. If your database server uses a custom port, you must update both the sniffer configuration and the GUI configuration.
 
'''Symptoms of incorrect port configuration:'''
 
* GUI shows "Database connection failed" errors
* Sniffer logs contain "Can't connect to MySQL server" message
* CDR data is not appearing in the GUI even though the sniffer is running
 
'''Configuration Steps:'''
 
1. **Configure the Sniffer (Sensor):**
 
Edit <code>/etc/voipmonitor.conf</code> and set the <code>mysqlport</code> parameter:
 
<syntaxhighlight lang="ini">
# /etc/voipmonitor.conf
mysqlport = 33306
</syntaxhighlight>
 
Restart the sniffer service after changing the configuration:
 
<syntaxhighlight lang="bash">
systemctl restart voipmonitor
</syntaxhighlight>
 
2. **Configure the GUI:**
 
There are two ways to configure the GUI to use a custom MySQL port:


'''Option A: Via GUI Settings (Recommended)'''
To filter CDRs for calls involving SIP 300 redirect responses and identify the redirect destination IP:


# Navigate to '''Settings > System Configuration > Database'''
# Navigate to '''Settings > Custom headers > CDR''' in the GUI
# Find the '''MySQL hostname''' field
# Click '''Add new'''
# Enter the host and port in the format <code>hostname:port</code>, for example: <code>127.0.0.1:33306</code> or <code>db-server.example.com:33306</code>
# Set '''Header field''' to <code>Contact</code>
# Set '''Name''' to descriptive label (e.g., <code>SIP300RedirectDestinations</code>)
# Set '''Regexp''' to <code>sip:.*@([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+);</code> to extract the IP address
# Set '''CSeq method''' to <code>INVITE</code>
# Set '''response code''' to <code>300</code>
# Save the configuration
# Save the configuration


{{Warning|1=After changing the database connection settings, you may need to restart your web server or PHP-FPM service for the changes to take effect}}
Use the new custom header and '''Last SIP response code''' as filters in the CDR list to identify calls with 300 redirects and their destinations.


'''Option B: Via configuration.php'''
{{Tip|The CSeq method and response code fields allow you to capture headers from specific SIP messages rather than all headers in the call.}}


Alternatively, you can edit the configuration file directly (typically located at <code>/var/www/html/voipmonitor/php/configuration.php</code> or <code>/var/www/html/config/configuration.php</code>).
== Database Index for Custom Headers ==


Find or add the <code>MYSQL_HOST</code> definition and include the port in the hostname string:
Custom header columns are not indexed by default. For frequent queries:


<syntaxhighlight lang="php">
<syntaxhighlight lang="sql">
// configuration.php
-- Find table/column location
SELECT dynamic_table, dynamic_column FROM cdr_custom_headers
WHERE header_field = 'X-Custom-Header';


// Include port number in the hostname (colon-separated)
-- Create index (use values from above query)
define('MYSQL_HOST', '127.0.0.1:33306');
CREATE INDEX idx_custom_header_3 ON cdr_next_2 (custom_header_3);
define('MYSQL_USER', 'root');
define('MYSQL_PASS', 'your_password');
define('MYSQL_DB',  'voipmonitor');
</syntaxhighlight>
 
{{Note|1=Some older GUI versions may use different constants. Check your configuration.php file for the exact constant names used in your installation. Common variations include <code>DB_HOST</code>, <code>DB_PORT</code>, or using a PHP array configuration pattern}}
 
'''Verification:'''
 
After configuring both the sniffer and GUI:
 
1. Check the sniffer logs for successful database connection:
<syntaxhighlight lang="bash">
# Check if sniffer is connecting to the correct port
systemctl status voipmonitor
tail -f /var/log/syslog | grep voipmonitor
</syntaxhighlight>
</syntaxhighlight>


2. Verify the GUI can connect to the database:
== Troubleshooting Custom Headers ==
* Open the VoIPmonitor web interface in your browser
* If the page loads without errors, the connection is successful
* Check the GUI connection status in Settings > System > Tools
 
3. Test with a live call:
* Make a test call through your VoIP system
* Verify the CDR appears in the GUI within a few seconds
 
'''Common Port Configuration Scenarios:'''


{| class="wikitable"
{| class="wikitable"
|-
|-
! Scenario !! Sniffer Configuration !! GUI Configuration
! Problem !! Solution
|-
|-
| Default MySQL port (local) || <code>mysqlport = 3306</code> (or omit parameter) || <code>MYSQL_HOST = "localhost"</code>
| Header not captured || Increase <code>snaplen</code> in voipmonitor.conf (default may be too low)
|-
|-
| Custom MySQL port (local) || <code>mysqlport = 33306</code> || <code>MYSQL_HOST = "127.0.0.1:33306"</code>
| Header truncated || Increase <code>custom_headers_max_size</code> (default: 1024 bytes)
|-
|-
| Custom MySQL port (remote) || <code>mysqlport = 33306</code> || <code>MYSQL_HOST = "db-server:33306"</code>
| Not visible in distributed setup || Check <code>server_destination</code> and <code>server_password</code> on sensor
|-
| SSH tunnel to remote DB || <code>mysqlport = 3307</code> (tunnel port) || <code>MYSQL_HOST = "localhost:3307"</code>
|}
|}


'''Related Documentation:'''
Verify loaded headers: <code>echo 'custom_headers_dump cdr' | nc localhost 5029</code>
 
* [[Sniffer_configuration|Sniffer Configuration]] - Full reference for voipmonitor.conf parameters
* [[SSL/TLS_connection_to_the_Mysql/MariaDB|Secure Database Connection with SSL/TLS]] - For encrypted database connections
* [[GUI_Configuration_PHP|GUI Configuration PHP]] - For editing configuration.php directly
* [[Database_troubleshooting|Database Troubleshooting]] - Common database-related issues and solutions


= Load GeoIP Data =


=== National ===
Loads GeoIP data for the [[Call_Detail_Record_-_CDR#Map|CDR Map tab]]. See [[Order_of_GeoIP_processing]] for processing priority.


Settings for localizing call classification and date/time display formats.
= System Configuration =


[[File:settings-sysnational.png]]
== Basic ==


{| class="wikitable"
{| class="wikitable"
Line 1,233: Line 246:
! Setting !! Description
! 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.
| WEB URL || Base URL for hyperlinks in emails
|-
| 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|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., <code>0011</code> for Australia, <code>00</code> for many countries, <code>011</code> for US/Canada)
|-
|-
| Local number || Your country name or local region for number normalization (e.g., <code>Australia</code>, <code>United States</code>, <code>Czech Republic</code>)
| Sniffer data path || PCAP storage directory (default: <code>/var/spool/voipmonitor</code>)
|-
|-
| Date format || PHP date format string (default: <code>Y-m-d</code>). See [https://www.php.net/manual/en/datetime.format.php PHP DateTime format]
| Sniffer second datapath || Secondary spool directory (<code>spooldir_2</code>)
|-
|-
| Time format || PHP time format string (default: <code>G:i:s</code>). See [https://www.php.net/manual/en/datetime.format.php PHP DateTime format]
| Default sensor hostname || Default hostname for sniffer connection
|-
|-
| Week start || First day of the week for calendar displays
| Default sensor TCP port || Default manager API port (5029)
|}
|}


{{Tip|1='''CDR Timezone Troubleshooting:'''
{{Warning|1=If sensors connect to wrong destination after upgrade, disable '''Default sensor hostname''' and '''Default sensor TCP port''' in this section. When enabled, sensors ignore individual Manager IP/Port settings.}}
 
If CDR times are displaying in UTC instead of local timezone (e.g., showing in UTC instead of BST):


* The fix is to set '''Sensors Timezone''' (NOT the regular '''Timezone''' setting) to the correct timezone for your sensors
== Database ==
* Ensure all sensors sending data to this database are configured to use the same timezone
* If a sensor's OS timezone differs from the Sensors Timezone setting, you can override it by editing <code>/etc/voipmonitor.conf</code> on the sensor and using the <code>timezone</code> or <code>utc</code> options
* The regular '''Timezone''' setting is for the GUI host itself (report scheduling, alerts), not for CDR data display}}


=== Troubleshooting: International Numbers Not Displaying Correctly ===
MySQL/MariaDB connection settings.


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.
'''Custom port:''' Enter host with port in MySQL hostname field: <code>127.0.0.1:33306</code>


'''Common Symptoms:'''
Also configure <code>mysqlport</code> in <code>/etc/voipmonitor.conf</code>. See [[Database_troubleshooting]] for details.
* 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'''
== National ==
 
# Navigate to '''Settings > System Configuration > National'''
# Set the '''Local number''' field to your country name (e.g., <code>Australia</code>, <code>United States</code>, <code>Czech Republic</code>)
# Set the '''International prefix''' field to the international dialing prefix for your country:
** Australia: <code>0011</code>
** United States/Canada: <code>011</code>
** Many European countries: <code>00</code>
** Japan: <code>010</code>
# Save the settings
 
'''Example: Australia'''
For an Australian deployment:
* '''Local number:''' <code>Australia</code>
* '''International prefix:''' <code>0011</code>
 
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.
 
[[File:settings-sysintervals.png]]


{| class="wikitable"
{| class="wikitable"
Line 1,299: Line 273:
! Setting !! Description
! 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
| Timezone || GUI host timezone (for reports/alerts scheduling)
|-
|-
| Default CDR interval in days || Number of days for the CDR filter (only editable if above is set to "specified number of days")
| '''Sensors Timezone''' || '''CDR display timezone''' - set this to fix UTC display issues
|-
|-
| Default dashboard interval || Default time filter when entering the dashboard
| National prefix || Prefixes for national call classification
|-
|-
| Default Legs by CID interval || Time window (+/-) for finding related calls in the Legs by CID tab (default: 5 seconds)
| International prefix || International dialing prefix (e.g., <code>00</code>, <code>011</code>)
|-
|-
| Default Legs by header interval || Time window (+/-) for finding related calls in the Legs by header tab (default: 5 seconds)
| Local number || Country name for number normalization
|}
|}


=== Email / HTTP Referer ===
{{Tip|1=If CDRs display in UTC instead of local time, set '''Sensors Timezone''' (not regular Timezone) to your sensors' timezone.}}


Email configuration settings.
== Intervals ==


[[File:settings-sysemailhttpreferer.png]]
Default time filters for CDR view, dashboard, and Legs correlation.
 
== Email / HTTP Referer ==


{| class="wikitable"
{| class="wikitable"
Line 1,322: Line 298:
| DEFAULT_EMAIL_FROM || Default "From" address for outgoing emails
| 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)
| Disable email plain text || Force HTML-only emails
|}
|}


=== License ===


License and notification email configuration.


[[File:settings-syslicense.png]]
=== Troubleshooting Email Delivery ===


{| class="wikitable"
If users report not receiving verification emails or new user setup emails, verify the email sending status:
|-
! 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:'''
<b>For Exim mail servers:</b>
<syntaxhighlight lang="bash"># Check Exim mail log for delivery attempts
grep "recipient@example.com" /var/log/exim/main.log


After purchasing or renewing a license through the voipmonitor.org portal, update your GUI license as follows:
# Or search by timestamp
grep "2025-01-09 14:30:" /var/log/exim/main.log
</syntaxhighlight>


# Navigate to '''Settings > License'''
Look for the response code in the log entry:
# Click the '''get/update license key''' button
* <code>250 message accepted</code> - Email was successfully delivered to remote server. The issue is on the recipient side (spam folder, quarantine, mail filtering).
* No <code>250</code> code - Email delivery failed at the server level. Check mail queue and server MTA configuration.


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.
<b>If logs confirm successful delivery:</b> Inform the client that the email left the server successfully and advise them to check their Spam, Bulk, or Junk folders, or consult their internal IT team regarding mail filtering policies.


'''Manually Retrieving License from Portal:'''
<b>General MTA verification:</b>
<syntaxhighlight lang="bash"># Check if mail agent is running
systemctl status postfix    # or exim4, sendmail


If the automatic update does not work, retrieve your license directly from the portal:
# Test email from command line
echo "Test message" | mail -s "VoIPmonitor Test" your@email.com


# Log in to https://www.voipmonitor.org
# Check mail queue
# Navigate to '''Services > My services'''
mailq
# 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.
# View general mail logs
 
tail -f /var/log/mail.log    # Debian/Ubuntu
To configure the license expiry notification for multiple recipients, enter all email addresses separated by a comma (e.g., <code>user1@example.com,user2@example.com</code>).
tail -f /var/log/maillog      # RHEL/CentOS
 
</syntaxhighlight>
'''Disabling License Notification Emails:'''
== License ==
 
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.
 
[[File:settings-sysgeoip.png]]


{| class="wikitable"
{| class="wikitable"
Line 1,387: Line 341:
! Setting !! Description
! Setting !! Description
|-
|-
| Use GeoIP local database || Enable/disable the internal GeoIP database (if loaded via [[#Load_GeoIP_Data|Load GeoIP Data]])
| License token || Short token for retrieving license from portal
|-
|-
| GeoIP maxmind.com KEY || API key for MaxMind GeoIP service
| License key || Full license key content (multi-line)
|-
|-
| GeoIP ipinfodb.com KEY || API key for IPInfoDB service
| License email || Email for license notifications (leave empty to disable)
|}
|}


=== Advanced ===
'''Update license after payment:''' Click '''get/update license key''' button.


Advanced configuration options for power users and specific use cases.
'''Manual activation:''' Copy full license key from portal (Services > My services) and paste into License key field.


[[File:settings-sysadvanced.png]]
'''Disable notification emails:''' Remove email from "License email" field.


{| class="wikitable"
== GeoIP ==
|-
! 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 <code>TRUE</code> 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 <code>--rtp-firstleg</code> 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|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 [[Reports#CSV_Export_via_Crontab_Scheduler|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: <code>http://proxy-server-ip:port</code> or <code>http://username:password@proxy-server-ip:port</code> for authenticated proxies
|-
| Enable GUI to run in iframe || Allow the GUI to be loaded in an <code>iframe</code> (embed the VoIPmonitor interface in other web applications). Set to <code>true</code> to enable. This is required when hosting the GUI in subfolders (e.g., <code>/ucloud</code>, <code>/unite</code>) 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: <code>http://proxy-server-ip:port</code>
# If authentication is required, include credentials: <code>http://username:password@proxy-server-ip:port</code>
# 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 <code>curlproxy</code> parameter directly on the sensor:
# SSH into the remote sensor server
# Edit the sensor configuration: <code>sudo nano /etc/voipmonitor.conf</code>
# Add or modify the <code>curlproxy</code> line in the <code>[general]</code> section:
<syntaxhighlight lang="ini">
[general]
curlproxy = http://proxy-server-ip:port
</syntaxhighlight>
# Restart the sensor service: <code>sudo systemctl restart voipmonitor</code>
# Retry the upgrade from the GUI (Settings > Sensors)
 
'''References:'''
* [[FAQ#How_do_I_troubleshoot_internet_connectivity_issues|FAQ: Troubleshooting Internet Connectivity]]
* [[GUI_Installation|GUI Installation Guide]]
 
=== Troubleshooting: Firewall Requirements for VoIPmonitor Functions ===
 
If your VoIPmonitor server has outbound network connections blocked by a firewall for security purposes, certain functions will fail without specific domain whitelisting.
 
'''Symptoms of blocked outbound connections:'''
* Automatic license updates fail (license key expiration warnings)
* GUI and sniffer upgrades fail via the web interface
* "Share CDR" feature cannot send CDRs to the sharing server
* "Generate debug report" feature cannot upload the report
* Support sessions cannot connect


'''Required Outbound Domain Whitelist:'''
Configure API keys for MaxMind or IPInfoDB services.


To ensure proper functionality when operating behind a restrictive firewall, configure firewall rules to allow the VoIPmonitor server to make outbound HTTPS connections to the following domains:
== Advanced ==


{| class="wikitable"
{| class="wikitable"
|-
|-
! Domain !! Purpose
! Setting !! Description
|-
|-
| <code>voipmonitor.org</code> || License key expiration updates and renewal checks
| ENABLE_CSRF_CHECK || Enable CSRF protection (recommended for production)
|-
|-
| <code>download.voipmonitor.org</code> || Automatic GUI and sniffer binary upgrades via web interface
| Pcap deduplication before download || Remove duplicate packets from PCAP downloads
|-
|-
| <code>share.voipmonitor.org</code> || "Share CDR" feature for sending call data to the sharing server
| Http proxy (for upgrades) || Proxy for GUI/sniffer upgrades: <code>http://proxy:port</code>
|-
|-
| <code>reports.voipmonitor.org</code> || "Generate debug report" feature for uploading diagnostic reports
| Enable GUI to run in iframe || Allow embedding in iframes (disabled by default for security)
|-
|-
| <code>vm1.voipmonitor.org</code> (IP: 37.157.192.45) || Support sessions and remote access
| CDR share key || Secret for CDR share URLs
|}
|}


'''Protocol and Port Requirements:'''
'''Firewall requirements:''' Allow outbound HTTPS to:
* '''Protocol:''' HTTPS (TCP port 443)
* <code>voipmonitor.org</code> - License updates
* '''Direction:''' Outbound initiations from the VoIPmonitor server
* <code>download.voipmonitor.org</code> - Software upgrades
* '''Destination:''' Specific domains listed above (resolve to their current IP addresses via DNS)
* <code>share.voipmonitor.org</code> - CDR sharing
* <code>reports.voipmonitor.org</code> - Debug reports


'''License Check Mechanism:'''
= Localization =


The license expiration status is checked automatically by a cronjob that runs every minute:
Create GUI translations. Red numbers indicate untranslated items. Changes apply after logout/login.


<syntaxhighlight lang="bash">
= CDR View Custom URL =
# Automatic license check (runs every minute via cron)
php /var/www/html/php/run.php cron
</syntaxhighlight>


You can also manually trigger a license check update:
Add custom hyperlinks to CDR Commands column. Use <nowiki>{{paramName}}</nowiki> in URL to include CDR values.


<syntaxhighlight lang="bash">
= Troubleshooting =
# Manually check and update license status
php /var/www/html/php/run.php runUpdateLicenseKey
</syntaxhighlight>


If the license check fails due to firewall blocking, VoIPmonitor may show incorrect expiration warnings or fail to renew licenses automatically.
== Sensors Connect to Wrong Destination After Upgrade ==


'''Alternative Approaches:'''
'''Cause:''' Default sensor hostname/port settings override individual sensor configurations.


If your security policy does not allow direct outbound connections to specific domains:
'''Fix:''' Disable '''Default sensor hostname''' and '''Default sensor TCP port''' in Settings > System Configuration > Basic.


1. '''Use HTTP Proxy:''' Configure the <code>Http proxy (for upgrades)</code> setting in Settings > System Configuration > Advanced to route connections through an approved corporate proxy server
== GUI Crashes on Settings > Sensors Page ==
2. '''Manual Upgrade Method:''' Download packages manually on a machine with internet access and transfer via SCP/SFTP to the restricted server (see [[GUI_Installation|manual upgrade instructions]])
3. '''Offline License Activation:''' For license management without internet access, use the offline method by retrieving the full multi-line license key from the voipmonitor.org portal and pasting it manually into Settings > License (see [[License|license documentation]])


'''Configuration Example (iptables):'''
'''Cause:''' Too many obsolete sensor records in database.


To allow outbound connections to VoIPmonitor domains using iptables:
'''Fix:''' Delete obsolete records directly:
 
<syntaxhighlight lang="sql">
<syntaxhighlight lang="bash">
-- Check count
# Allow outbound HTTPS to voipmonitor.org
SELECT COUNT(*) FROM sensors;
iptables -A OUTPUT -p tcp -d voipmonitor.org --dport 443 -j ACCEPT
-- Delete obsolete entries (adjust WHERE clause)
 
DELETE FROM sensors WHERE host LIKE '%old-sensor%';
# Allow outbound HTTPS to download.voipmonitor.org
iptables -A OUTPUT -p tcp -d download.voipmonitor.org --dport 443 -j ACCEPT
 
# Allow outbound HTTPS to share.voipmonitor.org
iptables -A OUTPUT -p tcp -d share.voipmonitor.org --dport 443 -j ACCEPT
 
# Allow outbound HTTPS to reports.voipmonitor.org
iptables -A OUTPUT -p tcp -d reports.voipmonitor.org --dport 443 -j ACCEPT
 
# Allow outbound HTTPS to vm1.voipmonitor.org (IP: 37.157.192.45)
iptables -A OUTPUT -p tcp -d 37.157.192.45 --dport 443 -j ACCEPT
 
# Save iptables rules
service iptables save
</syntaxhighlight>
</syntaxhighlight>
All users must log out and back in after cleanup.


'''Note:''' IP addresses for VoIPmonitor domains may change over time. For long-term firewall configurations, consider using DNS-based firewall rules, whitelist the authoritative DNS servers for these domains, or periodically review and update IP-based rules.
== License Update Fails ==
 
=== Troubleshooting: GUI in iframe Not Loading Properly ===
 
If the VoIPmonitor GUI is embedded in an <code>iframe</code> (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., <code>/ucloud</code>, <code>/unite</code>)
* Browser console shows refused to load in iframe errors
 
'''Solution: Enable iframe Support in System Configuration'''
 
The GUI sends security headers (such as <code>X-Frame-Options</code>) 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 <code>true</code>
# Save the settings
# Re-test the iframe functionality
 
Apply this setting to all relevant GUI installations/folders if you have multiple instances (e.g., <code>/ucloud</code> and <code>/unite</code>).
 
'''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:
 
<syntaxhighlight lang="bash">
# 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</syntaxhighlight>
 
For iptables-based firewalls:
<syntaxhighlight lang="bash">
# 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</syntaxhighlight>
 
For corporate environments with restrictive firewalls or outbound web proxies, contact your network administrator to:
* Allow outbound HTTPS (port 443) to <code>voipmonitor.org</code>
* Allow access to <code>download.voipmonitor.org</code> and <code>github.com</code> (for upgrades)
* Configure any necessary proxy settings (see [[#Troubleshooting:_GUI_Upgrades_Behind_Proxy_Servers|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 <code>Http proxy (for upgrades)</code> setting in [[#Advanced|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.
 
[[File:settings-localisationform.png]]
 
[[File:settings-localisationgrid.png]]
 
* 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'''.


[[File:cdr_view_custom_url.png]]
'''Cause:''' Firewall blocking outbound HTTPS.


You can include CDR parameters in the URL using two methods:
'''Fix:''' Allow outbound TCP 443 to <code>voipmonitor.org</code>, or configure HTTP proxy in Advanced settings, or use offline activation.


# '''Via Parameters and Custom headers items:''' Values are appended as query parameters (e.g., <code>?paramName=value</code>)
== GUI Not Loading in iframe ==
# '''Directly in URL:''' Use <nowiki>{{paramName}}</nowiki> syntax, which is replaced with the actual value


=== Display ===
'''Fix:''' Enable '''Enable GUI to run in iframe''' in Advanced settings.


Configured custom URLs appear as links in the Commands column of the CDR view.
== PCAP Download Has Fewer Packets Than GUI Shows ==


== AI Summary for RAG ==
'''Cause:''' Pcap deduplication is enabled (removes retransmissions).


'''Summary:''' This article documents VoIPmonitor GUI settings: sensor configuration (multi-sensor deployments, SSL/TLS decryption via GUI wrench icon, SIP port configuration, RTP storage limits), sensor health monitoring via RRD charts (buffer usage, packet drops for diagnosing overload), disabling sensors (GUI "Disabled" option does NOT stop data collection - use systemctl stop or capture rules with SKIP=ON), non-deletable local sensor troubleshooting (on central GUI+DB servers, the auto-created local sensor defaults to being counted in SUM counters and charts; solution is to set id_sensor in voipmonitor.conf and add manual sensor configuration with Manager IP 127.0.0.1, same Sensor ID, Manager Port 5029, enable "is server in client/server mode", disable "show active calls from all sensors in active call view" - this replaces and overrides the default localhost entry, preventing it from appearing in statistics), sensor deletion troubleshooting (cannot delete sensors with active capture rules - delete rules first via Control Panel > Capture Rules), CDR custom headers (configuration, Select occurrence field for handling re-INVITEs, database index optimization, limitations), system configuration (default sensor hostname and TCP port - when enabled, sensors ignore individual Manager IP/Port settings and use defaults, causing wrong destination after upgrade; solution is to disable both defaults and restart sensors), system configuration (timezone settings - use "Sensors Timezone" for CDR display, international number prefixes), license management (get/update license key button, firewall requirements for license checks, license email configuration for controlling "Channels limit reached" and license expiration notification emails - remove email address to disable these alerts), advanced settings (HTTP proxy for upgrades, CSRF protection, iframe embedding), localization, and custom CDR URLs. Key troubleshooting: firewall must allow outbound HTTPS to voipmonitor.org and download.voipmonitor.org for license updates and upgrades; sensors connecting to wrong destination after upgrade is caused by enabled default sensor hostname/port settings; central GUI+DB servers have auto-created local sensor counted in SUM counters - use id_sensor override method to replace it.
'''Fix:''' Disable '''Pcap deduplication before download''' in Advanced settings.


'''Keywords:''' GUI settings, sensors, sensor configuration, SSL/TLS decryption, RRD charts, buffer usage, packet drops, disable sensor, capture rules SKIP, sensor deletion, capture rules blocking deletion, non-deletable local sensor, auto-created local sensor, default localhost sensor, SUM counters, charts, central GUI server, GUI DB only, id_sensor override, replace local sensor, central server sensor, CDR custom headers, custom_headers, select occurrence, first found value, P-Asserted-Identity, database index, system configuration, default sensor hostname, default sensor TCP port, wrong destination after upgrade, sensors connect wrong host, sensors timezone, CDR timezone, international prefix, local number, license update, get/update license key, license email, Channels limit reached, license expiration alert, disable notification emails, license notifications, firewall requirements, HTTP proxy, curlproxy, CSRF protection, iframe embedding, localization, custom URL
= See Also =


'''Key Questions:'''
* [[Sniffer_configuration]] - Full voipmonitor.conf reference
* How do I configure sensors in the VoIPmonitor GUI?
* [[Sniffer_distributed_architecture]] - Client-Server mode
* How do I configure SSL/TLS decryption for a sensor via the GUI?
* [[Tls]] - TLS/SRTP decryption
* How do I disable the default local sensor on a central GUI+DB only server?
* [[Data_Cleaning]] - Storage retention
* Why is the auto-created local sensor counted in SUM counters and charts?
* [[User_Management]] - User permissions
* How do I use id_sensor to override the default local sensor on a central server?
* [[License]] - License management
* How do I configure a manual sensor entry to replace the default localhost sensor?
* Why are my sensors connecting to the wrong destination after a software upgrade?
* How do I fix sensors connecting to localhost instead of their Manager IP?
* What are default sensor hostname and default sensor TCP port settings?
* Should I enable or disable default sensor hostname and TCP port?
* How do I access sensor RRD charts for health monitoring?
* How do I disable a sensor and stop it from collecting data?
* Why can I not delete a sensor from the GUI?
* How do I delete a sensor that has capture rules assigned?
* How do I configure CDR custom headers?
* What is the "select occurrence" field in CDR custom headers?
* How do I capture only the initial INVITE header and ignore re-INVITEs?
* How do I add a database index to a custom SIP header?
* How do I fix CDR times displaying in UTC instead of local timezone?
* How do I configure international number prefixes?
* How do I update my license after payment?
* What firewall rules are required for VoIPmonitor license updates?
* How do I configure HTTP proxy for GUI upgrades?
* How do I disable "Channels limit reached" notification emails?
* Where do I configure the license email for notifications?
* How do I enable the GUI to run in an iframe?
* How do I enable CSRF protection in the GUI?

Revision as of 11:29, 19 January 2026


This page documents the configuration options available in the VoIPmonitor web GUI under the Settings menu.

Sensors

Configure sensor connections for multi-sensor deployments. Required when id_sensor is set in /etc/voipmonitor.conf.

Field Description
Sensor ID Numeric ID matching id_sensor in voipmonitor.conf
Name Descriptive name for the sensor
Manager IP IP address (or hostname) for fetching data (PCAP, audio files)
Manager Port TCP port for manager API (default: 5029)
Remote database Database connection for "Legs by CID/header" lookups when sensors use different databases

Multi-Sensor Deployment

Setup:

  1. Set unique id_sensor in each sensor's /etc/voipmonitor.conf
  2. Add sensor entries in Settings > Sensors with matching Sensor ID
  3. Restart sensors: systemctl restart voipmonitor

💡 Tip: For sensors with dynamic IPs, enter a hostname in the Manager IP field, or use Client-Server mode.

Sensor Configuration via Wrench Icon

Click the wrench icon next to a sensor to configure parameters. Use the search field to find settings.

Parameter Description Values
ssl Enable TLS decryption yes / no
ssl_ipport IP:port and key path for TLS 192.168.1.10:5061 /path/to/key.pem
sipport SIP ports to capture 5060,5080 or 5060,5070-5080
savertp RTP recording mode yes (full), no (none), header (stats only)
maxpoolrtpsize Max RTP storage in MB 51200
maxpoolrtpdays Max RTP age in days 30

⚠️ Warning: GUI settings override voipmonitor.conf when mysqlloadconfig is enabled (default). Changes require a full restart (systemctl stop/start), not reload.

For TLS decryption with PFS ciphers, see TLS Decryption Guide.

RRD Health Charts

Click the chart icon next to a sensor to view performance metrics:

  • Buffer usage: Approaching 100% indicates capacity limits
  • Packet drops: Non-zero values indicate sensor overload

ℹ️ Note: High buffer/drops cause low MOS and choppy audio. Solutions: increase ringbuffer in config, add sensors, use DPDK or Napatech.

Disabling a Sensor

⚠️ Warning: The GUI "Disabled" checkbox does NOT stop data collection. The sniffer continues running regardless of GUI status.

To stop data collection:

  • Complete shutdown: systemctl stop voipmonitor on the sensor host
  • Selective blocking: Create capture rule with Skip = ON in Control Panel > Capture Rules

Deleting Sensors

If deletion fails, the sensor likely has capture rules assigned. Remove rules first via Control Panel > Capture Rules.

Non-deletable local sensor (GUI+DB only servers):

On central servers that don't capture traffic, an auto-created "localhost" sensor may appear. To replace it:

  1. Set id_sensor = 1 in /etc/voipmonitor.conf on the central server
  2. In GUI: Add new sensor with Manager IP 127.0.0.1, same Sensor ID, Port 5029
  3. Enable "is server in client/server mode" checkbox
  4. Disable "show active calls from all sensors in active call view" checkbox

CDR Charts

Define predefined charts for the CDR detail Charts tab.

CDR Custom Headers

Capture and display custom SIP headers in CDR views. Requires sniffer version 7.0RC7+.

Setup Workflow

  1. Add header to /etc/voipmonitor.conf:
custom_headers = X-Cisco-Org-ID
  1. Restart sensor: systemctl restart voipmonitor
  2. Generate a test call
  3. Configure in Settings > CDR Custom Headers: select header, set Name, enable "Show as Column"

Configuration Fields

Field Description
Header Field SIP header to capture (from dropdown after restart)
Name Display label in GUI
Match in SIP by Header Enable for Legs by header correlation
Show as Column Display in CDR list view
Restrict to Regex pattern Filter which values to capture
Boundary start/end Extract substring between delimiters
Regexp Extract using regex with capture groups (...)
Select occurrence First found value, Last found value, or Nth occurrence
Nth occurrence (New in 2026.01) When "Nth occurrence" is selected, specify which occurrence number to extract (e.g., 2 for second occurrence). Uses packet timestamps for accurate ordering even when packet reordering is disabled.

Extracting Substrings

Boundary method (recommended): Extract between delimiters.

Example: From sip:1000@192.168.1.1;tag=123, extract IP:

  • Boundary start: @
  • Boundary end: ;
  • Result: 192.168.1.1

Regexp method: Use capture groups for complex patterns. 

# Extract version from: User-Agent: Asterisk/20.6.0
Regexp: Asterisk/([0-9.]+)
Result: 20.6.0

⚠️ Warning: Regexp MUST include parentheses (...) to define what to capture. Without them, the entire match is stored.

Filtering by SIP Method and Response Code

You can filter custom header extraction to specific SIP methods (e.g., INVITE) or SIP response codes (e.g., 300, 404).

Field Description Example Usage
CSeq method Filter by SIP request method INVITE to capture only from INVITE requests
response code Filter by SIP response code number 300 to capture only from 300 redirect responses

Example: Extract Contact IP from 300 Redirect Responses

To filter CDRs for calls involving SIP 300 redirect responses and identify the redirect destination IP:

  1. Navigate to Settings > Custom headers > CDR in the GUI
  2. Click Add new
  3. Set Header field to Contact
  4. Set Name to descriptive label (e.g., SIP300RedirectDestinations)
  5. Set Regexp to sip:.*@([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+); to extract the IP address
  6. Set CSeq method to INVITE
  7. Set response code to 300
  8. Save the configuration

Use the new custom header and Last SIP response code as filters in the CDR list to identify calls with 300 redirects and their destinations.

💡 Tip: The CSeq method and response code fields allow you to capture headers from specific SIP messages rather than all headers in the call.

Database Index for Custom Headers

Custom header columns are not indexed by default. For frequent queries: 

-- Find table/column location
SELECT dynamic_table, dynamic_column FROM cdr_custom_headers
WHERE header_field = 'X-Custom-Header';

-- Create index (use values from above query)
CREATE INDEX idx_custom_header_3 ON cdr_next_2 (custom_header_3);

Troubleshooting Custom Headers

Problem Solution
Header not captured Increase snaplen in voipmonitor.conf (default may be too low)
Header truncated Increase custom_headers_max_size (default: 1024 bytes)
Not visible in distributed setup Check server_destination and server_password on sensor

Verify loaded headers: echo 'custom_headers_dump cdr' | nc localhost 5029

Load GeoIP Data

Loads GeoIP data for the CDR Map tab. See Order_of_GeoIP_processing for processing priority.

System Configuration

Basic

Setting Description
WEB URL Base URL for hyperlinks in emails
Sniffer data path PCAP storage directory (default: /var/spool/voipmonitor)
Sniffer second datapath Secondary spool directory (spooldir_2)
Default sensor hostname Default hostname for sniffer connection
Default sensor TCP port Default manager API port (5029)

⚠️ Warning: If sensors connect to wrong destination after upgrade, disable Default sensor hostname and Default sensor TCP port in this section. When enabled, sensors ignore individual Manager IP/Port settings.

Database

MySQL/MariaDB connection settings.

Custom port: Enter host with port in MySQL hostname field: 127.0.0.1:33306

Also configure mysqlport in /etc/voipmonitor.conf. See Database_troubleshooting for details.

National

Setting Description
Timezone GUI host timezone (for reports/alerts scheduling)
Sensors Timezone CDR display timezone - set this to fix UTC display issues
National prefix Prefixes for national call classification
International prefix International dialing prefix (e.g., 00, 011)
Local number Country name for number normalization

💡 Tip: If CDRs display in UTC instead of local time, set Sensors Timezone (not regular Timezone) to your sensors' timezone.

Intervals

Default time filters for CDR view, dashboard, and Legs correlation.

Email / HTTP Referer

Setting Description
DEFAULT_EMAIL_FROM Default "From" address for outgoing emails
Disable email plain text Force HTML-only emails


Troubleshooting Email Delivery

If users report not receiving verification emails or new user setup emails, verify the email sending status:

For Exim mail servers: 

# Check Exim mail log for delivery attempts
grep "recipient@example.com" /var/log/exim/main.log

# Or search by timestamp
grep "2025-01-09 14:30:" /var/log/exim/main.log

Look for the response code in the log entry:

  • 250 message accepted - Email was successfully delivered to remote server. The issue is on the recipient side (spam folder, quarantine, mail filtering).
  • No 250 code - Email delivery failed at the server level. Check mail queue and server MTA configuration.

If logs confirm successful delivery: Inform the client that the email left the server successfully and advise them to check their Spam, Bulk, or Junk folders, or consult their internal IT team regarding mail filtering policies.

General MTA verification: 

# Check if mail agent is running
systemctl status postfix     # or exim4, sendmail

# Test email from command line
echo "Test message" | mail -s "VoIPmonitor Test" your@email.com

# Check mail queue
mailq

# View general mail logs
tail -f /var/log/mail.log     # Debian/Ubuntu
tail -f /var/log/maillog      # RHEL/CentOS

License

Setting Description
License token Short token for retrieving license from portal
License key Full license key content (multi-line)
License email Email for license notifications (leave empty to disable)

Update license after payment: Click get/update license key button.

Manual activation: Copy full license key from portal (Services > My services) and paste into License key field.

Disable notification emails: Remove email from "License email" field.

GeoIP

Configure API keys for MaxMind or IPInfoDB services.

Advanced

Setting Description
ENABLE_CSRF_CHECK Enable CSRF protection (recommended for production)
Pcap deduplication before download Remove duplicate packets from PCAP downloads
Http proxy (for upgrades) Proxy for GUI/sniffer upgrades: http://proxy:port
Enable GUI to run in iframe Allow embedding in iframes (disabled by default for security)
CDR share key Secret for CDR share URLs

Firewall requirements: Allow outbound HTTPS to:

  • voipmonitor.org - License updates
  • download.voipmonitor.org - Software upgrades
  • share.voipmonitor.org - CDR sharing
  • reports.voipmonitor.org - Debug reports

Localization

Create GUI translations. Red numbers indicate untranslated items. Changes apply after logout/login.

CDR View Custom URL

Add custom hyperlinks to CDR Commands column. Use {{paramName}} in URL to include CDR values.

Troubleshooting

Sensors Connect to Wrong Destination After Upgrade

Cause: Default sensor hostname/port settings override individual sensor configurations.

Fix: Disable Default sensor hostname and Default sensor TCP port in Settings > System Configuration > Basic.

GUI Crashes on Settings > Sensors Page

Cause: Too many obsolete sensor records in database.

Fix: Delete obsolete records directly: 

-- Check count
SELECT COUNT(*) FROM sensors;
-- Delete obsolete entries (adjust WHERE clause)
DELETE FROM sensors WHERE host LIKE '%old-sensor%';

All users must log out and back in after cleanup.

License Update Fails

Cause: Firewall blocking outbound HTTPS.

Fix: Allow outbound TCP 443 to voipmonitor.org, or configure HTTP proxy in Advanced settings, or use offline activation.

GUI Not Loading in iframe

Fix: Enable Enable GUI to run in iframe in Advanced settings.

PCAP Download Has Fewer Packets Than GUI Shows

Cause: Pcap deduplication is enabled (removes retransmissions).

Fix: Disable Pcap deduplication before download in Advanced settings.

See Also

Retrieved from "https://www.voipmonitor.org/doc/index.php?title=Settings&oldid=10759"