Reports: Difference between revisions

From VoIPmonitor.org
(Add troubleshooting section for scheduled reports with timezone mismatch information)
(Convert pre tags to syntaxhighlight)
Line 51: Line 51:
==== Description of the columns in the export ====
==== Description of the columns in the export ====


<pre>
<syntaxhighlight lang="bash">
sipip - source ip address
sipip - source ip address
cnt_all - count of CDRs
cnt_all - count of CDRs
Line 97: Line 97:
sip_hostname_color - It is possible to set the color of the record in db ip lookup
sip_hostname_color - It is possible to set the color of the record in db ip lookup
id - is IP address with use of underscores instead of IPs
id - is IP address with use of underscores instead of IPs
</pre>
</syntaxhighlight>


=== QoS Report ===
=== QoS Report ===
Line 165: Line 165:
   * Log into the server's command line interface (CLI)
   * Log into the server's command line interface (CLI)
   * Run the following command to see the current system timezone:
   * Run the following command to see the current system timezone:
     <pre>
     <syntaxhighlight lang="bash">
date
date
</pre>
</syntaxhighlight>
   * The output will show the server's date, time, and timezone
   * The output will show the server's date, time, and timezone


Line 173: Line 173:
   * If the GUI and OS timezones do not match, update one to match the other
   * If the GUI and OS timezones do not match, update one to match the other
   * To change the OS timezone (Debian/Ubuntu example):
   * To change the OS timezone (Debian/Ubuntu example):
     <pre>
     <syntaxhighlight lang="bash">
timedatectl set-timezone Europe/Prague
timedatectl set-timezone Europe/Prague
</pre>
</syntaxhighlight>
   * To change the GUI timezone, edit the setting in '''Settings > System Configuration > National > Timezone'''
   * To change the GUI timezone, edit the setting in '''Settings > System Configuration > National > Timezone'''


Line 181: Line 181:
   Even with correct timezones, the system must have a crontab entry to process scheduled tasks:
   Even with correct timezones, the system must have a crontab entry to process scheduled tasks:
   * Check the root crontab:
   * Check the root crontab:
     <pre>
     <syntaxhighlight lang="bash">
crontab -l
crontab -l
</pre>
</syntaxhighlight>
   * You should see an entry like:
   * You should see an entry like:
     <pre>
     <syntaxhighlight lang="bash">
* * * * * root php /var/www/html/php/run.php cron
* * * * * root php /var/www/html/php/run.php cron
</pre>
</syntaxhighlight>
   * If missing, add it using <code>crontab -e</code> and reload cron with <code>killall -HUP cron</code>
   * If missing, add it using <code>crontab -e</code> and reload cron with <code>killall -HUP cron</code>


Line 193: Line 193:


* '''Email delivery issues:''' If reports are being generated but not received, check your mail transfer agent (MTA) logs and mail queue:
* '''Email delivery issues:''' If reports are being generated but not received, check your mail transfer agent (MTA) logs and mail queue:
   <pre>
   <syntaxhighlight lang="bash">
mailq
mailq
tail /var/log/mail.log
tail /var/log/mail.log
</pre>
</syntaxhighlight>
* '''Incorrect schedule:''' Verify the crontab scheduler task has a valid "Next run" time in the future
* '''Incorrect schedule:''' Verify the crontab scheduler task has a valid "Next run" time in the future
* '''Stuck tasks:''' Try editing and saving the task again to reset its internal state
* '''Stuck tasks:''' Try editing and saving the task again to reset its internal state

Revision as of 11:20, 4 January 2026

Reports

Reports include daily reports, instant report generator, call summary, QoS report, and CDR simplified view.

Daily Email Reports

Daily email reports resemble alerts but send once per day and can include daily charts based on criteria.

RTP Daily Report

Summarizes RTP metrics: MOS, packet loss, jitter, delay (PDV), duration, one-way, and missing RTP.

Daily Charts Report

Generates daily chart statistics. Create multiple charts per report, filtered by CDR criteria (e.g., SIP trunks).

Chart creation dialog allows custom charts with filters on numbers, IP, RTP stats.

Preview results or send test emails via buttons.

