NAME
sarg - Squid Analysis Report Generator
SYNOPSIS
sarg [options]
DESCRIPTION
sarg is a logfile parser and anylizer for the Squid Web Proxy Cache,
which can be found at http://www.squid-cache.org/. This manual page
documents briefly the sarg command. More information is available at
http://sarg.sourceforge.net/. This manual page was originally written
for the Debian distribution because the author didn’t include one in
favor of documentation in the GNU Info format; see below.
sarg is a tool that allows you to view "where" your users are going to
on the Internet. sarg generates reports in HTML, with fields such as:
users, IP Addresses, bytes, sites, and times. These HTML files can
appear in your web server’s directory for browsing by users or
administrators. You may also have sarg email the reports to the Squid
Cache administrator.
sarg can take the squid access log as its input, or optionally the
squidGuard http://www.squidguard.org/ Squid filter/redirector logfile
format.
OPTIONS
A summary of options is included below.
-h Show summary of options.
-a [hostname|ip address]
Limits report to records containing the specified hostname/ip
address
-b filename
Enables UserAgent log and writes it to filename.
-c filename
Uses filename as the exclude files to select records that are
not counted.
-d date
Uses date as the timelimit during logfile processing. Format for
date is dd/mm/yyyy-dd/mm/yyyy
-e email
Sends report to email (stdout for console).
-f filename
Reads configuration from filename.
-g e|u Sets date format in generated reports.
e = Europe -> dd/mm/yy
u = USA -> mm/dd/yy
-i Generates reports by user and ip address.
NOTE: This requires the ’report_type’ option in config file to
contain "users_sites".
-l filename
Uses filename as the input log. This option can be repeated up
to 255 times to read multiple files. The files must be listed in
chronological order from newest to eldest. If the files end with
the extension .gz, .bz2 or .Z they are decompressed. If the
file name is just - , the log file is read from standard input.
In that case, it cannot be compressed.
-n Enables ip address resolution.
-o dir Writes report in dir.
-p Generates reports using ip address instead of userid.
-s string
Limits report to the site specified by string [eg.
www.debian.org]
-t string
Limits records counted in statistics based on time-of-day.
Format for string is HH or HH:MM or HH:MM:SS.
-u user
Limits reports to user activities.
-w dir Uses dir for temporary files.
-x Writes debug messages to STDOUT
-z Writes messages on processes to STDOUT
-convert
Convert the logfile’s date/time field to human-readable.
-split Split the log file by date in -d parameter.
FILES
/etc/squid/sarg.conf
/var/log/squid/access.log
/var/log/squid/squidGuard.log
SEE ALSO
squid(8)
AUTHOR
This manual page was written by Luigi Gangitano
<gangitano@lugroma3.org>, for the Debian GNU/Linux system (but may be
used by others). Revised by Billy Newsom.
September 25, 2004