Reports: Difference between revisions

From VoIPmonitor.org
(Restore missing MOS silence columns, add workflow diagram, fix image formatting, improve structure)
(Add additional CSV export columns: short calls, SEER, quality metrics (VG-2987))
 
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Reports}}
{{DISPLAYTITLE:Reports}}
Category:GUI manual
[[Category:GUI manual]]


== Reports ==
= Reports =


Reports include daily reports, instant report generator, call summary, QoS report, and CDR simplified view.
VoIPmonitor provides multiple report types for analyzing call data, quality metrics, and generating scheduled summaries.


<kroki lang="plantuml">
<kroki lang="mermaid">
@startuml
%%{init: {'flowchart': {'nodeSpacing': 15, 'rankSpacing': 25}}}%%
skinparam shadowing false
flowchart LR
skinparam defaultFontName Arial
    subgraph Sources
skinparam rectangle {
        CDR[(CDR DB)]
  BorderColor #4A90E2
        RTP[(RTP Stats)]
  BackgroundColor #FFFFFF
    end
}
    subgraph Types
        Daily[Daily Email]
        Gen[Report Generator]
        Sum[Call Summary]
        QoS[QoS Report]
    end
    subgraph Output
        Email[Email]
        CSV[CSV Export]
        GUI[GUI Display]
    end
    CDR --> Daily & Gen & Sum & QoS
    RTP --> Daily & QoS
    Daily --> Email
    Gen --> GUI & CSV
    Sum --> GUI & CSV
    QoS --> GUI
</kroki>


rectangle "Data Sources" as DS {
{| class="wikitable"
  database "CDR Database" as cdr
|-
  database "RTP Statistics" as rtp
! Report Type !! Purpose !! Output
}
|-
| Daily Email Reports || Scheduled summaries (RTP, CPS, charts, CDR summary) || Email
|-
| Report Generator || Ad-hoc historical analysis || GUI, CSV
|-
| Call Summary || Aggregated by IP (ASR, ACD, duration) || GUI, CSV
|-
| QoS Report || RTP quality metrics (MOS, jitter, loss) || GUI
|-
| CDR Simplified || Quick CDR view with filters || GUI
|}


rectangle "Report Types" as RT {
== Prerequisites ==
  rectangle "Daily Email Reports" as daily
  rectangle "Report Generator" as gen
  rectangle "Call Summary" as sum
  rectangle "QoS Report" as qos
}


