trAvis - MANAGER

Edit File: awstats_contrib.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head>
<meta name="description" content="AWStats Documentation - Contrib and resource page">
<meta name="keywords" content="awstats, awstat, log, file, analyzer, contrib, plugins, resources, maxmind, geoipfree, geoip, cities, regions, countries, frontend">
<meta name="robots" content="index,follow">
<meta name="title" content="AWStats Documentation - Contrib and resource page">
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<title>AWStats Documentation - Contrib and resource page</title>
<link rel="stylesheet" href="styles.css" type="text/css">
<link href="https://plus.google.com/+LaurentDestailleur-Open-Source-Expert" rel="publisher" />
</head>

<tbody><tr style="font-family: arial,helvetica,verdana; font-style: normal; font-variant: normal; font-weight: normal; font-size: 10pt; line-height: normal; font-size-adjust: none; font-stretch: normal;">
<td align="center" bgcolor="#9999cc"><a href="/"><img src="images/awstats_logo1.png" border="0"></a></td>
<td align="center" bgcolor="#9999cc">
 
<font style="font-family: arial,helvetica,sans-serif; font-style: normal; font-variant: normal; font-weight: normal; font-size: 16pt; line-height: normal; font-size-adjust: none; font-stretch: normal;" color="#eeeeff">AWStats logfile analyzer 7.8 Documentation 
 
</td>
<td align="center" bgcolor="#9999cc">
&nbsp;
</td>
</tr>

</tbody></table>

<h1 style="font-family: arial,helvetica,sanserif; font-style: normal; font-variant: normal; font-weight: normal; font-size: 26px; line-height: normal; font-size-adjust: none; font-stretch: normal;">Plugins, contribs and related programs</h1>

You will find here description for different kinds of ressource files : 
- <a href="#PLUGINS">AWStats plugins</a> 
- <a href="#CONTRIB">Other AWStats contribs/tools/package</a> 
- <a href="#RELATED">Other Non AWStats contribs/tools (not related to AWStats but related to log analysis)</a> 
- <a href="#DOC">Documents on AWStats or related to log analysis</a>

<a name="PLUGINS"></a> 
AWStats plugins 
<hr>
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 <a href="awstats_config.html#LoadPlugin">LoadPlugin</a> parameter).

<a href="#plugin_standards">Standard free plugins</a> : tooltips, decodeutfkeys, ipv6, hashfiles,&nbsp; userinfo, hostinfo, clusterinfo, urlalias, timehires, timezone, rawlog,
graphapplet, graphgooglechartsapi geoipfree 
<a href="#plugin_geoip">GeoIP Plugins</a> (may require other licensed product to work) :
geoip, geoip_city_maxmind, geoip_asn_maxmind, geoip_region_maxmind,
geoip_isp_maxmind,
geoip_org_maxmind,

<a name="plugin_standards">List of standard plugins</a> (Provided with AWStats) :

Tooltips
 Required Modules: None
 Parameters: None Description: Add&nbsp;tooltips pop-up help boxes to HTML report pages.
&nbsp; Provided with AWStats (5.4+).

DecodeUTFKeys
 Required Modules:&nbsp;Encode and URI::Escape
 Parameters: None Description: Allow AWStats to show correctly (in language charset) keywords/keyphrases
strings even if they were UTF8 coded by the referer search engine.
 Plugin provided with AWStats (6.0+).

IPv6
 Required Modules: Net::IP and Net::DNS
 Parameters: None Description: This plugin gives AWStats capability to make reverse DNS lookup on IPv6&nbsp;addresses.
 Note: IPv6 addresses are currently incompatible with the GeoIP databases Plugin provided with AWStats (5.5+)

HashFiles
 Required Modules:&nbsp;Storable
 Parameters: None Description: AWStats DNS cache files are read/saved as native hash files. This improves
cache file loading speed, especially for very large web sites.

Plugin provided with AWStats (5.1+)

UserInfo
 Required Modules:&nbsp;None
 Parameters: None Description:&nbsp; Add&nbsp;text (Firtname, Lastname, Office Department, ...) to authenticated user&nbsp;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&nbsp;directory.

