Tools: Difference between revisions

From VoIPmonitor.org
(Add Generate Debug Log feature documentation)
(Rewrite: konsolidace a vylepšení struktury - zjednodušení IP lookup sekce, přidání tabulek, See Also)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
= Tools =
Diagnostic and utility tools available in the VoIPmonitor GUI ('''GUI > Tools''').
== MTR ==
== MTR ==


MTR traces from VoIPmonitor WEB server to selected IP using Linux mtr tool (10 seconds, 10 packets).
Network path tracing from VoIPmonitor web server to a selected IP address using the Linux <code>mtr</code> tool.
 
* '''Duration:''' 10 seconds
* '''Packets:''' 10


[[File:tools-mtr.png]]
[[File:tools-mtr.png]]
Line 7: Line 14:
== IP Lookup ==
== IP Lookup ==


IP lookup table substitutes IPs in places like CDR view, taking precedence over DNS. Enable via "database IP reverse lookup" in [[Settings]] > System Configuration.
Substitutes IP addresses with custom hostnames in CDR views and other displays. Takes precedence over DNS lookups.
 
'''Enable:''' Settings > System Configuration > "database IP reverse lookup"
 
{| class="wikitable"
! Mask !! Scope !! Example
|-
| /32 || Single IP only || 192.168.1.100/32 applies to only 192.168.1.100
|-
| /24 || Entire subnet (256 IPs) || 192.168.1.0/24 applies to 192.168.1.0 - 192.168.1.255
|}
 
{{Note|1=If the same hostname appears for multiple IPs, the entry likely uses a subnet mask (e.g., /24). Change to '''/32''' for per-IP hostnames.}}


[[File:tools-iplookup.png]]
[[File:tools-iplookup.png]]
Line 13: Line 32:
== Prefix Lookup ==
== Prefix Lookup ==


Prefix lookup table substitutes numbers in places like CDR view, taking precedence over IP lookup/DNS. Enable by setting ENABLE_SQL_CUSTOMER_PREFIX_LOOKUP to true in config/configuration.php.
Substitutes phone numbers with custom labels in CDR views. Takes precedence over IP lookup and DNS.
 
'''Enable:''' Set <code>ENABLE_SQL_CUSTOMER_PREFIX_LOOKUP = true</code> in <code>config/configuration.php</code>


[[File:tools-prefixlookup.png]]
[[File:tools-prefixlookup.png]]
Line 19: Line 40:
== Load PCAP ==
== Load PCAP ==


Upload PCAP files (libpcap format: tcpdump, tshark, Wireshark, voipmonitor). Processed by:
Upload and process PCAP files (libpcap format from tcpdump, tshark, Wireshark) to create CDRs.


voipmonitor --config-file /etc/voipmonitor.conf -r upload.pcap
<syntaxhighlight lang="bash">
voipmonitor --config-file /etc/voipmonitor.conf -r upload.pcap
</syntaxhighlight>


Change conf path in Settings > System Configuration > Upload sniffer conf path.
'''Config path:''' Settings > System Configuration > "Upload sniffer conf path"


=== Pre-Deployment Verification ===
{{Tip|Use this feature for '''pre-deployment verification''' - upload sample traffic (VoLTE, WebRTC, etc.) to confirm VoIPmonitor can parse the protocol before deploying live mirroring.}}
 
This feature is commonly used to verify whether VoIPmonitor can monitor and parse specific types of traffic before full deployment. For example, to test VoLTE, WebRTC, or custom protocol implementations:
 
1. Obtain a sample PCAP file containing the traffic type you want to monitor (VoLTE test call, WebRTC session, etc.)
2. Log in to the VoIPmonitor GUI and navigate to Tools > Load PCAP
3. Upload the PCAP file
4. Check if CDRs (Call Detail Records) are created in the CDR view
 
If CDRs are successfully created from the uploaded PCAP, this confirms that VoIPmonitor can parse and monitor that specific traffic type. This is the recommended way to verify protocol compatibility without setting up live network mirroring.


