Internal support hints: Difference between revisions

From VoIPmonitor.org
(Add IPFIX PCAP download behavior - RTP not included, SIP is reconstructed)
 
(74 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Administration]]
{{DISPLAYTITLE:Internal Support Hints}}


==Important note: ==
{{Warning|1=This documentation is for the internal support team. Use at your own risk and test on non-production servers first.}}
Following articles are designed to be used by internal support team. You can find hints usauseful but please use it at your own risk (use on testing servers first)


= Testing configure options =
= Quick Reference =
If you need to test configure options without need to modify the config file or database settings, you can use json_config option:
--json_config='[{"id_sensor":"11"},{"interface":"lo"},{"natalias","8.8.8.8 10.10.100.50;9.9.9.9 192.168.88.33"}]'
(The otpions defined using '''json_config''' command line option will overrides the configfile and database settings)


== Examples ==
<kroki lang="mermaid">
This will override options '''rtpip_find_endpoints,rrd,natalias''' no matter what is set in config file.
%%{init: {'flowchart': {'nodeSpacing': 10, 'rankSpacing': 25}}}%%
./voipmonitor --config-file=config/voipmonitor.conf -p XobmuJ -b voipmonitor_ipv6 -k -v1,pcap_stat_period=5,hash_rtp,rtp_streams -rpba:/totest/test.pcap --json_config='[{"rtpip_find_endpoints","yes"},{"rrd","no"},{"natalias","8.8.8.8 10.10.100.50;9.9.9.9 192.168.88.33"}]'
flowchart LR
    subgraph Test["Testing"]
        A[json_config] --> B[Regexp/Country]
        B --> C[Billing]
    end
    subgraph Debug["Debugging"]
        D[Jemalloc] --> E[Threads]
        E --> F[Charts crash]
    end
    subgraph Tools["Tools"]
        G[PCAP replay] --> H[Manager API]
        H --> I[Scripts]
    end
</kroki>


= Testing regexp / country rules / billing =
= Testing Configuration =
== Regexp test ==
/usr/local/sbin/voipmonitor --config-file=/etc/voipmonitor-test.conf -k -v1 --test-regexp '^800880080[1-9][0-9][*]|80088008012345|'


== Country assignment test ==
== Override Settings with json_config ==
/usr/local/sbin/voipmonitor --config-file=/etc/voipmonitor-test.conf -k -v1 --find-country-for-ip=102.140.68.113
/usr/local/sbin/voipmonitor --config-file=/etc/voipmonitor-test.conf -k -v1 --find-country-for-number 0034*12345


== pricing / billing test ==
Override config file and database settings without editing files:
voipmonitor --config-file=config/voipmonitor.conf -k -v1 --test-billing test_data/billing


=== Example of test_data/billing file===
<syntaxhighlight lang="bash">
Columns order
voipmonitor --config-file=/etc/voipmonitor.conf -k -v1 \
  - calldate
   --json_config='[{"id_sensor":"11"},{"interface":"lo"},{"natalias":"8.8.8.8 10.10.100.50"}]'
  - connect_duration
</syntaxhighlight>
  - caller
  - called
  - sipcallerip
  - sipcalledip
   - expected price operator - (voluntary option)
  - expected price customer - (voluntary option)


2018-05-09 12:00,120,+4121353333,+41792826527,192.168.101.10,192.168.101.151,800,8
{{Tip|Useful for quick testing of specific parameters. Options in json_config take precedence over config file and DB settings.}}
2018-05-09 12:00,120,+4121353333,+41792826527,192.168.101.10,192.168.101.151,800,8.1
2018-05-09 12:00,120,+4121353333,+41792826527,192.168.101.10,192.168.101.151


= License Hints =
== Regexp / Country / Billing Tests ==
== Write state to db (count of cc cchannels for license purposse) ==
php /var/www/html/php/run.php saveCallStatistics


== License Details ==
{| class="wikitable"
=== detail on channels count usage ===
! Test Type !! Command
php /var/www/html/php/run.php checkLicense -v
|-
php /var/www/html/php/run.php checkLicense -v 2
| Regexp pattern || <code>voipmonitor --config-file=/etc/voipmonitor.conf -k -v1 --test-regexp '^800...[1-9][0-9]'</code>
|-
| Country by IP || <code>voipmonitor --config-file=/etc/voipmonitor.conf -k -v1 --find-country-for-ip=102.140.68.113</code>
|-
| Country by number || <code>voipmonitor --config-file=/etc/voipmonitor.conf -k -v1 --find-country-for-number 0034*12345</code>
|-
| Billing test || <code>voipmonitor --config-file=/etc/voipmonitor.conf -k -v1 --test-billing test_data/billing</code>
|}


=== license file ===
'''Billing test file format''' (CSV):
cat /var/www/html/key.php
<syntaxhighlight lang="text">
# calldate,connect_duration,caller,called,sipcallerip,sipcalledip,[exp_price_op],[exp_price_cust]
2018-05-09 12:00,120,+4121353333,+41792826527,192.168.101.10,192.168.101.151,800,8
</syntaxhighlight>


=== Get current license token from db ===
= License Management =
mysql> select content from voipmonitor.system where type='license token';


= SCRIPTs for better run control =
{| class="wikitable"
== ALERTS ==
! Task !! Command
When alerts taking longer time to process then interval is schedulled it can cause out of memory or high load to CPU after some time because same alert is processed multipletimes for various time ranges. Following script allows manual run of disabled alert in GUI via crontab - its benefit is that it will run multiple alerts at same time unlike normal run where is processed one alert by one.
|-
| Write channel stats to DB || <code>php /var/www/html/php/run.php saveCallStatistics</code>
|-
| Check license details || <code>php /var/www/html/php/run.php checkLicense -v</code>
|-
| Check max peak only || <code>php /var/www/html/php/run.php checkLicense -v <nowiki>|</nowiki> grep max_peak -A3 -B1</code>
|-
| Get token from DB || <code>SELECT content FROM voipmonitor.system WHERE type='license token';</code>
|-
| View license file || <code>cat /var/www/html/key.php</code>
|}