Plugin provided with AWStats (5.5+)

ClusterInfo
 Required Modules:&nbsp;None
 Parameters: None Description:
Add text (for example a full hostname) to cluster reports for each
cluster
number.&nbsp;A text file called clusterinfo.myconfig.txt, with two
fields (first is&nbsp;cluster number, second is text to show) separated
by a tab character must be&nbsp;created in DirData directory. Note: This plugin is useless if ShowClusterStats is set to 0 or if you don't&nbsp;use a personalized log format that contains %cluster tag.

Plugin provided with AWStats (6.2+)

HostInfo
 Required Modules: Net::XWhois
 Parameters: None Description:&nbsp;Add a column into host chart with a link to open a popup window that shows&nbsp;info on host (like whois records).

Plugin provided with AWStats (6.0+)

UrlAliases
 Required Modules:&nbsp;None
 Parameters: None Description:&nbsp;Add&nbsp;text
(Page title, description...) to URL reports before URL value.&nbsp;A
text file called urlalias.myconfig.txt, with two fields (first is
URL,&nbsp;second is text to show, separated by a tab char) must be
created in DirData&nbsp;directory.
 You can build your urlalias file manually or use <a href="awstats_tools.html#urlaliasbuilder">urlaliasbuilder.pl</a> tool (provided with 5.4+)

Plugin provided with AWStats (5.2+)

TimeHiRes
 Required Modules:&nbsp;Time::HiRes
 Parameters: None Description:&nbsp;Time reported by -showsteps option is in millisecond. For debug purpose.

Plugin provided with AWStats (5.1+)

TimeZone
 Required Modules:&nbsp;Time::Local
 Parameters: &lt;offset or local timezone&gt; Description:
Converts the timezone of log files before processing using the offset
provided in the parameters. This is useful for some IIS users if logs
are stored in GMT or for users who have servers in a different
timezone. You must provide either the abreviated name of the timezone
you wish to convert to or the offset value in hours. For example LoadPlugin="timezone +2" &nbsp;would add two hours to the log timestamps LoadPlugin="timezone CET" &nbsp;would convert the log from GMT to CET Note: This plugin reduces AWStats speed by about 40%! Plugin provided with AWStats (5.1+)

Rawlog
 Required Modules:&nbsp;None
 Parameters: None Description: This
plugin adds a form in AWStats main page to allow users to see
raw&nbsp;content of current log files. A display filter will also be
displayed.
 Plugin provided with AWStats (5.7+)

GraphApplet
 Required Modules:&nbsp;None
 Parameters: None Description:&nbsp;Supported charts are built by a 3D graphic applet.
 LoadPlugin="graphapplet"				# EXPERIMENTAL FEATURE

Plugin provided with AWStats (6.0+)

GraphGoogleChartAPI Required Modules:&nbsp;None
 Parameters: None Description:
Replaces the standard charts with free Google API generated images in
HTML reports. If country data is available and more than one country
has hits, a map will be generated using Google Visualizations. Note:
The machine where reports are displayed must have Internet access for
the charts to be generated. The only data sent to Google includes the
statistic numbers, legend names and country names. Plugin provided with AWStats (6.0+)

<a name="plugin_geoip">&nbsp;</a>
 Maxmind GeoIP Plugin Notes Maxmind