rectangle "Output" as OUT {
Reports require a working cron job for scheduled delivery. See [[Alerts#Email_Configuration|Alerts - Email Configuration]] for cron setup and MTA requirements.
  rectangle "Email" as email
  rectangle "CSV Export" as csv
  rectangle "GUI Display" as gui
}


cdr --> daily
{{Note|1=For scheduled reports, ensure <code>cleandatabase</code> in <code>/etc/voipmonitor.conf</code> exceeds your longest report period (e.g., >30 days for monthly reports). See [[Data_Cleaning]].}}
cdr --> gen
cdr --> sum
cdr --> qos
rtp --> daily
rtp --> qos


daily --> email
== Daily Email Reports ==
gen --> gui
gen --> csv
sum --> gui
sum --> csv
qos --> gui


note right of daily
Navigate to '''GUI > Reports > Configure Daily Reports''' to create scheduled reports.
  Scheduled via
  Crontab Scheduler
end note
@enduml
</kroki>


=== Daily Email Reports ===
=== RTP Daily Report ===


Daily email reports resemble alerts but send once per day and can include daily charts based on criteria.
Summarizes RTP metrics: MOS, packet loss, jitter, delay (PDV), duration, one-way, and missing RTP.


[[File:reports-daily.png|frame|center|Daily reports configuration]]
=== CPS Daily Report ===


==== RTP Daily Report ====
Reports maximum and average Calls Per Second (CPS) over the selected period.


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


[[File:Alert-sentalerts.png|frame|center|RTP daily report example]]
Generates visual charts of call metrics filtered by criteria (SIP trunks, numbers, IP).


==== Daily Charts Report ====
'''Time Range Settings:'''
{| class="wikitable"
|-
! Period !! Configuration
|-
| Daily || <code>"last day 1"</code>
|-
| Weekly || <code>"this week from Monday"</code> + enable <code>"previous interval"</code>
|-
| Monthly || <code>"previous month"</code>
|}


Generates daily chart statistics. Create multiple charts per report, filtered by CDR criteria (e.g., SIP trunks).
'''Creating Chart Templates:'''
# Navigate to '''GUI > Reports > Configure Daily Reports > Charts'''
# Click chart creation button
# Configure filters (CDR criteria, IP addresses, numbers)
# Select metrics (MOS, packet loss, jitter, concurrent calls)
# Save as '''chart template'''
# Attach template to scheduled report


[[File:report-dailychart.png|frame|center|Daily charts report configuration]]
{{Tip|Schedule resource-intensive reports (30-day charts) during off-peak hours to reduce database load.}}


Chart creation dialog allows custom charts with filters on numbers, IP, RTP stats.
=== CDR Summary Report ===


[[File:report-chartedit.png|frame|center|Chart creation dialog]]
Daily summary grouped by various criteria with optional billing costs.


Preview results or send test emails via buttons.
'''Summary Types:'''
 
{| class="wikitable"
[[File:report-chartbuttons.png|frame|center|Report preview and test buttons]]
|-
[[File:report-preview.png|frame|center|Report preview result]]
! Type !! Description
|-
| source IP / destination IP || Group by IP address
|-
| source number / destination number || Group by telephone number
|-
| Called/Caller number group || Group by predefined [[Groups|Telephone Number Groups]]
|}


=== Report Generator ===
'''Configuration:'''
# Select '''CDR summary''' as report type
# Choose '''Summary type''' from dropdown
# Filter by SIP response in '''Common tab''' (e.g., <code>%OK%</code>, <code>404%</code>)
# Enable '''Price columns''' for billing costs (requires [[Billing|Billing Configuration]])


Creates reports from historical data by criteria.
{{Note|1=For multiple SIP response codes, create '''separate reports''' for each code pattern. A single report cannot aggregate multiple response types.}}


* '''"Only CDR with RTP" checkbox''': Reports connected calls only (ASR always 100%) or all CDRs.
'''NPA-NXX Prefix Reporting:'''
# Create telephone number groups in '''GUI > Groups > Tel. numbers''' for each prefix
# Include country code variants (e.g., both <code>1202333</code> and <code>202333</code>)
# Use '''Called number group''' summary type
# Select groups in filter field


[[File:report-generatorform.png|frame|center|Report generator form]]
== Report Generator ==


Results table appears below form after selecting date, IP ranges, QoS parameters.
'''GUI > Reports > Report Generator''' - Creates ad-hoc reports from historical data.


[[File:reports-results.png|frame|center|Report generator results]]
* '''"Only CDR with RTP"''' checkbox: Reports only connected calls (ASR always 100%)
* Filter by date range, IP, numbers, QoS parameters
* Export results to CSV


=== Call Summary ===
{{Warning|1='''Limitation:''' Cannot combine "group by customer" AND "destination country" filters in one report. Create separate reports for each customer with both filters applied.}}


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


[[File:reports-callsummary.png|frame|center|Call summary report]]
'''GUI > Reports > Call Summary''' - Overview grouped by source/destination IP.


==== Export Column Reference ====
'''Key Metrics:''' ASR, ACD, NER, total duration, call count.


The following tables describe columns available in CSV exports.
=== Export Column Reference ===


'''Basic Metrics:'''
'''Basic Metrics:'''
Line 108: Line 144:
! Column !! Description
! Column !! Description
|-
|-
| sipip / sip_ip || Source IP address
| <code>sipip</code> || Source IP address
|-
|-
| cnt_all || Count of CDRs
| <code>cnt_all</code> / <code>cnt_connected</code> || Total / connected CDR count
|-
|-
| cnt_connected || Count of connected CDRs
| <code>duration_all</code> || Sum of connected seconds
|-
|-
| duration_all || Sum of connected seconds
| <code>asr_all</code> / <code>acd_all</code> / <code>ner_all</code> || Answer Seizure Ratio / Avg Call Duration / Network Effectiveness Ratio
|-
|-
| acd_all || Average Call Duration
| <code>mos_all</code> || MOS average (min of caller/called)
|-
|-
| asr_all || Answer Seizure Ratio
| <code>pdd_all</code> || Post Dial Delay (ms)
|-
|-
| ner_all || Network Effectiveness Ratio
| <code>jitter_all</code> / <code>delay_all</code> || Average jitter / median PDV
|-
|-
| seer_all || Session Establishment Effectiveness Ratio
| <code>packets_lost_all</code> || Lost packets count
|}
 
'''RTCP Columns:''' <code>rtcp_maxfr</code>, <code>rtcp_avgfr</code>, <code>rtcp_maxjitter</code>, <code>rtcp_avgjitter</code>, <code>rtcp_maxrtd</code>, <code>rtcp_avgrtd</code>
 
'''MOS XR Columns:''' <code>mos_xr_avg_all</code>, <code>mos_xr_min_all</code>, <code>mos_xr_avg_caller_all</code>, <code>mos_xr_avg_called_all</code>
 
'''Silence/Clipping Columns''' (requires [[Silence_detection|silence detection]]): <code>mos_silence_avg_all</code>, <code>silence_all</code>, <code>silence_end_all</code>, <code>clipping_all</code>
'''Short Call Metrics:'''
{| class="wikitable"
|-
|-
| short_60 || Ratio (%) of CDRs with connect duration < 60s
! Column !! Description
|-
|-
| short_20 || Ratio (%) of CDRs with connect duration < 20s
| <code>short_20</code> || Calls shorter than 20 seconds
|-
|-
| mos_all || MOS average (min from caller/called)
| <code>short_60</code> || Calls shorter than 60 seconds
|-
|-
| response_time_100_all || Response time from INVITE to 100/183 (ms)
| <code>short_180</code> || Calls shorter than 180 seconds
|-
| pdd_all || Post Dial Delay (time to hear announcement)
|-
| packets_lost_all || Lost packets count
|-
| jitter_all || Average RTP jitter (max from caller/called)
|-
| delay_all || Average of median jitter (PDV in ms)
|}
|}


