Reports: Difference between revisions
(Add section on CSV export via crontab scheduler) |
|||
| Line 52: | Line 52: | ||
<pre> | <pre> | ||
sipip - source ip address | sipip - source ip address | ||
cnt_all - count of CDRs | cnt_all - count of CDRs | ||
cnt_connected - count of connected CDRs | cnt_connected - count of connected CDRs | ||
| Line 65: | Line 65: | ||
response_time_100_all - response time from invite to 100/183 in ms | 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_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_caller_all - MOS XR average for caller | ||
mos_xr_avg_called_all - MOS XR average for calle | mos_xr_avg_called_all - MOS XR average for calle | ||
| Line 70: | Line 72: | ||
mos_xr_min_caller_all - MOS XR minimal for stream from caller side | 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_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_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_caller_all - MOS silence stream from caller.. | ||
mos_silence_avg_called_all - MOS silence stream from called.. | mos_silence_avg_called_all - MOS silence stream from called.. | ||
| Line 84: | Line 86: | ||
rtcp_maxfr - maximum fraction loss reported in rtcp packets | rtcp_maxfr - maximum fraction loss reported in rtcp packets | ||
rtcp_maxjitter - maximum jitter reported in rtcp packets | rtcp_maxjitter - maximum jitter reported in rtcp packets | ||
rtcp_avgfr - average fraction loss reported | rtcp_avgfr - average fraction loss reported | ||
rtcp_avgjitter - average jitter reported in RTCP packets | rtcp_avgjitter - average jitter reported in RTCP packets | ||
rtcp_maxrtd - max round trip delay in ms | rtcp_maxrtd - max round trip delay in ms | ||
| Line 91: | Line 93: | ||
silence_end_all - in seconds how long there was silence before BYE packet | 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 | 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_ip - Same as sipip | ||
sip_hostname - when db ip lookup enabled in settings it will show the name defined for that IP | 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 | 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 | ||
| Line 108: | Line 110: | ||
[[File:reports-cdr.png]] | [[File:reports-cdr.png]] | ||
=== 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., <code>/var/backups/cdrs</code>) | |||
* 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 <code>www-data</code> or <code>apache</code>) 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 | |||
=== AI Summary for RAG === | === 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, | '''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. | ||
'''Keywords:''' daily reports, RTP report, charts report, report generator, call summary, QoS report, CDR view, ASR, ACD, MOS, jitter, delay, packet loss | '''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 | ||
'''Key Questions:''' | '''Key Questions:''' | ||
| Line 123: | Line 157: | ||
* How does QoS report differ from call summary? | * How does QoS report differ from call summary? | ||
* What is the simplified CDR interface? | * 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? | |||
Revision as of 04:23, 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-dataorapache) 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
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.
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
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?