is a company that sells geolocation technology that matches IP
addresses to countries, regions, cities and ISPs. All of their databses
are available for an initial fee and a monthly update subscription and
include greater accuracy and a higher frequency of updating. Some
databases are available for free but they are not updated as often and
may not be as accurate. Install: First choose a database. When downloading a database for AWStats, please download the Binary Format version. Current databases AWStats supports are: Commercial: <a href="http://www.maxmind.com/app/country?rId=awstats">Country</a>, <a href="http://www.maxmind.com/app/region?rId=awstats">Region</a>, <a href="http://www.maxmind.com/app/city?rId=awstats">City</a>, <a href="http://www.maxmind.com/app/organization?rId=awstats">Organization</a>, <a href="http://www.maxmind.com/app/isp?rId=awstats">ISP</a> Open Source <a href="http://www.maxmind.com/app/geolitecountry?rId=awstats">Country</a>, <a href="http://www.maxmind.com/app/geolitecity?rId=awstats">City</a>, <a href="http://www.maxmind.com/app/asnum?rId=awstats">ASN</a> If you choose to purchase a commercial database for country
information, you only need to purchase the one with the greatest level
of detail you want to appear in your report. For example, if you only
want country information, you can purchase just the Country database.
If you want City detail, you do not
need to purcahse the Country and Region databases, just the City
database. (Organization and ISP databases do not include country or
region info so you must purchase those in addition to Country, Region
or City if you desire more information) Next, install the
Geo::IP Perl module. Then choose a Maxmind API to access the databse.
Maxmind also has two Perl API's available for interacting with their
databases. There is a a C/Perl library that will run&nbsp; quickly and
there is a pure Perl API that is a little slower but does not require
any C depdencies. Choose <a href="http://www.maxmind.com/en/city?rId=awstats">one of the API</a>s and install it on your machine. Parameters:
Each GeoIP database can be loaded entirely into memory or lookups can
scan through the file. When editing your AWStats configuration, you
have to specify if you want to use memory or file lookups. Specify
GEOIP_STANDARD for file lookups or GEOIP_MEMORY_CACHE for memory
loading. Please note that the memory method may crash on some Linux
distributions so if that happens, try the standard method. Also, using
the C API with Activestate Perl may crash on Windows machines, so use
the PurePerl module instead. You may also override some
databases by generating a comma seperated text file with IP addresses
and associated data. This is useful if you are reporting on an Intranet
site, have a mixture of internal and external users or the data for a
specific IP is incorrect in the database. You can use the included
geoip_generator tool to create override files. (Overrides only available in AWStats version 6.96 and later) Override Formats: GeoIP
 - ip_address,"countrycode" GeoIP City - 
ip_address,"countrycode","regioncode","cityname","postalcode",latitude,longitude,"metrocode","areacode" GeoIP
 ASN - ip_address,"asn ispname" GeoIP Region - ip_address,"countrycode","regioncode" GeoIP
 Org - ip_address,"organisation" GeoIP ISP - 
ip_address,"ISP" Note: AWStats
does not currently support IPv6 for GeoIP lookups as Maxmind only
offers the country DB with IPv6 at this time. As Maxmind includes IPv6
support in more DBs, we will update AWStats. Enabling GeoIP plugins 
will reduce the speed of AWStats processing. GeoIP
 Required Modules:&nbsp;Geo::IP or Geo::IP::PurePerl (from Maxmind)
 Parameters: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/geoip.dat] &lt;/pathto/override.txt&gt; Description: Country chart is built from an Internet IP-Country database.
 Note: You must choose between using this plugin&nbsp;or the
GeoIPfree plugin&nbsp;(need Perl Geo::IPfree module, database is free
but not up to date).
 Example LoadPlugin="geoip GEOIP_STANDARD /usr/local/geoip.dat /usr/local/geoip_override.txt"

Plugin provided with AWStats (5.2+)

GeoIP_City_Maxmind
 Required Modules:&nbsp;Geo::IP or Geo::IP::PurePerl (from Maxmind)
 Parameters: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPCity.dat] &lt;/pathto/override.txt&gt; Description: This plugin adds a chart of hits by cities (with country and regions&nbsp;informations for major countries).
 
By enabling this plugin, you will see a new link called 'Cities' on 
reports menu. Example LoadPlugin="geoip_city_maxmind GEOIP_STANDARD /usr/local/geoip.dat /usr/local/GeoIPCity_override.txt"

Plugin provided with AWStats (6.2+)

GeoIP_ASN_Maxmind Required Modules:&nbsp;Geo::IP or Geo::IP::PurePerl (from Maxmind)
 Parameters: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPASN.dat] &lt;/pathto/override.txt&gt; &lt;link to AS lookup&gt; Description: This