'''MOS XR Columns''' (from RTCP-XR reports):
'''SEER (Session Effectiveness Ratio):'''
{| class="wikitable"
{| class="wikitable"
|-
|-
! Column !! Description
! Column !! Description
|-
|-
| mos_xr_avg_all || MOS XR average (min of caller/called)
| <code>seer_all</code> || Session Effectiveness Ratio - measures successful session establishment
|-
|-
| mos_xr_avg_caller_all || MOS XR average for caller stream
| <code>seer_invite</code> || SEER for INVITE transactions
|-
|-
| mos_xr_avg_called_all || MOS XR average for called stream
| <code>seer_bye</code> || SEER for BYE transactions
|-
| mos_xr_min_all || MOS XR minimal (caller/called)
|-
| mos_xr_min_caller_all || MOS XR minimal for caller stream
|-
| mos_xr_min_called_all || MOS XR minimal for called stream
|}
|}


'''RTCP Columns:'''
'''Additional Quality Metrics:'''
{| class="wikitable"
{| class="wikitable"
|-
|-
! Column !! Description
! Column !! Description
|-
|-
| rtcp_maxfr || Maximum fraction loss reported in RTCP
| <code>mos_min_all</code> || Minimum MOS score across all calls
|-
| rtcp_maxjitter || Maximum jitter reported in RTCP
|-
| rtcp_avgfr || Average fraction loss reported
|-
|-
| rtcp_avgjitter || Average jitter reported in RTCP
| <code>packet_loss_perc_all</code> || Packet loss percentage
|-
|-
| rtcp_maxrtd || Max round trip delay (ms)
| <code>out_of_order_all</code> || Out-of-order packets count
|-
| rtcp_avgrtd || Average round trip delay (ms)
|}
|}


'''Silence/Clipping Columns''' (requires [[Silence_detection|silence detection]] enabled):
''New in 2026.1''
== QoS Report ==
 
'''GUI > Reports > QoS''' - Similar to Call Summary but emphasizes RTP metrics.
 
'''Multi-hop Troubleshooting:'''
# Set time range for issue period
# Use "per caller IP" or "per called IP" filter
# Compare MOS scores across IPs to identify degraded segment
# Combine with dashboard MOS panels for visual timeline
 
== Regulatory Reporting ==
 
