| AWStats logfile analyzer 6.4 Documentation |

# Plugins, contribs and related programs

You will find here description for different kinds of ressource files :
- AWStats plugins
- Other AWStats contribs/tools/package
- Other Non AWStats contribs/tools (not related to AWStats but related to log analysis)
- Documents on AWStats or related to log analysis
AWStats plugins

Plugins are .pm files you can put in your AWStats plugins directory to add new features.
Note that you must enable the plugin by adding a new line in your config files to make it works (See LoadPlugin parameter).
Standard plugins : tooltips, decodeutfkeys, ipv6, hashfiles, geoip, geoipfree, userinfo, hostinfo, clusterinfo, urlalias, timehires, timezone, rawlog, graphapplet
Other plugins (require other licensed product to work) : geoip_region_maxmind, geoip_city_maxmind, geoip_isp_maxmind, geoip_org_maxmind,
List of standard plugins (Provided with AWStats) :
# Plugin: Tooltips
# Perl modules required: None
# Add some tooltips help on HTML report pages.
# Note that enabled this kind of help will increased HTML report pages size,
# so server load and bandwidth.
Plugin provided with AWStats (5.4+).
# Plugin: DecodeUTFKeys
# Perl modules required: Encode and URI::Escape
# Allow AWStats to show correctly (in language charset) keywords/keyphrases
# strings even if they were UTF8 coded by the referer search engine.
#
#LoadPlugin="decodeutfkeys"
Plugin provided with AWStats (6.0+).
# Plugin: IPv6
# Perl modules required: Net::IP and Net::DNS
# This plugin gives AWStats capability to make reverse DNS lookup on IPv6
# addresses.
# Note: If you are interesting in having country report, you should use the
# geoipfree (or geoip) plugin instead of enabled reverse DNS lookup.
Plugin provided with AWStats (5.5+)
# Plugin: HashFiles
# Perl modules required: Storable
# AWStats DNS cache files are read/saved as native hash files. This increase
# cache file loading speed, above all for very large web sites.
Plugin provided with AWStats (5.1+)
# Plugin: GeoIP
# Perl modules required: Geo::IP or Geo::IP::PurePerl (from Maxmind)
# Country chart is built from an Internet IP-Country database.
# This plugin is useless for intranet only log files.
# Note: You must choose between using this plugin (need Perl Geo::IP module
# from Maxmind, database more up to date) or the GeoIPfree plugin (need
# Perl Geo::IPfree module, database less up to date).
# This plugin reduces AWStats speed of 8% !
#
#LoadPlugin="geoip GEOIP_STANDARD"
Plugin provided with AWStats (5.2+).
You can find Geo::IP Perl Module from Maxmind.
Plugins for Maxmind GeoIP Region, GeoIP City, GeoIP ISP and GeoIP Organization are also available (but databases are not free).
# Plugin: GeoIPfree
# Perl modules required: Geo::IPfree version 0.2+ (from Graciliano M.P.)
# Country chart is built from an Internet IP-Country database.
# This plugin is useless for intranet only log files.
# Note: You must choose between using this plugin (need Perl Geo::IPfree
# module, database less up to date) or the GeoIP plugin (need Perl Geo::IP
# module from Maxmind, database more up to date).
# Note: Activestate provide a corrupted version of Geo::IPfree 0.2 Perl
# module, so install it from elsewhere (from www.cpan.org for example).
# This plugin reduces AWStats speed of 10% !
#
#LoadPlugin="geoipfree"
Plugin provided with AWStats (5.5+).
You can find Geo::IPfree Perl Module on :
- All OS: CPAN site
- RPM compatible OS (RedHat, Mandrake...): Lafraia rpm
- ActiveState: GeoIPfree module provided by Activestate is not working correctly so I removed the link. You can follow the following setup instead: Download from CPAN site and copy 'Geo' directory (found in 'lib') into AWStats plugins directory. This is a fast tip to install Geo-IPfree perl module to be used by AWStats geoipfree plugin.
Note: The Geo::IPfree database has not been updated since a long time, so using the geoip plugin (using the Geo::IP Perl module, now free for countries) is highly recommanded.
You can use the following tool to test your geoipfree setup: testgeoipfree.pl. Just put this file into your plugins directory and run it.
# Plugin: UserInfo
# Perl modules required: None
# Add a text (Firtname, Lastname, Office Department, ...) in authenticated user
# reports for each login value.
# A text file called userinfo.myconfig.txt, with two fields (first is login,
# second is text to show, separated by a tab char) must be created in DirData
# directory.
Plugin provided with AWStats (5.5+)
# Plugin: ClusterInfo
# Perl modules required: None
# Add a text (for example a full hostname) in cluster reports for each cluster
# number.
# A text file called clusterinfo.myconfig.txt, with two fields (first is
# cluster number, second is text to show) separated by a tab char. must be
# created into DirData directory.
# Note this plugin is useless if ShowClusterStats is set to 0 or if you don't
# use a personalized log format that contains %cluster tag.
Plugin provided with AWStats (6.2+)
# Plugin: HostInfo
# Perl modules required: Net::XWhois
# Add a column into host chart with a link to open a popup window that shows
# info on host (like whois records).
Plugin provided with AWStats (6.0+)
# Plugin: UrlAliases
# Perl modules required: None
# Add a text (Page title, description...) in URL reports before URL value.
# A text file called urlalias.myconfig.txt, with two fields (first is URL,
# second is text to show, separated by a tab char) must be created in DirData
# directory.
Plugin provided with AWStats (5.2+)
You can build your urlalias file manually or use urlaliasbuilder.pl tool (provided with 5.4+)
# Plugin: TimeHiRes
# Perl modules required: Time::HiRes
# Time reported by -showsteps option is in millisecond. For debug purpose.
Plugin provided with AWStats (5.1+)
# Plugin: TimeZone
# Perl modules required: Time::Local
# Allow AWStats to correct a bad timezone for user of some IIS that use
# GMT date in its log instead of local server time.
# This module is useless for Apache and most IIS version.
# This plugin reduces AWStats speed of 40% !!!!!!!
Plugin provided with AWStats (5.1+)
# Plugin: Rawlog
# Perl modules required: None
# This plugin adds a form in AWStats main page to allow users to see raw
# content of current log files. A filter is also available.
Plugin provided with AWStats (5.7+)
# Plugin: GraphApplet
# Perl modules required: None
# Supported charts are built by a 3D graphic applet.
#
#LoadPlugin="graphapplet" # EXPERIMENTAL FEATURE
Plugin provided with AWStats (6.0+)
List of other plugins (Plugins are free but need a not free third product to work)
# Plugin: GeoIP_Region_Maxmind
# Perl modules required: Geo::IP (from Maxmind)
# This plugin add a chart of hits by regions. Only regions for US and
# Canada can be detected.
# Note: This plugin need Maxmind GeoIP Perl module AND the region database.
# Note: I get some problem with Maxmind Geo::IP Perl module with ActiveState
# on Windows but it works great on Linux with default Perl.
# You need to purchase a license from Maxmind to get/use the Region database.
# This plugin reduces AWStats speed.
#
#LoadPlugin="geoip_region_maxmind GEOIP_STANDARD /pathto/GeoIPRegion.dat"
Install:
This plugin need AWStats 6.2 or higher and need Geo::IP Perl Module AND the Region database.
You can purchase the Region licensed database and updates from Maxmind.
This plugin is provided with AWStats 6.2 standard distribution. If requirements are ok, just add the following line to your AWStats configuration file:
LoadPlugin="geoip_region_maxmind GEOIP_STANDARD /pathto/GeoIPRegion.dat"
Where /pathto/GeoIPRegion.dat is the full path where you stored your Region Database file. By enabled this plugin, you will see a new link called 'Regions' on reports menu. For the moment this link works only when AWStats reports are build as CGI (static built not yet supported).
# Plugin: GeoIP_City_Maxmind
# Perl modules required: Geo::IP (from Maxmind)
# This plugin add a chart of hits by cities.
# Note: This plugin need Maxmind GeoIP Perl module AND the city database.
# Note: I get some problem with Maxmind Geo::IP Perl module with ActiveState
# on Windows but it works great on Linux with default Perl.
# You need to purchase a license from Maxmind to get/use the City database.
# This plugin reduces AWStats speed.
#
#LoadPlugin="geoip_city_maxmind GEOIP_STANDARD /pathto/GeoIPCity.dat"
Install:
This plugin need AWStats 6.2 or higher and need Geo::IP Perl Module AND the City database.
You can purchase the City licensed database and updates from Maxmind.
This plugin is provided with AWStats 6.2 standard distribution. If requirements are ok, just add the following line to your AWStats configuration file:
LoadPlugin="geoip_city_maxmind GEOIP_STANDARD /pathto/GeoIPCity.dat"
Where /pathto/GeoIPCity.dat is the full path where you stored your City Database file. By enabled this plugin, you will see a new link called 'Cities' on reports menu. For the moment this link works only when AWStats reports are build as CGI (static built not yet supported).
# Plugin: GeoIP_ISP_Maxmind
# Perl modules required: Geo::IP (from Maxmind)
# This plugin add a chart of hits by ISP.
# Note: This plugin need Maxmind GeoIP Perl module AND the ISP database.
# Note: I get some problem with Maxmind Geo::IP Perl module with ActiveState
# on Windows but it works great on Linux with default Perl.
# You need to purchase a license from Maxmind to get/use the ISP database.
# This plugin reduces AWStats speed.
#
#LoadPlugin="geoip_isp_maxmind GEOIP_STANDARD /pathto/GeoIPISP.dat"
Install:
This plugin need AWStats 6.3 or higher and need Geo::IP Perl Module AND the ISP database.
You can purchase the ISP licensed database and updates from Maxmind.
This plugin is provided with AWStats 6.3 standard distribution. If requirements are ok, just add the following line to your AWStats configuration file:
LoadPlugin="geoip_isp_maxmind GEOIP_STANDARD /pathto/GeoIPISP.dat"
Where /pathto/GeoIPISP.dat is the full path where you stored your ISP Database file. By enabled this plugin, you will see a new link called 'ISP' on reports menu. For the moment this link works only when AWStats reports are build as CGI (static built not yet supported).
# Plugin: GeoIP_Org_Maxmind
# Perl modules required: Geo::IP (from Maxmind)
# This plugin add a chart of hits by Organization names.
# Note: This plugin need Maxmind GeoIP Perl module AND the Org database.
# Note: I get some problem with Maxmind Geo::IP Perl module with ActiveState
# on Windows but it works great on Linux with default Perl.
# You need to purchase a license from Maxmind to get/use the Org database.
# This plugin reduces AWStats speed.
#
#LoadPlugin="geoip_org_maxmind GEOIP_STANDARD /pathto/GeoIPOrg.dat"
Install:
This plugin need AWStats 6.3 or higher and need Geo::IP Perl Module AND the Org database.
You can purchase the Org licensed database and updates from Maxmind.
This plugin is provided with AWStats 6.3 standard distribution. If requirements are ok, just add the following line to your AWStats configuration file:
LoadPlugin="geoip_org_maxmind GEOIP_STANDARD /pathto/GeoIPOrg.dat"
Where /pathto/GeoIPOrg.dat is the full path where you stored your Org Database file. By enabled this plugin, you will see a new link called 'Organizations' on reports menu. For the moment this link works only when AWStats reports are build as CGI (static built not yet supported).
Other AWStats contribs/tools/package