plugin adds a chart of AS numbers where the host IP address is
registered. This plugin can display some ISP information if included in
the database. You can also provide a link that will be used to lookup
additional registration data. Put the link at the end of the parameter
string and the report page will include the link with the full AS
number at the end. Example LoadPlugin="geoip_asn_maxmind
GEOIP_STANDARD /usr/local/geoip.dat /usr/local/GeoIPASN_override.txt
http://enc.com.au/itools/aut-num.php?autnum="
 Plugin provided with AWStats (6.9+)

GeoIP_Region_Maxmind
(Commercial Only) Required Modules:&nbsp;Geo::IP or Geo::IP::PurePerl (from Maxmind)
 Parameters: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPRegion.dat] &lt;/pathto/override.txt&gt; Description: This plugin adds a chart of hits by regions. Only regions for US and&nbsp;Canada can be detected at this time.
 By enabling 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).
 Example LoadPlugin="geoip_region_maxmind GEOIP_STANDARD /usr/local/GeoIPRegion.dat /usr/local/geoip_override.txt"

Plugin provided with AWStats (6.2+)

GeoIP_ISP_Maxmind
(Commercial Only) Required Modules:&nbsp;Geo::IP or Geo::IP::PurePerl (from Maxmind)
 Parameters: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPISP.dat] &lt;/pathto/override.txt&gt; Description:&nbsp;This plugin adds a chart of hits by ISP.
 By enabling 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).
 Example LoadPlugin="geoip_isp_maxmind GEOIP_STANDARD /usr/local/GeoIPISP.dat /usr/local/geoip_override.txt" Plugin provided with AWStats (6.3+)

GeoIP_Org_Maxmind
(Commercial Only) Required Modules:&nbsp;Geo::IP or Geo::IP::PurePerl (from Maxmind)
 Parameters: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPOrg.dat] &lt;/pathto/override.txt&gt; Description:&nbsp;This plugin adds a chart of hits by Organization names.
 By enabling 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).
 Example LoadPlugin="geoip_org_maxmind GEOIP_STANDARD /usr/local/GeoIPOrg.dat /usr/local/geoip_override.txt" Plugin provided with AWStats (6.3+)

GeoIPfree
 Required Modules:&nbsp;Geo::IPfree version 0.2+ (from Graciliano M.P.)
 Parameters: None Description:&nbsp;Country
chart is built from an Internet IP-Country database.&nbsp;This plugin
is useless for intranet only log files.&nbsp; Note: You must
choose between using this plugin (need Perl Geo::IPfree&nbsp;module,
database is free but not up to date) or the GeoIP plugin
(need&nbsp;Perl Geo::IP module from Maxmind, database is also free and
up to date). Note: Activestate provide a corrupted version of Geo::IPfree 0.2 Perl&nbsp;module, so install it from elsewhere (from <a href="http://www.cpan.org/">www.cpan.org</a> for example).
 This plugin reduces AWStats speed by about 10% !
 Plugin provided with AWStats (5.5+).
 You can find Geo::IPfree Perl Module on :
 - All OS: <a href="http://www.cpan.org/">CPAN site</a>
 - ActiveState: GeoIPfree module provided by Activestate is not working correctly so I removed
the link. You can follow the following setup instead: Download from <a href="http://www.cpan.org/">CPAN site</a>
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 in a long time, so using
the <a href="awstats_contrib.html#geoip">geoip</a> plugin (using the Geo::IP Perl module, now free for countries) is highly recommended.
 You can use the following tool to test your geoipfree setup: <a href="file:///files/testgeoipfree.pl">testgeoipfree.pl</a>. Just
put this file into your plugins directory and run it.

<a name="CONTRIB"></a> 
Other AWStats contribs/tools/package 
<hr>

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 tools:

<a href="https://github.com/ip2location/ip2location_awstats">A plugin for geoip location</a>.

<a href="http://wordpress.org/extend/plugins/awstats-script/">A plugin for WordPress</a> that allow WordPress users
to add tags required by AWStats to report the "miscellanous chart".

<a href="http://sourceforge.net/projects/exim2awstats/">Exim2Awstats</a> is a tool to convert Exim MTA log file to a format readable by AWSTats.