{| class="wikitable"
{| class="wikitable"
|-
|-
! Column !! Description
! Metric !! Column !! Description
|-
|-
| mos_silence_avg_all || MOS during silence periods (min of caller/called)
| Answer Seizure Ratio || <code>asr_all</code> || % of calls connecting successfully
|-
|-
| mos_silence_avg_caller_all || MOS during silence periods (caller stream)
| Post Dial Delay || <code>pdd_all</code> || Call setup time (ms)
|-
|-
| mos_silence_avg_called_all || MOS during silence periods (called stream)
| Mean Opinion Score || <code>mos_all</code> || Voice quality (1-5)
|-
|}
| mos_silence_min_all || MOS minimal during silence
 
{{Note|'''Dropped Call Ratio (DCR)''' is NOT available. Submit a feature request with your specific formula if needed.}}
 
== Parallel Processing Configuration ==
 
The <code>cron/reports</code> setting controls parallel report generation.
 
'''Location:''' GUI > Settings > System Configuration > Advanced
 
{| class="wikitable"
|-
|-
| mos_silence_min_caller_all || MOS minimal during silence (caller stream)
! Value !! When to Use
|-
|-
| mos_silence_min_called_all || MOS minimal during silence (called stream)
| '''1''' (default) || Sequential processing
|-
|-
| silence_all || Percentage of call that was silence
| '''2-4''' || Reports delayed, database has capacity
|-
|-
| silence_end_all || Seconds of silence before BYE packet
| '''4-8''' || Heavy report load, standard database
|-
|-
| clipping_all || Number of clipped frames (requires <code>clippingdetect=yes</code>)
| '''8-16''' || Dedicated database server
|}
|}


'''Other Columns:'''
{{Note|1=<code>cron/reports</code> controls report/alert generation. <code>parallel tasks</code> controls audio merging (unrelated).}}
 
== CSV Export via Crontab ==
 
# Set '''Folder for export CSV''' in '''GUI > Settings > System Configuration > Advanced'''
# Create task in '''GUI > Settings > Crontab Scheduler'''
# Ensure web server user has write access to export folder
 
For custom formats, use [[WEB_API|Web API]] instead.
=== CSV Export Precision ===
 
'''Location:''' GUI > Settings > System Configuration > Advanced > '''precision for float in CSV export'''
 
Controls decimal places for floating-point values in CSV exports (e.g., MOS scores, percentages).
 
{| class="wikitable"
{| class="wikitable"
|-
|-
! Column !! Description
! Value !! Example Output !! Use Case
|-
|-
| mos_lqo_caller_all || MOS listening quality objective (caller)
| '''2''' (default) || <code>4.12</code> || Standard reporting
|-
|-
| mos_lqo_called_all || MOS listening quality objective (called)
| '''4''' || <code>4.1234</code> || Detailed analysis
|-
|-
| sip_hostname || Hostname from DB IP lookup (if enabled)
| '''6''' || <code>4.123456</code> || Scientific/regulatory reporting
|-
| sip_hostname_color || Color setting from DB IP lookup
|-
| id || IP address with underscores instead of dots
|}
|}


=== QoS Report ===
''New in 2026.1''
== Troubleshooting ==


Similar to call summary but emphasizes RTP stats: MOS, jitter, delay, packet loss. Toolbar filters by date range, IP range.
=== Reports Timeout for Large Date Ranges ===


[[File:reports-qos.png|frame|center|QoS report]]
'''Symptom:''' Reports take 30+ seconds then timeout, especially with IP group filters.


=== Call Detail Records ===
'''Solution:''' Disable the '''"include proxy"''' checkbox next to caller/called IP group field in report configuration. This option causes expensive database joins.


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


[[File:reports-cdr.png|frame|center|Simplified CDR view]]
'''Symptom:''' Scheduled reports run at wrong time or don't trigger.


=== CSV Export via Crontab Scheduler ===
'''Solution:'''
<syntaxhighlight lang="bash">
# Check OS timezone
timedatectl


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.
# Align with GUI (Settings > System Configuration > National > Timezone)
timedatectl set-timezone Europe/Prague
</syntaxhighlight>


==== Configuration Steps ====
=== Blank Reports During Daylight Savings Time ===


;1. Set the Export Folder:
'''Symptom:''' Reports empty when using named timezones (e.g., <code>America/Los_Angeles</code>) during DST transitions.
:* Navigate to '''GUI > Settings > System Configuration > Advanced'''
:* Set '''"Folder for export CSV"''' to your desired directory (e.g., <code>/var/backups/cdrs</code>)
:* Optionally set '''"CSV name prefix"''' for filename prefixes
:* Optionally set '''"Delete CSV after X days"''' for automatic cleanup