== Batch Download CDR WAV ==
== Batch Download CDR WAV ==


Download WAVs in batch via CSV upload.
Download multiple audio recordings via CSV upload.


[[File:tools-batchwav.png]]
[[File:tools-batchwav.png]]


Example CSV:
'''CSV columns:'''
{| class="wikitable"
! Column !! Description
|-
| Telephone || Caller or Called number
|-
| Lead Number || Record identifier (exported with audio/PCAP)
|-
| Start Time || CDR timestamp (second pass uses +/-5 min if no exact match)
|}


[[File:tools-batchwav-examplecsv.png]]
[[File:tools-batchwav-examplecsv.png]]
'''Details:'''
* Telephone: Caller or Called number.
* Lead Number: Identifies record in CSV log (exported with audio/PCAP).
* Start Time: Locates CDR; second pass uses +-5 minutes if not exact.


== Generate Debug Log ==
== Generate Debug Log ==


Generate a comprehensive debug report for troubleshooting issues with VoIPmonitor support. This feature collects system information, configuration files, and diagnostic logs into a single package.
Creates a comprehensive diagnostic package for VoIPmonitor support escalation.


**How to Generate a Debug Log:**
'''Contents:'''
* System info (OS, kernel, CPU, RAM)
* VoIPmonitor configuration
* Performance logs and errors
* Sensor status and capture stats
* Network/storage info


1. Navigate to '''GUI > Tools > Generate debug log'''
'''How to use:'''
2. Enter your email address where you want to receive the debug log link
# Navigate to '''Tools > Generate debug log'''
3. Click '''Generate'''
# Enter your email address
4. The system will process and upload the debug report
# Click '''Generate'''
5. A download link will be sent to your email address
# Share the received link with support
6. Share this link with VoIPmonitor support for analysis