Follow this link [[script-for-multi-Instances-alerts-processing]]
'''Auto-update license via cron''' (without processing alerts/reports):


== Batch download for more then 1000CDRs ==
<syntaxhighlight lang="bash">
When you need to download lot of audio files - you use GUI->menu->cdr batch download,but it allows only 1000calls to process with one GUI's query.
04 04 * * * root php /var/www/html/php/run.php runUpdateLicenseKey
</syntaxhighlight>


Following script allows you to create audio from longer set of CDRs, also it process in multiple instances to get audio faster (beware of HDD IO/CPU) [[script-for-big-batchdownloads]]
= Utility Scripts =


== RAM (alerts / dashboards cache) ==
{| class="wikitable"
When there is lot of CDRs then alerts or caching of dashboard data can take lot of RAM, folloowing script will control if some php thread will not consume over limit, when it does, its oom_adj_score is set to be killed first (prevent killing of voipmonitor sniffer od db when running on same server)
! Script !! Purpose !! Details
|-
| Parallel alerts || Process alerts faster || Enable in '''Settings → System Configuration → Advanced → Number of parallel tasks'''
|-
| [[script-for-big-batchdownloads|Batch download]] || Download >1000 audio files || Bypasses GUI limit of 1000 CDRs
|-
| [[script-for-GUI-cron-control-oom|RAM control]] || Prevent OOM killer || Sets <code>oom_adj_score</code> for PHP threads
|-
| [[script-for-probes-backup|Probe backup]] || Backup all probe configs || Requires SSH access without password
|}


Follow link [[script-for-GUI-cron-control-oom]]
= Debugging =


= voipmonitor sniffer memory leaks detect and debug =
== Charts Binary Crash ==
When voipmonitor uses more and more RAM (RSS/VSZ stat in syslog) without processing more CALLs (regs/messages) following steps can tell you where the RAM ends (it can be leak or some thread overload)
== compile je_malloc ==
Download jemalloc from https://github.com/jemalloc/jemalloc
./autogen.sh (requieres development tools Deb/ubu apt install build-essential, centos/rh yum groupinstall 'Development Tools')
./configure --enable-prof
make
make install


== enable jemalloc for voipmonitor and compile it ==
When dmesg or Apache log shows charts crash:
./configure
<syntaxhighlight lang="text">
edit config.h,to have there
charts-x86_64[7321]: segfault at 10 ip 0000000000412553...
#define HAVE_LIBTCMALLOC 0
</syntaxhighlight>
#define HAVE_LIBJEMALLOC 1
edit Makefile and disable optimization and add ljemalloc to libs
substitute there -O2 with -O0 (It is capital o followed by zero)
LIBS = ${SHARED_LIBS} -ljemalloc


Finish compilation
'''Debug procedure:'''
make clean
<syntaxhighlight lang="bash">
make -j8
# Create debug folder
mkdir /tmp/vm_charts_parameters


== enable X88 compatible sources and recompile ==
# After GUI creates charts, test with saved arguments
Copy sniffer sources with compiled binary to new location and recreate binary with -X88 (This is necessary to get correct memory allocation for debuging usin jeprof)
/var/www/html/bin/charts-x86_64 -i /tmp/vm_charts_parameters/files
cp -a /usr/src/voipmonitor-git /usr/src/sniffer-git-jemalloc-X88
</syntaxhighlight>
LD_PRELOAD=/usr/local/lib/libjemalloc.so ./voipmonitor -k -v1 -c -X88
#It will list of source files modification,then re-make
make clean
make


== Modify init file or run sniffer manually with extra env arguments and parameters ==
== Memory Leak Detection (Jemalloc) ==
=== edit /etc/init.d/voipmonitor ===
ARGS="-v 1,force_log_sqlq,memory_stat,memory_stat_ignore_limit=100000"
#and in start section (2places) of a script
LD_PRELOAD=/usr/local/lib/libjemalloc.so MALLOC_CONF='prof:true' /usr/src/sniffer-git-jemalloc-X88/voipmonitor --config-file $CONFIGFILE --pid-file $PIDFILE $ARGS


=== or run it from konsole / when sniffer service stopped ===
=== Compile Jemalloc ===
LD_PRELOAD=/usr/local/lib/libjemalloc.so MALLOC_CONF='prof:true' /usr/src/sniffer-git-jemalloc-X88/voipmonitor --config-file=/etc/voipmonitor.conf -v 1,force_log_sqlq,memory_stat_ex,memory_stat_ignore_limit=100000,heapsafe


== Check results ==
<syntaxhighlight lang="bash">
in some interval you should check the results of memory usage with
# Download from https://github.com/jemalloc/jemalloc
=== je_prof.pdf ===
./autogen.sh
yum install graphviz ghostscript
./configure --enable-prof
echo 'jemalloc_stat_full' | nc 127.0.0.1 5029 > /tmp/je_prof; jeprof --show_bytes --pdf /usr/src/sniffer-git-jemalloc-X88/voipmonitor /tmp/je_prof > je_prof.pdf
make && make install
</syntaxhighlight>


=== sniffer_memory.txt ===
=== Compile VoIPmonitor with Jemalloc ===
echo 'jemalloc_stat_full' | nc 127.0.0.1 5029


=== script for periodical collecting ===
Edit <code>config.h</code>:
<syntaxhighlight lang="c">
#define HAVE_LIBTCMALLOC 0
#define HAVE_LIBJEMALLOC 1
</syntaxhighlight>