;2. Create a Crontab Scheduler Task:
'''Workaround:''' Change GUI timezone to fixed UTC offset (e.g., <code>GMT-8</code> instead of <code>America/Los_Angeles</code>).
:* Navigate to '''GUI > Settings > Crontab Scheduler'''
:* Create a new task with:
:** '''Type:''' Report type (Call Summary, Report Generator, etc.)
:** '''Schedule:''' Frequency (hourly, daily, weekly, or cron expression)
:** '''Report parameters:''' Date range, IP ranges, etc.


;3. Verify Permissions:
=== Monthly Reports Fail in Distributed Setups ===
:* Web server user (<code>www-data</code> or <code>apache</code>) must have write access to export folder
:* Ensure sufficient disk space for accumulated files


For custom export formats, consider using the [[WEB_API|Web API]] instead.
'''Symptom:''' Monthly reports don't generate in multi-sensor environments.


=== Troubleshooting Scheduled Reports ===
'''Solution:''' Configure partition operations to prevent database lock conflicts:


If scheduled reports are not sent automatically but manual generation works, check these common causes:
'''On sniffer sensors:'''
<syntaxhighlight lang="ini">
# /etc/voipmonitor.conf
disable_partition_operations = yes
</syntaxhighlight>


==== Timezone Mismatch ====
'''On main server:'''
<syntaxhighlight lang="ini">
# /etc/voipmonitor.conf
disable_partition_operations = no
partition_operations_enable_fromto = 4-5
</syntaxhighlight>


The GUI and server OS must use the same timezone. If they differ, scheduled tasks may run at wrong times or appear to be skipped.
{{Warning|1=Avoid scheduling reports during partition maintenance window (default 01:00-01:10 AM). Schedule 15-30 minutes before or after.}}


'''Symptoms:'''
=== Missing daily_reports_sended Table ===
* Manual report generation works immediately
 
* Scheduled reports appear configured but don't run at expected time
'''Symptom:''' Cannot enable/create daily reports in GUI.