**What the Debug Report Contains:**
{{Warning|Use after initial troubleshooting fails. First check [[Settings#Sensor_Health_Monitoring_with_RRD_Charts|Sensor RRD Charts]] and logs.}}


* System information (OS version, kernel, CPU, memory)
[[File:tools-generatedebuglog.png]]
* VoIPmonitor configuration files (voipmonitor.conf)
* Performance logs and recent error messages
* Sensor status and capture statistics
* Network and storage information
* Database connection status


**When to Use Generate Debug Log:**
== Concurrent Calls Stats ==


After performing initial diagnostics and you need to escalate to VoIPmonitor support:
Displays maximum concurrent connected calls for the last 14 days, averaged over 60-minute windows.


* You have identified a sensor issue (e.g., via Settings > Sensor RRD charts) but cannot resolve it independently
* '''Licensing:''' Counts all CDR legs (100 calls with 2 legs = 200 counted)
* System shows recurring errors like "packetbuffer: MEMORY IS FULL" that persist after configuration changes
* '''Exceeded limit:''' Sniffer continues, but GUI warns/blocks after 14 days
* You need detailed root cause analysis from VoIPmonitor developers
* Diagnostics indicate a potential bug or unexpected behavior


**Workflow Example: Troubleshooting "packetbuffer: MEMORY IS FULL" with Bad MOS**
For license details, see [[License]].


1. Use Settings > Sensor RRD charts to confirm buffer usage pattern ([[Settings#Sensor_Health_Monitoring_with_RRD_Charts|Settings: Sensor RRD Charts]])
[[File:tools-concurrentcallsstat.png]]
2. Adjust the '''From''' date to compare buffer usage before and after the issue started
3. Correlate buffer usage spikes with the timing of errors and bad MOS scores
4. Check kernel messages for storage errors (dmesg -T)
5. If unable to resolve, navigate to '''Tools > Generate debug log'''
6. Enter your email and generate the report
7. Share the provided link with VoIPmonitor support
 
[[File:tools-generatedebuglog.png]]


== Concurrent Calls Stats ==
== See Also ==


Shows max concurrent calls (connected) stats for last 14 days, averaged over 60-minute windows: Max average from minute-by-minute counts.
* [[Settings]] - System configuration and sensor management
* [[License]] - Channel licensing and limits
* [[GUI_troubleshooting]] - GUI debug mode and troubleshooting


Applies to GUI licensing. Counts all CDR legs (e.g., 100 calls with 2 legs = 200). License needed for actual calls (e.g., 100).
== AI Summary for RAG ==
 
If over license, sniffer continues but GUI warns/blocks in 14 days; contact support.
 
[[File:tools-concurrentcallsstat.png]]


=== AI Summary for RAG ===
'''Summary:''' VoIPmonitor GUI tools documentation covering: MTR (network path tracing from web server), IP Lookup (IP-to-hostname substitution with CIDR masks - /32 for single IP, /24 for subnet), Prefix Lookup (phone number substitution), Load PCAP (upload PCAP files for CDR creation and pre-deployment protocol verification), Batch Download WAV (bulk audio export via CSV), Generate Debug Log (diagnostic package for support), and Concurrent Calls Stats (license monitoring showing max concurrent calls over 14 days).


'''Summary:''' This article describes VoIPmonitor tools: MTR tracing, IP/prefix lookups (with enabling), PCAP upload/processing for pre-deployment verification, batch WAV downloads via CSV, concurrent calls stats for licensing, and GENERATE DEBUG LOG (creates comprehensive debug report for troubleshooting with VoIPmonitor support - navigate to GUI > Tools > Generate debug log, enter email, click Generate - includes system information, configuration files, performance logs, sensor status. Use after performing initial diagnostics like sensor RRD charts but before escalating to support. Workflow example for packetbuffer: MEMORY IS FULL with bad MOS: use Settings > Sensor RRD charts, adjust From date to compare buffer usage before/after issue started, check kernel messages (dmesg -T), then navigate to Tools > Generate debug log, enter email, generate report, and share link with support).
'''Keywords:''' tools, MTR, IP lookup, network mask, CIDR, /32, /24, hostname substitution, prefix lookup, PCAP upload, pre-deployment verification, batch WAV download, generate debug log, concurrent calls stats, license monitoring, VoLTE, WebRTC


'''Keywords:''' MTR, IP lookup, prefix lookup, PCAP upload, pre-deployment verification, batch WAV, concurrent calls, generate debug log, debug report, troubleshoot with support, debug package, system information, configuration files, performance logs, sensor status, escalate to support
'''Key Questions:'''
'''Key Questions:'''
* What is MTR in VoIPmonitor?
* What diagnostic tools are available in VoIPmonitor GUI?
* How to enable IP lookup?
* How do I trace network path from VoIPmonitor server?
* How to enable prefix lookup?
* How do I substitute IP addresses with hostnames in CDR view?
* How to upload and process PCAP files?
* Why does the same hostname appear for multiple IPs?
* How to verify if VoIPmonitor can monitor specific traffic types (VoLTE, WebRTC)?
* How do network masks (/32 vs /24) work in IP lookup?
* How does batch CDR WAV download work?
* How do I enable prefix lookup for phone numbers?
* What are concurrent calls stats and their licensing impact?
* How do I upload PCAP files to VoIPmonitor?
* How can I verify if VoIPmonitor supports a specific protocol before deployment?
* How do I download multiple audio files at once?
* How do I generate a debug log for VoIPmonitor support?
* How do I check concurrent call statistics for licensing?

Latest revision as of 16:47, 8 January 2026

Tools

Diagnostic and utility tools available in the VoIPmonitor GUI (GUI > Tools).

MTR

Network path tracing from VoIPmonitor web server to a selected IP address using the Linux mtr tool.

  • Duration: 10 seconds
  • Packets: 10

IP Lookup

Substitutes IP addresses with custom hostnames in CDR views and other displays. Takes precedence over DNS lookups.

Enable: Settings > System Configuration > "database IP reverse lookup"

Mask Scope Example
/32 Single IP only 192.168.1.100/32 applies to only 192.168.1.100
/24 Entire subnet (256 IPs) 192.168.1.0/24 applies to 192.168.1.0 - 192.168.1.255

ℹ️ Note: If the same hostname appears for multiple IPs, the entry likely uses a subnet mask (e.g., /24). Change to /32 for per-IP hostnames.

Prefix Lookup

Substitutes phone numbers with custom labels in CDR views. Takes precedence over IP lookup and DNS.

Enable: Set ENABLE_SQL_CUSTOMER_PREFIX_LOOKUP = true in config/configuration.php

Load PCAP

Upload and process PCAP files (libpcap format from tcpdump, tshark, Wireshark) to create CDRs. 

voipmonitor --config-file /etc/voipmonitor.conf -r upload.pcap

Config path: Settings > System Configuration > "Upload sniffer conf path"

💡 Tip: Use this feature for pre-deployment verification - upload sample traffic (VoLTE, WebRTC, etc.) to confirm VoIPmonitor can parse the protocol before deploying live mirroring.

Batch Download CDR WAV

Download multiple audio recordings via CSV upload.

CSV columns:

Column Description
Telephone Caller or Called number
Lead Number Record identifier (exported with audio/PCAP)
Start Time CDR timestamp (second pass uses +/-5 min if no exact match)

Generate Debug Log

Creates a comprehensive diagnostic package for VoIPmonitor support escalation.

Contents:

  • System info (OS, kernel, CPU, RAM)
  • VoIPmonitor configuration
  • Performance logs and errors
  • Sensor status and capture stats
  • Network/storage info

How to use:

  1. Navigate to Tools > Generate debug log
  2. Enter your email address
  3. Click Generate
  4. Share the received link with support

⚠️ Warning: Use after initial troubleshooting fails. First check Sensor RRD Charts and logs.

File:Tools-generatedebuglog.png

Concurrent Calls Stats

Displays maximum concurrent connected calls for the last 14 days, averaged over 60-minute windows.

  • Licensing: Counts all CDR legs (100 calls with 2 legs = 200 counted)
  • Exceeded limit: Sniffer continues, but GUI warns/blocks after 14 days

For license details, see License.

See Also

AI Summary for RAG

Summary: VoIPmonitor GUI tools documentation covering: MTR (network path tracing from web server), IP Lookup (IP-to-hostname substitution with CIDR masks - /32 for single IP, /24 for subnet), Prefix Lookup (phone number substitution), Load PCAP (upload PCAP files for CDR creation and pre-deployment protocol verification), Batch Download WAV (bulk audio export via CSV), Generate Debug Log (diagnostic package for support), and Concurrent Calls Stats (license monitoring showing max concurrent calls over 14 days).

Keywords: tools, MTR, IP lookup, network mask, CIDR, /32, /24, hostname substitution, prefix lookup, PCAP upload, pre-deployment verification, batch WAV download, generate debug log, concurrent calls stats, license monitoring, VoLTE, WebRTC

Key Questions:

  • What diagnostic tools are available in VoIPmonitor GUI?
  • How do I trace network path from VoIPmonitor server?
  • How do I substitute IP addresses with hostnames in CDR view?
  • Why does the same hostname appear for multiple IPs?
  • How do network masks (/32 vs /24) work in IP lookup?
  • How do I enable prefix lookup for phone numbers?
  • How do I upload PCAP files to VoIPmonitor?
  • How can I verify if VoIPmonitor supports a specific protocol before deployment?
  • How do I download multiple audio files at once?
  • How do I generate a debug log for VoIPmonitor support?
  • How do I check concurrent call statistics for licensing?
Retrieved from "https://www.voipmonitor.org/doc/index.php?title=Tools&oldid=10018"