SARG-REPORTS(1) General Commands Manual SARG-REPORTS(1)

sarg-reports - Daily/Weekly/Monthly squid usage reports creation tool

sarg-reports [OPTIONS]

This manual page documents briefly the sarg-reports command.

sarg-reports is a script written to automate the SARG (a powerful squid log analyzer) reports and log management. Sarg itself, provide to end user a generic interface to create reports based on squid access log (begin of log to current date). sarg-reports is useful because it allow you to easly create and manage Daily, Weekly and Monthly reports.

A summary of options is included below.


Create Manual report
Create Today report
Create Daily report
Create Weely report
Create Monthly report

If you want the reports can be generated automatically insert the following lines (the today report creation time depend mostly of your sarg server load average, tune it):

PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
00 08-18/1 * * * sarg-reports today
00 00 * * * sarg-reports daily
00 01 * * 1 sarg-reports weekly
30 02 1 * * sarg-reports monthly

REMEMBER: if you use logrotate, configure it to retain enough logs to ensure availability of data for the longest period for which you need a report. Log rotation frequency is unimportant. See https://sourceforge.net/p/sarg/wiki/Keeping%20enough%20log%20to%20process/ This version of sarg-reports will use the log file defined in sarg.conf and also prior log files which have been rotated out of that location.

Check before using the sarg-reports that the following variables are set to file /etc/sarg/sarg-reports.conf


The sarg executable location

The sarg main configuration file location

Location where will be saved the reports

Set the number of previous daily/today/manual reports to keep

Set the number of previous weekly reports to keep

Set the number of previous monthly reports to keep

The title of main index page

Image logo to view in main index page

HTTP web page link of logo

Word 'daily' translation, translate it to your language

Word 'weekly' translation, translate it to your language

Word 'monthly' translation, translate it to your language

Exclude text from cron emails (normally, sarg, during cron activity, if it don't find any valid records,

It will output an error message (usually on 'today' reports). I don't want to be warned by email about this, so, i wrote the 'text' that will be never logged. This is useful to receive email of real problems only.

This is debian-specific and used to filter the covered period message

sarg-reports was written by Ugo Viti <ugo.viti@initzero.it>

This manual page was written by Juan Angulo Moreno <juan@apuntale.com>, for the Debian project (but may be used by others).

May 17, 2008