Report Generator

Creates reports from historical data by criteria.

  • "Only CDR with RTP" checkbox: Reports connected calls only (ASR always 100%) or all CDRs.

Results table appears below form after selecting date, IP ranges, QoS parameters.

Call Summary

Overview grouped by source/destination IPs, focusing on signaling metrics: ASR, ACD, total duration, call count. Toolbar filters by date range, source/destination numbers.

Description of the columns in the export

sipip - source ip address
cnt_all - count of CDRs
cnt_connected - count of connected CDRs
duration_all - sum of connected seconds
acd_all - Average call duration
asr_all - Answer Seizure Ratio
ner_all - Network effectiveness ratio
seer_all - Session Establishment Effectiveness Ratio
short_60 - ratio in % of the CDRs with connect duration shorter 60s
short_20 - ratio in % of the CDRs with connect duration shorter 20s
mos_all - Mean Opinion Score (average) average (min from caller/called)
response_time_100_all - response time from invite to 100/183 in ms
mos_xr_avg_all - MOS XR average min of (caller/called)
mos_xr_avg_caller_all - MOS XR average for caller
mos_xr_avg_called_all - MOS XR average for calle
mos_xr_avg_caller_all - MOS XR average for caller
mos_xr_avg_called_all - MOS XR average for calle
mos_xr_min_all - MOS XR minimal (caller/called)
mos_xr_min_caller_all - MOS XR minimal for stream from caller side
mos_xr_min_called_all - MOS XR minimal for stream from called side
mos_silence_avg_all - MOS silence ..(is counted only when enabled - https://www.voipmonitor.org/doc/Silence_detection)
mos_silence_avg_caller_all - MOS silence stream from caller..
mos_silence_avg_called_all - MOS silence stream from called..
mos_silence_min_all - MOS minimal
mos_silence_min_caller_all - ..
mos_silence_min_called_all - ..
mos_lqo_caller_all - MOS listening quality objective caller stream
mos_lqo_called_all - MOS listening quality objective cakked stream
pdd_all - Post dial delay (time necessary to hear the announcement from INVITE request)
packets_lost_all - lost packets
jitter_all - average RTP jitter (max from caller/called)
delay_all - average of median of jitter (in CDR view detail grid X PDV in ms)
rtcp_maxfr - maximum fraction loss reported in rtcp packets
rtcp_maxjitter - maximum jitter reported in rtcp packets
rtcp_avgfr - average fraction loss reported
rtcp_avgjitter - average jitter reported in RTCP packets
rtcp_maxrtd - max round trip delay in ms
rtcp_avgrtd - average round trip delay in ms
silence_all - in percent how many silence was in the call
silence_end_all - in seconds how long there was silence before BYE packet
clipping_all - Number of clipped frames (clipped frame has the highest volume) - perceived as audible clicks - this value is shown in cdr detail table. It can be filtered and used in charts. Must be enabled in voipmonitor.conf
sip_ip - Same as sipip
sip_hostname - when db ip lookup enabled in settings it will show the name defined for that IP
sip_hostname_color - It is possible to set the color of the record in db ip lookup
id - is IP address with use of underscores instead of IPs

QoS Report

Similar to call summary but emphasizes RTP stats: MOS, jitter, delay, packet loss. Toolbar filters by date range, IP range.

Call Detail Records

Simplified CDR interface showing IPs and numbers, with quick toolbar filters.

CSV Export via Crontab Scheduler

You can export CDRs to a local directory on a schedule instead of (or in addition to) receiving them via email. This is useful for automated processing, archiving, or integration with external systems.

How to Configure CSV Export

Follow these steps to set up automatic CSV export:

1. Set the Export Folder

  * Navigate to GUI > Settings > System Configuration > Advanced
  * Set the "Folder for export CSV" parameter to your desired directory path (e.g., /var/backups/cdrs)
  * Optionally set a "CSV name prefix" to add a prefix to exported filenames
  * Optionally set "Delete CSV after X days" to enable automatic cleanup

2. Create a Crontab Scheduler Task

  * Navigate to GUI > Settings > Crontab Scheduler
  * Create a new task and configure:
    ** Type: Select the report type (e.g., Call Summary, Report Generator)
    ** Schedule: Set the frequency (hourly, daily, weekly, or custom cron expression)
    ** Report parameters: Configure filters (date range, IP ranges, etc.)
    ** Export format: CSV files will be generated

3. File Generation

  * When the crontab task runs, a CSV file is generated in the specified export folder
  * Filename format includes the CSV name prefix (if set) and timestamp
  * Files accumulate in the folder until automatically deleted (if "Delete CSV after X days" is set)

Notes and Requirements

  • The web server user (typically www-data or apache) must have write permissions to the export folder
  • Ensure sufficient disk space is available for accumulating CSV files
  • For custom export formats or complex processing requirements, consider using the WEB_API instead

Troubleshooting Scheduled Reports

If scheduled reports are not being sent automatically, but generating them manually works correctly, check the following common causes:

Timezone Mismatch between GUI and OS

The GUI and server OS must use the same timezone setting. If they differ, scheduled tasks may run at the wrong time or not appear to run at all.

    • Symptoms:**
  • Manual report generation works immediately
  • Scheduled reports in the GUI Crontab Scheduler appear configured but are not sent at the expected time
  • Reports may appear to be "delayed" or "skipped"
    • Solution:**

1. Check the GUI timezone setting

  * Navigate to GUI > Settings > System Configuration > National
  * Note the value in the Timezone field (e.g., "Europe/Prague", "America/New_York")

2. Check the OS timezone

  * Log into the server's command line interface (CLI)
  * Run the following command to see the current system timezone:
date
  * The output will show the server's date, time, and timezone

3. Compare and align the timezones

  * If the GUI and OS timezones do not match, update one to match the other
  * To change the OS timezone (Debian/Ubuntu example):
timedatectl set-timezone Europe/Prague
  * To change the GUI timezone, edit the setting in Settings > System Configuration > National > Timezone

4. Verify system cronjob is configured

  Even with correct timezones, the system must have a crontab entry to process scheduled tasks:
  * Check the root crontab:
crontab -l
  * You should see an entry like:
* * * * * root php /var/www/html/php/run.php cron
  * If missing, add it using crontab -e and reload cron with killall -HUP cron

Other Common Causes

  • Email delivery issues: If reports are being generated but not received, check your mail transfer agent (MTA) logs and mail queue:
mailq
tail /var/log/mail.log
  • Incorrect schedule: Verify the crontab scheduler task has a valid "Next run" time in the future
  • Stuck tasks: Try editing and saving the task again to reset its internal state

AI Summary for RAG

Summary: This article describes VoIPmonitor's reports features, including daily email reports (RTP summaries, charts), report generator for historical data, call summary by IPs, QoS-focused reports, simplified CDR view, and CSV export via crontab scheduler for automated local file generation. The troubleshooting section covers timezone mismatches between GUI and OS as a common cause of scheduled reports not being sent (manual generation works but automated sends fail at expected times). It also covers system cronjob verification, email delivery issues, and stuck tasks.

Keywords: daily reports, RTP report, charts report, report generator, call summary, QoS report, CDR view, ASR, ACD, MOS, jitter, delay, packet loss, CSV export, crontab scheduler, automatic export, export folder, troubleshooting, timezone mismatch, scheduled reports not sent, manual report works, OS timezone, GUI timezone, system cron, run.php, email delivery, mail queue

Key Questions:

  • What are daily email reports in VoIPmonitor?
  • How do RTP daily reports work?
  • How to create daily charts reports?
  • What is the report generator used for?
  • What metrics does call summary provide?
  • How does QoS report differ from call summary?
  • What is the simplified CDR interface?
  • How to export CDRs to a local directory automatically?
  • How to configure CSV export via crontab scheduler?
  • Where to set the export folder for CSV files?
  • How to set automatic cleanup of CSV files?
  • Why are my scheduled reports not being sent automatically?
  • Why do scheduled reports work manually but fail automatically?
  • How do I fix timezone mismatch between GUI and OS?
  • What causes scheduled reports to not run at the expected time?
  • How do I check the system cronjob for scheduled reports?