#!/bin/bash
Edit <code>Makefile</code>:
DATE=`date '+%Y%m%d_%H:%M:%S'`
<syntaxhighlight lang="makefile">
LOGDIR=/root/vm_debug/log/$DATE
# Change -O2 to -O0 (disable optimization)
mkdir -p $LOGDIR
LIBS = ${SHARED_LIBS} -ljemalloc
pdftmpname=/tmp/je_prof
</syntaxhighlight>
pdfname=$LOGDIR/je_prof.pdf
txtname=$LOGDIR/mem_stat.txt
senname=$LOGDIR/senlog.txt
echo 'jemalloc_stat_full' | nc 127.0.0.1 5029 > $pdftmpname 2>&1
/usr/local/bin/jeprof --show_bytes --pdf /usr/src/sniffer-git-jemalloc-X88/voipmonitor $pdftmpname > $pdfname 2>&1
echo memory_stat | nc 127.0.0.1 5029 > $txtname 2>&1
echo sniffer_stats | nc 127.0.0.1 5029 > $senname 2>&1
rm $pdftmpname


= voipmonitor sniffer compile notes ss7 (wireshark) module =
<syntaxhighlight lang="bash">
(requires ws version 3.2):
make clean && make -j8
</syntaxhighlight>


== modify config.h ==
=== Run with Jemalloc ===
#define HAVE_LIBWIRESHARK 1
#define LIBWIRESHARK_VERSION 30200


== modify Makefile's INCLUDE ==
Modify <code>/etc/init.d/voipmonitor</code> start section:
-I/usr/include/wireshark
<syntaxhighlight lang="bash">
== modify Makefile's SHARED_LIBS==
LD_PRELOAD=/usr/local/lib/libjemalloc.so MALLOC_CONF='prof:true' /usr/local/src/voipmonitor --config-file $CONFIGFILE --pid-file $PIDFILE $ARGS
-lwiretap -lwireshark -lwsutil
</syntaxhighlight>


internal build in JIRA:/opt/debian-7-64bit
=== Generate Memory Report ===
== disable optimize in Makefile==
change -O2 to -O0


== compile ==
<syntaxhighlight lang="bash">
  ./configure && make clean && make ss7
# Install dependencies
apt install graphviz ghostscript # or: yum install graphviz ghostscript


= testing customer pcaps =
# Generate PDF report
== testing via basic upload aka GUI upload ==
echo 'jemalloc_stat_full' | nc 127.0.0.1 5029 > /tmp/je_prof
voipmonitor --config-file=/etc/voipmonitor-customer.conf -r /tmp/file.pcap
jeprof --show_bytes --pdf /usr/local/src/sniffer/voipmonitor /tmp/je_prof > je_prof.pdf
== testing via packetbuffer upload ==
</syntaxhighlight>
=== time shift to now, increased speed of replaying ===
voipmonitor --config-file=/etc/voipmonitor-customer.conf -rpbsa9: /tmp/file.pcap
=== no time shift via pb===
voipmonitor --config-file=/etc/voipmonitor-customer.conf -rpb: /tmp/file.pcap
=== tcpreplay to running service ===
you need to enable additional argument when starting the service in /etc/init.d/voipmonitor
ARGS="-v 1,dump_call_flags,tcpreplay"
then use tcpreplay
tcpreplay -i eth0 /tmp/l/x.pcap
when error appears like
sending out eth0
processing file: /tmp/l/x.pcap
Warning in tcpreplay.c:replay_file() line 227:
/tmp/l/x.pcap DLT (LINUX_SLL) does not match that of the outbound interface: eth0 (EN10MB)
probably captured on any interface and layer2 missing, here follow stpes on how to add it:


==== adding layer2 to pcap ====
=== X88 Mode (Detailed Memory Debug) ===
after capture was done on any interface and you need to replay it to hw interface you need to add layer2 (at least in 3.4.3 v.tcpreplay)
tcprewrite --dlt=enet -i /tmp/l/x.pcap -o /tmp/l/x_enet-encaps.pcap
tcprewrite --enet-dmac=00:55:22:AF:C6:37 --enet-smac=00:44:66:FC:29:AF --infile=/tmp/l/x_enet-encaps.pcap --outfile=/tmp/l/x_enet-encaps-l2.pcap


==== rewrite IPv4 address in whole pcap ====
For more detailed memory allocation info:
when you need to test alert based on IP adresses (also country continent alert based on IPs) you can find usefull to change IP address in pcap and use it multiple times with various addresses:
<syntaxhighlight lang="bash">
tcprewrite --pnat=8.7.6.5/32:1.2.3.4/32 -i ./7efd0e8b87a54f48ac04b7a49fdf5669.pcap -o ./7e-rew.pcap
cp -a /usr/src/voipmonitor-git /usr/src/sniffer-git-jemalloc-X88
LD_PRELOAD=/usr/local/lib/libjemalloc.so ./voipmonitor -k -v1 -c -X88
make clean && make
</syntaxhighlight>


Run with extra verbose options:
<syntaxhighlight lang="bash">
LD_PRELOAD=/usr/local/lib/libjemalloc.so MALLOC_CONF='prof:true' ./voipmonitor \
  --config-file=/etc/voipmonitor.conf \
  -v 1,force_log_sqlq,memory_stat_ex,memory_stat_ignore_limit=100000,heapsafe
</syntaxhighlight>