All following files/products were developped and submitted by contributors. I haven't tried them, so I can't tell you if they work and how they work...
They can enhance AWStats use or save you time giving you a start for a new development.
Other available packages (provided by contributors):
A SME (E-Smith) package (Based on AWStats 6.0 version)
Cobalt RaQ 3/4/550 Package Files (Based on AWStats 5.9)
Other tools:
InstantCGI.com is an online service that help you to install and setup AWStats easily on your server.
This means that webmasters can use InstantCGI.com service to install scripts directly onto their site, as long as their site is hosted in a Linux/Unix environment.
browsers_phone.pm is a file done for WAP and/or IMode web sites to replace the default browsers.pm file. This browsers.pm file will increase AWStats browser detection capabilities by adding a very detailed list of all phone browsers (Wap, IMode...). By default AWStats report phone browsers constructor name. This file will make AWStats to report the name of phone, for example alcatel-be4 instead of simply alcatel. Nearly 300 phone products are added in this file.
To use it:
1- Save the old browsers.pm file to browsers.orig.pm (in AWStats lib directory).
2- Copy file browsers_phone.pm into AWStats lib directory and rename it to browsers.pm
Next updates will then report phone names.
Logprocess automate the collection, merging, processing and archiving of IIS log files in a hosting (mult-domain) environment using AWStats to generate and manage stats/reports.
AWStats PhpNuke module is a module for the open source CMS PHP Nuke.
AWStats Typo3 module is a seamless integrated module for the open source CMS Typo3.
XlencArlm is a tool to enhance use of AWStats with IIS (Catching log files from FTP, doing GMT correction on log files, ...). Don't know if it works correctly but seems to be interesting.
Configurador is a piece of CGI perl scripts to allow you to edit an AWStats config file from the web. Code comments are in Spanish but it may be a goo start to develop your own tool. Hector Garcia Alvarez
summary4severaldomains.pl is a small perl script that build an index.html page with AWStats txt summary information for each domains on same page (number of pages, hits and bandwith for month).
AWStats - Multiple Site Statistics Viewer, A simple addon script for the AWStats package to allow a user to view statistics for multiple sites (usually Virtual Hosts) on a single page.
AWStats Totals, is a php page that use AWStats database to show a summary for several config files, on the same page.
logtrans.py is a python small example on how to convert an old log file from IIS4.0 to a new format compatible with AWStats. Don't know if it works, just here to provide you a code sample if you like python.
isa2w3c.pl, is a convertor to have a more standard log file from an ISA log file.
Other Non AWStats contribs/tools (not related to AWStats but related to log analysis)