<a href="http://www.digievo.co.uk/software.asp?category=2">Logprocess</a> 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.

<a href="/files/configurador.tgz" target="_new">Configurador</a> 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

<a href="/files/logtrans.py" target="_new">logtrans.py</a> 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.

<a href="http://www.ruwenzori.net/code/go_awstats/" target="_new">go_awstats</a>, is a tool to automate build of
AWStats statics reports for all config files but also for all month.

<a name="RELATED"></a> 
Other Non AWStats contribs/tools (not related to AWStats but related to log analysis) 
<hr>

<a href="/files/maillog2commonlog.pl" target="_new">maillog2commonlog.pl</a> 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
<a href="awstats_faq.html#MAIL">F.A.Q</a> about analyzing mail logs). 
Joey Hess, freeware.

<a href="http://www.kristoffersen.us/software/" target="_new">maillogconv.pl</a> 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 <a href="awstats_faq.html#MAIL">F.A.Q</a> 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.

<a href="/files/access_referer_agent2combined.pl" target="_new">access_referer_agent2combined.pl</a> 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. 
<a href="http://anonlog.sourceforge.net/" target="_new">anonlog</a> "anonymizes" your logfile by encoding sensitive information. 
Stephen Turner, freeware.

If you don't like AWStats, you can try thoose other popular similar tools : 
<a href="http://www.mrunix.net/webalizer/" target="_new">Webalizer</a>. Another very old log analyzer (written in C). 
 
There is also commercial products you can find doing a search on 'log file analyzer' with <a href="http://www.google.com">Google</a>.

<a name="DOC"></a> 
Documents on AWStats or related to log analysis 
<hr>
AWStats official documentation for last version can be found here: <a href="index.html">HTML On line</a> or <a href="awstats.pdf">PDF file</a> 
 
An intro and install doc 'Using AWStats on GNU/Linux or Windows' in <a href="http://www.chedong.com/tech/awstats.html">Chinese</a> 
A setup tutorial in <a href="http://www.baudelet.net/awstats.htm" target="_doc">French for Windows users</a>

<a name="SPONSOR"></a> 
Sponsors 
<hr>


You can make a donation to support AWStats project with this link:
<form action="https://www.paypal.com/cgi-bin/webscr" method="post">
<input type="hidden" name="cmd" value="_s-xclick">
<input type="hidden" name="hosted_button_id" value="8968579">
<input type="image" src="https://www.paypal.com/en_US/i/btn/btn_donateCC_LG_global.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online.">
<img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1">
</form>
 
Special thanks goes to the following sponsor for their important support: 
<a href="https://www.dolibarr.org" target="open source erp and crm project">dolibarr.org</a> 
<a href="http://www.arrestier.fr" target="rhumatologue pessac, talence, bordeaux">arrestier.fr</a> 
<a href="http://www.ballanger-dermatologue.fr" target="dermatologue talence">www.ballanger-dermatologue.fr</a> 
...your name/link here: contact@destailleur.fr...

<hr>

<div class="htmldoc-ignore">

Article written by <a href="https://plus.google.com/+LaurentDestailleur-Open-Source-Expert?Open-Source-Expert?rel=author" rel="author" style="color: #ccc; font-weight: normal;">Laurent Destailleur</a>. 
 
<script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
<g:plusone></g:plusone>

<div id="fb-root"></div>
<script>(function(d, s, id) {
 var js, fjs = d.getElementsByTagName(s)[0];
 if (d.getElementById(id)) return;
 js = d.createElement(s); js.id = id;
 js.src = "//connect.facebook.net/fr_FR/all.js#xfbml=1";
 fjs.parentNode.insertBefore(js, fjs);
}(document, 'script', 'facebook-jssdk'));</script>
<div class="fb-like" data-href="http://www.awstats.org/docs/awstats_contrib.html" data-layout="button_count" data-action="recommend" data-show-faces="false" data-share="true"></div>
 

<a href="https://twitter.com/awstats_project" class="twitter-follow-button" data-show-count="false">Follow @awstats_project</a>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
</div>

</body></html>