= Rename mysql database =
See: [[X88-memoryConsumptionDebug]]
It's not possible to do it via direct command. You need to use '''RENAME TABLE''' command.
With this SELECT you generate the commands for the rename of the all tables in the database. (Replace OLD_DB_NAME and NEW_DB_NAME)


SELECT CONCAT('RENAME TABLE ',table_schema,'.',table_name,
== Thread Debugging ==
    ' TO ','NEW_DB_NAME.',table_name,';')
FROM information_schema.TABLES
WHERE table_schema LIKE 'OLD_DB_NAME';


The output:
{| class="wikitable"
! Method !! Usage
|-
| Log thread CPU || Add <code>-v1,threads_cpu_log</code> to command line
|-
| List threads || <code>echo 'sniffer_threads' | nc 127.0.0.1 5029</code>
|-
| Extended info || Set <code>sniffer_threads_ext=yes</code> in config (requires compile with <code>SNIFFER_THREADS_EXT true</code>)
|}


RENAME TABLE OLD_DB_NAME.table1 TO NEW_DB_NAME.table1;
'''sniffer_threads options:'''
RENAME TABLE OLD_DB_NAME.table2 TO NEW_DB_NAME.table2;
* <code>no_sort</code> - don't sort by load
RENAME TABLE OLD_DB_NAME.tableX TO NEW_DB_NAME.tableX;
* <code>only_traffic</code> - only threads with traffic
* <code>all</code> - include unloaded threads
* <code>line</code> - simple line output


Run these commands a you are ready.
== SS7 Module Compilation ==


'''Attention! Sometimes you can have a problem with moving of the foreign keys.'''
Requires Wireshark 3.2.


= disabling TCP sack =
Edit <code>config.h</code>:
On buggy kernels (all before 2019/03) following prevents SACK issue
<syntaxhighlight lang="c">
sideback is that on lossy lines (packet lost or big delays) the tcp traffic will increase)
#define HAVE_LIBWIRESHARK 1
echo "0" > /proc/sys/net/ipv4/tcp_sack
#define LIBWIRESHARK_VERSION 30200
</syntaxhighlight>


= MacOS high sierra in virtual box (on windows) =
Edit <code>Makefile</code>:
== Download Image ==
<syntaxhighlight lang="makefile">
from - https://drive.google.com/file/d/0B0EsZGPuNAPvVDlicGt1NUx0Y0E/view
INCLUDE += -I/usr/include/wireshark
== Prepare ISO for install ==
SHARED_LIBS += -lwiretap -lwireshark -lwsutil
===Create High Sierra DMG Disk Image===
# Change -O2 to -O0
hdiutil create -o /tmp/Highsierra -size 7900m -volname highsierra -layout SPUD -fs HFS+J
</syntaxhighlight>


=== Mount DMG Image to your macOS ===
<syntaxhighlight lang="bash">
hdiutil attach /tmp/Highsierra.dmg -noverify -mountpoint /Volumes/Highsierra
./configure && make clean && make ss7
</syntaxhighlight>


=== Create a High Sierra ISO image ===
= PCAP Testing =
sudo /Applications/Install\ macOS\ High\ Sierra.app/Contents/Resources/createinstallmedia --volume /Volumes/Highsierra


=== Unmount Disk Image ===
== Basic Methods ==
hdiutil detach /volumes/Install\ macOS\ High\ Sierra


=== Convert DMG to ISO ===
{| class="wikitable"
hdiutil convert /tmp/Highsierra.dmg -format UDTO -o ~/Desktop/Highsierra
! Method !! Command
|-
| Basic upload || <code>voipmonitor --config-file=/etc/voipmonitor.conf -r /tmp/file.pcap</code>
|-
| Via packetbuffer (fast) || <code>voipmonitor --config-file=/etc/voipmonitor.conf -rpbsa9: /tmp/file.pcap</code>
|-
| Via packetbuffer (original time) || <code>voipmonitor --config-file=/etc/voipmonitor.conf -rpb: /tmp/file.pcap</code>
|}


=== Rename and Move ISO Image to Desktop ===
== IPFIX Testing ==
mv ~/Desktop/Highsierra.cdr ~/Desktop/Highsierra.iso


== Create new virtual Image ==
'''Receiver instance:'''
during preconfigure of new image set:
<syntaxhighlight lang="ini">
memmory 3-6GB
ipfix = yes
disk size 100GB
ipfix_bind_ip = 0.0.0.0
then edit it's settings and additionally modify:
ipfix_bind_port = 12345
system -> Motherboard -> Chipset: PIIX3
</syntaxhighlight>
system -> Processor -> count (2), Enable PAE/NX
system -> Storage -> Attributes-> Optical drive->Sata port 1, for the newly created iso
display -> Video memory -> 128MB
display -> Graphics Controler -> VMSVGA


== Add the VirtualBox macOS Code to CMD ==
'''Sender instance:'''
cd "C:\Program Files\Oracle\VirtualBox\"
<syntaxhighlight lang="bash">
VBoxManage.exe modifyvm "Your VM Name" --cpuidset 00000001 000106e5 00100800 0098e3fd bfebfbff
voipmonitor --config-file=/etc/voipmonitor.conf -k -v1 \
VBoxManage setextradata "Your VM Name" "VBoxInternal/Devices/efi/0/Config/DmiSystemProduct" "iMac11,3"
  --ipfix-client-emulation='/tmp/ipfix.pcap;1.2.3.4;8.8.8.8;127.0.0.1;12345'
VBoxManage setextradata "Your VM Name" "VBoxInternal/Devices/efi/0/Config/DmiSystemVersion" "1.0"
# Parameters: pcap_file;client_ip;server_ip;dest_ip;dest_port
VBoxManage setextradata "Your VM Name" "VBoxInternal/Devices/efi/0/Config/DmiBoardProduct" "Iloveapple"
</syntaxhighlight>
VBoxManage setextradata "Your VM Name" "VBoxInternal/Devices/smc/0/Config/DeviceKey" "ourhardworkbythesewordsguardedpleasedontsteal(c)AppleComputerInc"
=== IPFIX PCAP Download Behavior ===
VBoxManage setextradata "Your VM Name" "VBoxInternal/Devices/smc/0/Config/GetKeyFromRealSMC" 1


== Install macOS on virtulBox ==
'''Key fact:''' IPFIX data is internally converted to packet format for processing. This means:
#Open VirtualBox and turn on your High Sierra, then Open "Disk Utility".
* '''PCAP files CAN be downloaded''' from the GUI for IPFIX-sourced calls
#Format VirtualBox Virtual Disk with "Mac OS Extended". (GUID:Partition map)
* SIP signaling is reconstructed from the IPFIX data
#Now, you can install macOS High Sierra on new virtual disk with your ISO Image.
* '''RTP streams are NOT included''' in the PCAP - only QoS metrics from IPFIX data are available, not actual audio packets
#After your installation is completed, turn off your macOS High Sierra. Open VirtualBox, and remove High Sierra.iso file.
#Turn on your Virtual Machine. At UEFI Shell screen, boot with this commands:


>"fs1:\macOS Install Data\Locked Files\Boot Files\boot.efi"
When downloading PCAP from IPFIX calls with TLS, TCP sequence numbers may be set to 0 causing Wireshark to display incorrectly. Disable TCP sequence analysis in Wireshark preferences to view all packets.
== Tcpreplay ==


Enable in <code>/etc/init.d/voipmonitor</code>:
<syntaxhighlight lang="bash">
ARGS="-v 1,dump_call_flags,tcpreplay"
</syntaxhighlight>


== Start the High Sierra Virtual machine and Enjoy ==
'''Add Layer 2 if missing''' (for captures done on "any" interface):
<syntaxhighlight lang="bash">
tcprewrite --dlt=enet -i /tmp/x.pcap -o /tmp/x_enet.pcap
tcprewrite --enet-dmac=00:55:22:AF:C6:37 --enet-smac=00:44:66:FC:29:AF \
  --infile=/tmp/x_enet.pcap --outfile=/tmp/x_l2.pcap
</syntaxhighlight>


= Measurement =
'''Rewrite IP addresses:'''
== Memory speed ==
<syntaxhighlight lang="bash">
tcprewrite --pnat=8.7.6.5/32:1.2.3.4/32 -i ./original.pcap -o ./rewritten.pcap
</syntaxhighlight>


sysbench memory --threads=2 run
== SSL/TLS Testing ==


* should be over 5000 MiB/sec
<syntaxhighlight lang="bash">
voipmonitor --config-file /etc/test.conf -k -v1,pcap_stat_period=1,_ssl,_tls,_ssldecode \
  -rpba:/tmp/keys.pcap@@/tmp/call.pcap \
  --json_config='[{"sipport":"8089"},{"ssl":"yes"},{"ssl_ipport":"192.168.0.1:8089"},{"ssl_sessionkey_udp":"yes"},{"ssl_sessionkey_udp_port":"1234"}]'
</syntaxhighlight>
 
For TLS details, see [[Tls]].
 
= Manager API =
 
'''For complete reference, see [[Manager_API]].'''
 
This section covers quick debug commands. For encryption setup and full command list, see the main article.
 
== Via Manager Port (5029) ==
 
<syntaxhighlight lang="bash">
# These require encryption disabled OR use socket file
echo 'listcalls' | nc 127.0.0.1 5029
echo 'sniffer_stat' | nc 127.0.0.1 5029
echo 'jemalloc_stat_full' | nc 127.0.0.1 5029
echo 'sniffer_threads' | nc 127.0.0.1 5029
</syntaxhighlight>
 
{{Tip|For encrypted communication, use the GUI's <code>run.php send_manager_cmd</code> or Unix socket. See [[Manager_API#Usage Examples]].}}
 
== Via Server Port (60024) ==
 
Used in distributed deployments for probe management:
 
<syntaxhighlight lang="bash">
# List connected clients
echo '{"type_connection":"manager_command","command":"active"}' | nc 127.0.0.1 60024
 
# Send command to specific probe
echo '{"type_connection":"gui_command","sensor_id":1011,"command":"terminating"}' | nc 127.0.0.1 60024
</syntaxhighlight>
 
= GUI Workarounds =
 
== Disable Sensor Logs Popup ==
 
{{Note|There is no built-in GUI option to disable the sensor logs popup shown at admin login.}}
 
'''Option 1: Periodic SQL update'''
<syntaxhighlight lang="sql">
UPDATE voipmonitor.log_sensor SET confirmed = 1;
</syntaxhighlight>
 
'''Option 2: Database trigger (permanent)'''
<syntaxhighlight lang="sql">
DELIMITER $$
CREATE TRIGGER before_insert_log_sensor
BEFORE INSERT ON log_sensor
FOR EACH ROW
BEGIN
    SET NEW.confirmed = 1;
END$$
DELIMITER ;
</syntaxhighlight>
 
== IonCube Crash Fix (Ubuntu 22.04 + PHP 7.4) ==
 
'''Symptom:''' ldap.so crash at login page (CVE-2024-8932).
 
'''Fix:'''
<syntaxhighlight lang="bash">
# Backup
cd /usr/lib/php/20190902 && mkdir BKUP && cp -pv ldap.so* BKUP
 
# Download and extract fixed package
wget https://pl.archive.ubuntu.com/ubuntu/pool/main/p/php7.4/php7.4-ldap_7.4.3-4ubuntu2.24_amd64.deb
ar x php7.4-ldap_7.4.3-4ubuntu2.24_amd64.deb
 
# Install and restart
cp -v ./usr/lib/php/20190902/ldap.so /usr/lib/php/20190902/ldap.so
systemctl restart apache2
</syntaxhighlight>
 
= Database Operations =
 
== Rename MySQL Database ==
 
Generate RENAME TABLE commands:
<syntaxhighlight lang="sql">
SELECT CONCAT('RENAME TABLE ',table_schema,'.',table_name,' TO NEW_DB.',table_name,';')
FROM information_schema.TABLES
WHERE table_schema LIKE 'OLD_DB';
</syntaxhighlight>
 
{{Warning|1=Foreign keys may cause issues during rename.}}
 
== Spooldir Testing ==
 
<syntaxhighlight lang="bash">
voipmonitor --config-file /etc/voipmonitor.conf -k -v1 --test-cleanspool-load all
</syntaxhighlight>
 
= Remote Support Access =
 
== VPN Connection Issues ==
 
When support staff cannot connect to client VPN (Fortinet, etc.):
 
# '''Cause:''' Support IP not whitelisted on client firewall
# '''Solution:''' Client must add support staff's public IP to their VPN/firewall whitelist
# '''Note:''' This is client-side network administration, not a VoIPmonitor issue
 
{{Note|1=Don't confuse VPN network access with FortiToken 2FA (GUI authentication).}}
 
= System Troubleshooting =
 
== TCP SACK (Buggy Kernels pre-2019/03) ==
 
<syntaxhighlight lang="bash">
echo "0" > /proc/sys/net/ipv4/tcp_sack
</syntaxhighlight>
 
== Memory Speed Test ==
 
<syntaxhighlight lang="bash">
sysbench memory --threads=2 run
# Should be >5000 MiB/sec
</syntaxhighlight>
 
= Additional Resources =
 
{| class="wikitable"
! Topic !! Link
|-
| HAProxy config || [[sample HAproxy configuration]]
|-
| Hugepages for high CPS || [[voipmonitor and hugepages]]
|-
| Manager API reference || [[Manager_API]]
|-
| Syslog status line || [[Syslog_Status_Line]]
|-
| Ribbon SBC 7k TLS || [[Ribbon7k monitoring profiles]]
|-
| Support email templates || [[common body of support emails]]
|-
| IPACCOUNT feature || [[ipaccount]]
|-
| DTLS decryption || [[DTLS]]
|-
| Rocky 9 installation || [[Rocky 9]]
|}
 
'''IOPS testing:'''
<syntaxhighlight lang="bash">
fio --name=rootTest --ioengine=libaio --rw=randwrite --bs=8k --numjobs=16 \
  --size=1G --runtime=600s --time_based --filename=/root/testW.dat
</syntaxhighlight>
 
 
 
= AI Summary for RAG =
 
'''Summary:''' Internal support documentation for VoIPmonitor team covering testing, debugging, and troubleshooting procedures. Key topics: (1) Testing configuration with <code>--json_config</code> to override settings without editing files; (2) Testing regexp, country assignment, and billing; (3) License management commands (<code>checkLicense</code>, cron updates); (4) Debugging tools including jemalloc for memory leaks, X88 mode for detailed allocation, thread monitoring via <code>sniffer_threads</code> command; (5) PCAP testing methods (basic upload, packetbuffer, IPFIX emulation, tcpreplay with L2 addition and IP rewriting); (6) SS7/Wireshark module compilation; (7) Manager API commands on ports 5029 and 60024; (8) GUI workarounds including sensor logs popup disable (database trigger solution); (9) IonCube ldap.so crash fix for Ubuntu 22.04 + PHP 7.4; (10) VPN access troubleshooting (IP whitelisting on client firewall).
 
'''Keywords:''' internal support, json_config, testing, regexp, country assignment, billing test, license, checkLicense, jemalloc, memory leak, X88, sniffer_threads, SS7, wireshark, IPFIX, tcpreplay, pcap testing, Manager API, IonCube, ldap.so, Ubuntu 22.04, VPN access, IP whitelisting, sensor logs popup, log_sensor, database trigger, tcp_sack, sysbench, memory speed
 
'''Key Questions:'''
* How to test configuration without modifying voipmonitor.conf?
* How to test regexp patterns or country assignment?
* How to check license channel usage?
* How to debug memory leaks using jemalloc?
* How to compile voipmonitor with jemalloc or SS7 support?
* How to generate jeprof PDF memory report?
* How to monitor thread load with sniffer_threads?
* How to test IPFIX or replay PCAPs?
* How to add layer 2 to PCAP for tcpreplay?
* How to disable sensor logs popup in GUI?
* How to fix IonCube ldap.so crash in Ubuntu 22.04?
* How to resolve VPN connection issues for remote support?
* How to disable TCP SACK on buggy kernels?
* How to test memory speed with sysbench?

Latest revision as of 23:55, 9 January 2026


⚠️ Warning: This documentation is for the internal support team. Use at your own risk and test on non-production servers first.

Quick Reference

Testing Configuration

Override Settings with json_config

Override config file and database settings without editing files: 

voipmonitor --config-file=/etc/voipmonitor.conf -k -v1 \
  --json_config='[{"id_sensor":"11"},{"interface":"lo"},{"natalias":"8.8.8.8 10.10.100.50"}]'

💡 Tip: Useful for quick testing of specific parameters. Options in json_config take precedence over config file and DB settings.

Regexp / Country / Billing Tests

Test Type Command
Regexp pattern voipmonitor --config-file=/etc/voipmonitor.conf -k -v1 --test-regexp '^800...[1-9][0-9]'
Country by IP voipmonitor --config-file=/etc/voipmonitor.conf -k -v1 --find-country-for-ip=102.140.68.113
Country by number voipmonitor --config-file=/etc/voipmonitor.conf -k -v1 --find-country-for-number 0034*12345
Billing test voipmonitor --config-file=/etc/voipmonitor.conf -k -v1 --test-billing test_data/billing

Billing test file format (CSV): 

# calldate,connect_duration,caller,called,sipcallerip,sipcalledip,[exp_price_op],[exp_price_cust]
2018-05-09 12:00,120,+4121353333,+41792826527,192.168.101.10,192.168.101.151,800,8

License Management

Task Command
Write channel stats to DB php /var/www/html/php/run.php saveCallStatistics
Check license details php /var/www/html/php/run.php checkLicense -v
Check max peak only php /var/www/html/php/run.php checkLicense -v | grep max_peak -A3 -B1
Get token from DB SELECT content FROM voipmonitor.system WHERE type='license token';
View license file cat /var/www/html/key.php

Auto-update license via cron (without processing alerts/reports): 

04 04 * * * root php /var/www/html/php/run.php runUpdateLicenseKey

Utility Scripts

Script Purpose Details
Parallel alerts Process alerts faster Enable in Settings → System Configuration → Advanced → Number of parallel tasks
Batch download Download >1000 audio files Bypasses GUI limit of 1000 CDRs
RAM control Prevent OOM killer Sets oom_adj_score for PHP threads
Probe backup Backup all probe configs Requires SSH access without password

Debugging

Charts Binary Crash

When dmesg or Apache log shows charts crash: 

charts-x86_64[7321]: segfault at 10 ip 0000000000412553...

Debug procedure: 

# Create debug folder
mkdir /tmp/vm_charts_parameters

# After GUI creates charts, test with saved arguments
/var/www/html/bin/charts-x86_64 -i /tmp/vm_charts_parameters/files

Memory Leak Detection (Jemalloc)

Compile Jemalloc

# Download from https://github.com/jemalloc/jemalloc
./autogen.sh
./configure --enable-prof
make && make install

Compile VoIPmonitor with Jemalloc

Edit config.h: 

#define HAVE_LIBTCMALLOC 0
#define HAVE_LIBJEMALLOC 1

Edit Makefile: 

# Change -O2 to -O0 (disable optimization)
LIBS = ${SHARED_LIBS} -ljemalloc

make clean && make -j8

Run with Jemalloc

Modify /etc/init.d/voipmonitor start section: 

LD_PRELOAD=/usr/local/lib/libjemalloc.so MALLOC_CONF='prof:true' /usr/local/src/voipmonitor --config-file $CONFIGFILE --pid-file $PIDFILE $ARGS

Generate Memory Report

# Install dependencies
apt install graphviz ghostscript  # or: yum install graphviz ghostscript

# Generate PDF report
echo 'jemalloc_stat_full' | nc 127.0.0.1 5029 > /tmp/je_prof
jeprof --show_bytes --pdf /usr/local/src/sniffer/voipmonitor /tmp/je_prof > je_prof.pdf

X88 Mode (Detailed Memory Debug)

For more detailed memory allocation info: 

cp -a /usr/src/voipmonitor-git /usr/src/sniffer-git-jemalloc-X88
LD_PRELOAD=/usr/local/lib/libjemalloc.so ./voipmonitor -k -v1 -c -X88
make clean && make

Run with extra verbose options: 

LD_PRELOAD=/usr/local/lib/libjemalloc.so MALLOC_CONF='prof:true' ./voipmonitor \
  --config-file=/etc/voipmonitor.conf \
  -v 1,force_log_sqlq,memory_stat_ex,memory_stat_ignore_limit=100000,heapsafe

See: X88-memoryConsumptionDebug

Thread Debugging

Method Usage
Log thread CPU Add -v1,threads_cpu_log to command line
List threads nc 127.0.0.1 5029
Extended info Set sniffer_threads_ext=yes in config (requires compile with SNIFFER_THREADS_EXT true)

sniffer_threads options:

  • no_sort - don't sort by load
  • only_traffic - only threads with traffic
  • all - include unloaded threads
  • line - simple line output

SS7 Module Compilation

Requires Wireshark 3.2.

Edit config.h: 

#define HAVE_LIBWIRESHARK 1
#define LIBWIRESHARK_VERSION 30200

Edit Makefile: 

INCLUDE += -I/usr/include/wireshark
SHARED_LIBS += -lwiretap -lwireshark -lwsutil
# Change -O2 to -O0

./configure && make clean && make ss7

PCAP Testing

Basic Methods

Method Command
Basic upload voipmonitor --config-file=/etc/voipmonitor.conf -r /tmp/file.pcap
Via packetbuffer (fast) voipmonitor --config-file=/etc/voipmonitor.conf -rpbsa9: /tmp/file.pcap
Via packetbuffer (original time) voipmonitor --config-file=/etc/voipmonitor.conf -rpb: /tmp/file.pcap

IPFIX Testing

Receiver instance: 

ipfix = yes
ipfix_bind_ip = 0.0.0.0
ipfix_bind_port = 12345

Sender instance: 

voipmonitor --config-file=/etc/voipmonitor.conf -k -v1 \
  --ipfix-client-emulation='/tmp/ipfix.pcap;1.2.3.4;8.8.8.8;127.0.0.1;12345'
# Parameters: pcap_file;client_ip;server_ip;dest_ip;dest_port

IPFIX PCAP Download Behavior

Key fact: IPFIX data is internally converted to packet format for processing. This means:

  • PCAP files CAN be downloaded from the GUI for IPFIX-sourced calls
  • SIP signaling is reconstructed from the IPFIX data
  • RTP streams are NOT included in the PCAP - only QoS metrics from IPFIX data are available, not actual audio packets

When downloading PCAP from IPFIX calls with TLS, TCP sequence numbers may be set to 0 causing Wireshark to display incorrectly. Disable TCP sequence analysis in Wireshark preferences to view all packets.

Tcpreplay

Enable in /etc/init.d/voipmonitor: 

ARGS="-v 1,dump_call_flags,tcpreplay"

Add Layer 2 if missing (for captures done on "any" interface): 

tcprewrite --dlt=enet -i /tmp/x.pcap -o /tmp/x_enet.pcap
tcprewrite --enet-dmac=00:55:22:AF:C6:37 --enet-smac=00:44:66:FC:29:AF \
  --infile=/tmp/x_enet.pcap --outfile=/tmp/x_l2.pcap

Rewrite IP addresses: 

tcprewrite --pnat=8.7.6.5/32:1.2.3.4/32 -i ./original.pcap -o ./rewritten.pcap

SSL/TLS Testing

voipmonitor --config-file /etc/test.conf -k -v1,pcap_stat_period=1,_ssl,_tls,_ssldecode \
  -rpba:/tmp/keys.pcap@@/tmp/call.pcap \
  --json_config='[{"sipport":"8089"},{"ssl":"yes"},{"ssl_ipport":"192.168.0.1:8089"},{"ssl_sessionkey_udp":"yes"},{"ssl_sessionkey_udp_port":"1234"}]'

For TLS details, see Tls.

Manager API

For complete reference, see Manager_API.

This section covers quick debug commands. For encryption setup and full command list, see the main article.

Via Manager Port (5029)

# These require encryption disabled OR use socket file
echo 'listcalls' | nc 127.0.0.1 5029
echo 'sniffer_stat' | nc 127.0.0.1 5029
echo 'jemalloc_stat_full' | nc 127.0.0.1 5029
echo 'sniffer_threads' | nc 127.0.0.1 5029

💡 Tip: For encrypted communication, use the GUI's run.php send_manager_cmd or Unix socket. See Manager_API#Usage Examples.

Via Server Port (60024)

Used in distributed deployments for probe management: 

# List connected clients
echo '{"type_connection":"manager_command","command":"active"}' | nc 127.0.0.1 60024

# Send command to specific probe
echo '{"type_connection":"gui_command","sensor_id":1011,"command":"terminating"}' | nc 127.0.0.1 60024

GUI Workarounds

Disable Sensor Logs Popup

ℹ️ Note: There is no built-in GUI option to disable the sensor logs popup shown at admin login.

Option 1: Periodic SQL update 

UPDATE voipmonitor.log_sensor SET confirmed = 1;

Option 2: Database trigger (permanent) 

DELIMITER $$
CREATE TRIGGER before_insert_log_sensor
BEFORE INSERT ON log_sensor
FOR EACH ROW
BEGIN
    SET NEW.confirmed = 1;
END$$
DELIMITER ;

IonCube Crash Fix (Ubuntu 22.04 + PHP 7.4)

Symptom: ldap.so crash at login page (CVE-2024-8932).

Fix: 

# Backup
cd /usr/lib/php/20190902 && mkdir BKUP && cp -pv ldap.so* BKUP

# Download and extract fixed package
wget https://pl.archive.ubuntu.com/ubuntu/pool/main/p/php7.4/php7.4-ldap_7.4.3-4ubuntu2.24_amd64.deb
ar x php7.4-ldap_7.4.3-4ubuntu2.24_amd64.deb

# Install and restart
cp -v ./usr/lib/php/20190902/ldap.so /usr/lib/php/20190902/ldap.so
systemctl restart apache2

Database Operations

Rename MySQL Database

Generate RENAME TABLE commands: 

SELECT CONCAT('RENAME TABLE ',table_schema,'.',table_name,' TO NEW_DB.',table_name,';')
FROM information_schema.TABLES
WHERE table_schema LIKE 'OLD_DB';

⚠️ Warning: Foreign keys may cause issues during rename.

Spooldir Testing

voipmonitor --config-file /etc/voipmonitor.conf -k -v1 --test-cleanspool-load all

Remote Support Access

VPN Connection Issues

When support staff cannot connect to client VPN (Fortinet, etc.):

  1. Cause: Support IP not whitelisted on client firewall
  2. Solution: Client must add support staff's public IP to their VPN/firewall whitelist
  3. Note: This is client-side network administration, not a VoIPmonitor issue

ℹ️ Note: Don't confuse VPN network access with FortiToken 2FA (GUI authentication).

System Troubleshooting

TCP SACK (Buggy Kernels pre-2019/03)

echo "0" > /proc/sys/net/ipv4/tcp_sack

Memory Speed Test

sysbench memory --threads=2 run
# Should be >5000 MiB/sec

Additional Resources

Topic Link
HAProxy config sample HAproxy configuration
Hugepages for high CPS voipmonitor and hugepages
Manager API reference Manager_API
Syslog status line Syslog_Status_Line
Ribbon SBC 7k TLS Ribbon7k monitoring profiles
Support email templates common body of support emails
IPACCOUNT feature ipaccount
DTLS decryption DTLS
Rocky 9 installation Rocky 9

IOPS testing: 

fio --name=rootTest --ioengine=libaio --rw=randwrite --bs=8k --numjobs=16 \
  --size=1G --runtime=600s --time_based --filename=/root/testW.dat


AI Summary for RAG

Summary: Internal support documentation for VoIPmonitor team covering testing, debugging, and troubleshooting procedures. Key topics: (1) Testing configuration with --json_config to override settings without editing files; (2) Testing regexp, country assignment, and billing; (3) License management commands (checkLicense, cron updates); (4) Debugging tools including jemalloc for memory leaks, X88 mode for detailed allocation, thread monitoring via sniffer_threads command; (5) PCAP testing methods (basic upload, packetbuffer, IPFIX emulation, tcpreplay with L2 addition and IP rewriting); (6) SS7/Wireshark module compilation; (7) Manager API commands on ports 5029 and 60024; (8) GUI workarounds including sensor logs popup disable (database trigger solution); (9) IonCube ldap.so crash fix for Ubuntu 22.04 + PHP 7.4; (10) VPN access troubleshooting (IP whitelisting on client firewall).

Keywords: internal support, json_config, testing, regexp, country assignment, billing test, license, checkLicense, jemalloc, memory leak, X88, sniffer_threads, SS7, wireshark, IPFIX, tcpreplay, pcap testing, Manager API, IonCube, ldap.so, Ubuntu 22.04, VPN access, IP whitelisting, sensor logs popup, log_sensor, database trigger, tcp_sack, sysbench, memory speed

Key Questions:

  • How to test configuration without modifying voipmonitor.conf?
  • How to test regexp patterns or country assignment?
  • How to check license channel usage?
  • How to debug memory leaks using jemalloc?
  • How to compile voipmonitor with jemalloc or SS7 support?
  • How to generate jeprof PDF memory report?
  • How to monitor thread load with sniffer_threads?
  • How to test IPFIX or replay PCAPs?
  • How to add layer 2 to PCAP for tcpreplay?
  • How to disable sensor logs popup in GUI?
  • How to fix IonCube ldap.so crash in Ubuntu 22.04?
  • How to resolve VPN connection issues for remote support?
  • How to disable TCP SACK on buggy kernels?
  • How to test memory speed with sysbench?
Retrieved from "https://www.voipmonitor.org/doc/index.php?title=Internal_support_hints&oldid=10474"