maillog2commonlog.pl converts mail logs in smail or qmail format to the common log format. Note that if you want to analyze, with AWStats, mail log files from postfix, sendmail or qmail, a better solution is to use instead maillogconvert.pl preprocessor (See AWStats F.A.Q about analyzing mail logs).
Joey Hess, freeware.
maillogconv.pl is another mail log processor that can be used to change mail log files into a log file that AWStats can understand.
Note that a derivated and enhanced tool called maillogconvert.pl is provided with AWStats since 5.7. See F.A.Q about analyzing mail logs to know how to setup AWStats with maillogconv.pl or maillogconvert.pl to analyze Postfix, Sendmail, Qmail or MDaemon log files.
mlc is another postfix mail logs converter (written in C). Try it if the maillogconvert.pl tool provided with AWStats does not work on your postfix log file.
access_referer_agent2combined.pl is a perl script that converts a directory of common log format (CLF) access-files, referer-files and agent-files to a single combined.log This is usefull if you have seperate access/referer/agent logfiles and want to use all features of a loganalyzer that require a combined log file.
anonlog "anonymizes" your logfile by encoding sensitive information.
Stephen Turner, freeware.
If you don't like AWStats, you can try thoose other popular similar tools :
Analog. An old log analyzer but still popular (written in C).
Stephen Turner, freeware.
Webalizer. Another popular log analyzer (written in C).
There is also commercial products you can find doing a search on 'log file analyzer' with Google.
Documents on AWStats or related to log analysis

AWStats official documentation for last version can be found here: HTML On line or PDF file
An intro and install doc 'Using AWStats on GNU/Linux or Windows' in Chinese
A setup tutorial in Danish
A setup tutorial in French from Funix: How to install AWStats and Webalizer
A setup tutorial in French from Fpoeserv
A setup tutorial for debian users with a logrotate tool in German