'''Solution:'''
'''Solution:'''
<syntaxhighlight lang="sql">
CREATE TABLE `daily_reports_sended` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `daily_reports_id` int(11) NOT NULL,
  `day` date NOT NULL,
  `subject` text DEFAULT NULL,
  `content` mediumtext DEFAULT NULL,
  `send_time` datetime DEFAULT NULL,
  `send_email` text DEFAULT NULL,
  PRIMARY KEY (`id`),
  KEY `fk__daily_reports_sended__daily_reports` (`daily_reports_id`),
  CONSTRAINT `fk__daily_reports_sended__daily_reports`
    FOREIGN KEY (`daily_reports_id`) REFERENCES `daily_reports` (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1;
</syntaxhighlight>


;1. Check GUI timezone:
=== Email Shows "Sent" But Not Delivered ===
:Navigate to '''GUI > Settings > System Configuration > National > Timezone'''


;2. Check OS timezone:
'''Symptom:''' GUI shows success but email never arrives.
<syntaxhighlight lang="bash">
date
timedatectl
</syntaxhighlight>


;3. Align timezones:
'''Solution:''' Check for missing MTA:
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
# Change OS timezone to match GUI (example)
# Check error log
timedatectl set-timezone Europe/Prague
tail -n 50 /var/log/httpd/error_log | grep sendmail
</syntaxhighlight>


;4. Verify system cronjob:
# Install MTA if missing
<syntaxhighlight lang="bash">
apt-get install postfix  # Debian/Ubuntu
crontab -l
yum install postfix      # RHEL/CentOS
# Should contain:
# * * * * * root php /var/www/html/php/run.php cron
</syntaxhighlight>
</syntaxhighlight>


==== Other Common Causes ====
== See Also ==


* '''Email delivery issues:''' Check MTA logs with <code>mailq</code> and <code>tail /var/log/mail.log</code>
* [[Alerts]] - Email alert configuration and cron setup
* '''Incorrect schedule:''' Verify task has valid "Next run" time in the future
* [[Data_Cleaning]] - Data retention settings
* '''Stuck tasks:''' Edit and save the task again to reset its state
* [[Silence_detection]] - Enable silence/clipping metrics
* [[WEB_API]] - Programmatic report access
* [[Groups]] - IP and telephone number groups


=== See Also ===


* [[Alerts|Alerts & Reports]] - Email alert configuration
* [[Silence_detection|Silence Detection]] - Enable silence/clipping metrics
* [[WEB_API|Web API]] - Programmatic report access


== AI Summary for RAG ==
== AI Summary for RAG ==


'''Summary:''' VoIPmonitor reports system provides daily email reports (RTP summaries, charts), a report generator for historical data analysis, call summary grouped by IP addresses, QoS reports emphasizing RTP metrics, and simplified CDR views. CSV exports can be automated via crontab scheduler. Common troubleshooting involves timezone alignment between GUI and OS settings.
'''Summary:''' VoIPmonitor reports include Daily Email Reports (RTP, CPS, charts, CDR summary), Report Generator for ad-hoc analysis, Call Summary grouped by IP, QoS Report for RTP metrics, and simplified CDR view. CDR Summary supports grouping by source/destination IP, telephone numbers, or predefined number groups. Regulatory metrics available: ASR (<code>asr_all</code>), PDD (<code>pdd_all</code>), MOS (<code>mos_all</code>); DCR is NOT available. The <code>cron/reports</code> setting (GUI > Settings > Advanced) controls parallel report generation: default 1 (sequential), increase to 2-8 for delayed reports, or decrease for database load issues. Key limitation: cannot combine customer grouping AND country filtering in one report. Common fixes: disable "include proxy" checkbox for timeout issues, use fixed UTC offset for DST problems, configure <code>disable_partition_operations</code> for multi-sensor monthly report failures.


'''Keywords:''' reports, daily reports, RTP, charts, call summary, QoS, ASR, ACD, NER, MOS, CSV export, crontab scheduler, timezone
'''Keywords:''' reports, daily reports, RTP report, CPS, charts, CDR summary, report generator, call summary, QoS report, ASR, ACD, NER, MOS, PDD, CSV export, cron/reports, parallel processing, regulatory reporting, timezone, DST, daylight savings, partition operations, include proxy, timeout, NPA-NXX, telephone number groups


'''Key Questions:'''
'''Key Questions:'''
* What types of reports does VoIPmonitor provide?
* What types of reports does VoIPmonitor provide?
* How to configure daily email reports?
* How to configure daily email reports?
* What columns are available in CSV export?
* How to fix report timeout for large date ranges?
* How to export CDRs to CSV automatically?
* What is the include proxy checkbox and why disable it?
* Why are scheduled reports not being sent?
* How to configure parallel report processing (cron/reports)?
* Why are reports blank during daylight savings time?
* How to fix monthly reports failing in distributed setups?
* What regulatory metrics are available (ASR, PDD, MOS)?
* How to group CDR summary by telephone number groups?
* How to export reports to CSV automatically?

Latest revision as of 15:47, 19 January 2026


Reports

VoIPmonitor provides multiple report types for analyzing call data, quality metrics, and generating scheduled summaries.

Report Type Purpose Output
Daily Email Reports Scheduled summaries (RTP, CPS, charts, CDR summary) Email
Report Generator Ad-hoc historical analysis GUI, CSV
Call Summary Aggregated by IP (ASR, ACD, duration) GUI, CSV
QoS Report RTP quality metrics (MOS, jitter, loss) GUI
CDR Simplified Quick CDR view with filters GUI

Prerequisites

Reports require a working cron job for scheduled delivery. See Alerts - Email Configuration for cron setup and MTA requirements.

ℹ️ Note: For scheduled reports, ensure cleandatabase in /etc/voipmonitor.conf exceeds your longest report period (e.g., >30 days for monthly reports). See Data_Cleaning.

Daily Email Reports

Navigate to GUI > Reports > Configure Daily Reports to create scheduled reports.

RTP Daily Report

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

CPS Daily Report

Reports maximum and average Calls Per Second (CPS) over the selected period.

Daily Charts Report

Generates visual charts of call metrics filtered by criteria (SIP trunks, numbers, IP).

Time Range Settings:

Period Configuration
Daily "last day 1"
Weekly "this week from Monday" + enable "previous interval"
Monthly "previous month"

Creating Chart Templates:

  1. Navigate to GUI > Reports > Configure Daily Reports > Charts
  2. Click chart creation button
  3. Configure filters (CDR criteria, IP addresses, numbers)
  4. Select metrics (MOS, packet loss, jitter, concurrent calls)
  5. Save as chart template
  6. Attach template to scheduled report

💡 Tip: Schedule resource-intensive reports (30-day charts) during off-peak hours to reduce database load.

CDR Summary Report

Daily summary grouped by various criteria with optional billing costs.

Summary Types:

Type Description
source IP / destination IP Group by IP address
source number / destination number Group by telephone number
Called/Caller number group Group by predefined Telephone Number Groups

Configuration:

  1. Select CDR summary as report type
  2. Choose Summary type from dropdown
  3. Filter by SIP response in Common tab (e.g., %OK%, 404%)
  4. Enable Price columns for billing costs (requires Billing Configuration)

ℹ️ Note: For multiple SIP response codes, create separate reports for each code pattern. A single report cannot aggregate multiple response types.

NPA-NXX Prefix Reporting:

  1. Create telephone number groups in GUI > Groups > Tel. numbers for each prefix
  2. Include country code variants (e.g., both 1202333 and 202333)
  3. Use Called number group summary type
  4. Select groups in filter field

Report Generator

GUI > Reports > Report Generator - Creates ad-hoc reports from historical data.

  • "Only CDR with RTP" checkbox: Reports only connected calls (ASR always 100%)
  • Filter by date range, IP, numbers, QoS parameters
  • Export results to CSV

⚠️ Warning: Limitation: Cannot combine "group by customer" AND "destination country" filters in one report. Create separate reports for each customer with both filters applied.

Call Summary

GUI > Reports > Call Summary - Overview grouped by source/destination IP.

Key Metrics: ASR, ACD, NER, total duration, call count.

Export Column Reference

Basic Metrics:

Column Description
sipip Source IP address
cnt_all / cnt_connected Total / connected CDR count
duration_all Sum of connected seconds
asr_all / acd_all / ner_all Answer Seizure Ratio / Avg Call Duration / Network Effectiveness Ratio
mos_all MOS average (min of caller/called)
pdd_all Post Dial Delay (ms)
jitter_all / delay_all Average jitter / median PDV
packets_lost_all Lost packets count

RTCP Columns: rtcp_maxfr, rtcp_avgfr, rtcp_maxjitter, rtcp_avgjitter, rtcp_maxrtd, rtcp_avgrtd

MOS XR Columns: mos_xr_avg_all, mos_xr_min_all, mos_xr_avg_caller_all, mos_xr_avg_called_all

Silence/Clipping Columns (requires silence detection): mos_silence_avg_all, silence_all, silence_end_all, clipping_all Short Call Metrics:

Column Description
short_20 Calls shorter than 20 seconds
short_60 Calls shorter than 60 seconds
short_180 Calls shorter than 180 seconds

SEER (Session Effectiveness Ratio):

Column Description
seer_all Session Effectiveness Ratio - measures successful session establishment
seer_invite SEER for INVITE transactions
seer_bye SEER for BYE transactions

Additional Quality Metrics:

Column Description
mos_min_all Minimum MOS score across all calls
packet_loss_perc_all Packet loss percentage
out_of_order_all Out-of-order packets count

New in 2026.1

QoS Report

GUI > Reports > QoS - Similar to Call Summary but emphasizes RTP metrics.

Multi-hop Troubleshooting:

  1. Set time range for issue period
  2. Use "per caller IP" or "per called IP" filter
  3. Compare MOS scores across IPs to identify degraded segment
  4. Combine with dashboard MOS panels for visual timeline

Regulatory Reporting

Metric Column Description
Answer Seizure Ratio asr_all % of calls connecting successfully
Post Dial Delay pdd_all Call setup time (ms)
Mean Opinion Score mos_all Voice quality (1-5)

ℹ️ Note: Dropped Call Ratio (DCR) is NOT available. Submit a feature request with your specific formula if needed.

Parallel Processing Configuration

The cron/reports setting controls parallel report generation.

Location: GUI > Settings > System Configuration > Advanced

Value When to Use
1 (default) Sequential processing
2-4 Reports delayed, database has capacity
4-8 Heavy report load, standard database
8-16 Dedicated database server

ℹ️ Note: cron/reports controls report/alert generation. parallel tasks controls audio merging (unrelated).

CSV Export via Crontab

  1. Set Folder for export CSV in GUI > Settings > System Configuration > Advanced
  2. Create task in GUI > Settings > Crontab Scheduler
  3. Ensure web server user has write access to export folder

For custom formats, use Web API instead.

CSV Export Precision

Location: GUI > Settings > System Configuration > Advanced > precision for float in CSV export

Controls decimal places for floating-point values in CSV exports (e.g., MOS scores, percentages).

Value Example Output Use Case
2 (default) 4.12 Standard reporting
4 4.1234 Detailed analysis
6 4.123456 Scientific/regulatory reporting

New in 2026.1

Troubleshooting

Reports Timeout for Large Date Ranges

Symptom: Reports take 30+ seconds then timeout, especially with IP group filters.

Solution: Disable the "include proxy" checkbox next to caller/called IP group field in report configuration. This option causes expensive database joins.

Timezone Mismatch

Symptom: Scheduled reports run at wrong time or don't trigger.

Solution: 

# Check OS timezone
timedatectl

# Align with GUI (Settings > System Configuration > National > Timezone)
timedatectl set-timezone Europe/Prague

Blank Reports During Daylight Savings Time

Symptom: Reports empty when using named timezones (e.g., America/Los_Angeles) during DST transitions.

Workaround: Change GUI timezone to fixed UTC offset (e.g., GMT-8 instead of America/Los_Angeles).

Monthly Reports Fail in Distributed Setups

Symptom: Monthly reports don't generate in multi-sensor environments.

Solution: Configure partition operations to prevent database lock conflicts:

On sniffer sensors: 

# /etc/voipmonitor.conf
disable_partition_operations = yes

On main server: 

# /etc/voipmonitor.conf
disable_partition_operations = no
partition_operations_enable_fromto = 4-5

⚠️ Warning: Avoid scheduling reports during partition maintenance window (default 01:00-01:10 AM). Schedule 15-30 minutes before or after.

Missing daily_reports_sended Table

Symptom: Cannot enable/create daily reports in GUI.

Solution: 

CREATE TABLE `daily_reports_sended` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `daily_reports_id` int(11) NOT NULL,
  `day` date NOT NULL,
  `subject` text DEFAULT NULL,
  `content` mediumtext DEFAULT NULL,
  `send_time` datetime DEFAULT NULL,
  `send_email` text DEFAULT NULL,
  PRIMARY KEY (`id`),
  KEY `fk__daily_reports_sended__daily_reports` (`daily_reports_id`),
  CONSTRAINT `fk__daily_reports_sended__daily_reports`
    FOREIGN KEY (`daily_reports_id`) REFERENCES `daily_reports` (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1;

Email Shows "Sent" But Not Delivered

Symptom: GUI shows success but email never arrives.

Solution: Check for missing MTA: 

# Check error log
tail -n 50 /var/log/httpd/error_log | grep sendmail

# Install MTA if missing
apt-get install postfix  # Debian/Ubuntu
yum install postfix      # RHEL/CentOS

See Also


AI Summary for RAG

Summary: VoIPmonitor reports include Daily Email Reports (RTP, CPS, charts, CDR summary), Report Generator for ad-hoc analysis, Call Summary grouped by IP, QoS Report for RTP metrics, and simplified CDR view. CDR Summary supports grouping by source/destination IP, telephone numbers, or predefined number groups. Regulatory metrics available: ASR (asr_all), PDD (pdd_all), MOS (mos_all); DCR is NOT available. The cron/reports setting (GUI > Settings > Advanced) controls parallel report generation: default 1 (sequential), increase to 2-8 for delayed reports, or decrease for database load issues. Key limitation: cannot combine customer grouping AND country filtering in one report. Common fixes: disable "include proxy" checkbox for timeout issues, use fixed UTC offset for DST problems, configure disable_partition_operations for multi-sensor monthly report failures.

Keywords: reports, daily reports, RTP report, CPS, charts, CDR summary, report generator, call summary, QoS report, ASR, ACD, NER, MOS, PDD, CSV export, cron/reports, parallel processing, regulatory reporting, timezone, DST, daylight savings, partition operations, include proxy, timeout, NPA-NXX, telephone number groups

Key Questions:

  • What types of reports does VoIPmonitor provide?
  • How to configure daily email reports?
  • How to fix report timeout for large date ranges?
  • What is the include proxy checkbox and why disable it?
  • How to configure parallel report processing (cron/reports)?
  • Why are reports blank during daylight savings time?
  • How to fix monthly reports failing in distributed setups?
  • What regulatory metrics are available (ASR, PDD, MOS)?
  • How to group CDR summary by telephone number groups?
  • How to export reports to CSV automatically?
Retrieved from "https://www.voipmonitor.org/doc/index.php?title=Reports&oldid=10789"