AWStats configuration directives/options :: Record of Life
来源: BlogBus 原始链接: http://www.blogbus.com:80/blogbus/blog/diary.php?diaryid=452056 存档链接: https://web.archive.org/web/20050119040206id_/http://www.blogbus.com:80/blogbus/blog/diary.php?diaryid=452056
Record of Life <<<Frequently Asked Questions + Troubleshooting | 首页 | Little Tips about Security>>> 你的评论 用户登陆 最近更新 在 Linux 上进行自动备份 实时监控linux系统日志,就可以知道系统的启动时间等等! How to Tune the ASPProcessorThreadMax Tuning the Performance and Scalability of ASP Web Applications IIS 不提供 Web 页服务 优化 Internet 信息服务 5.0 Tuning Internet Information Server Performance The Apache + SSL HOWTO NTP 4.x for Windows NT Using ntp with Red Hat Linux/Fedora AWStats configuration directives/options Each directives available in the AWStats config file (.conf) is listed here. They are described using a consistent format. Notes To include an environment variable in any parameter (AWStats will replace it with its value when reading it), follow the example: Parameter="ENVNAME" MAIN SETUP SECTION (Required to make AWStats work) LogFile LogType LogFormat LogSeparator DNSLookup DirData DirCgi DirIcons SiteDomain HostAliases AllowToUpdateStatsFromBrowser AllowFullYearView OPTIONAL SETUP SECTION (Not required but increase AWStats features) EnableLockForUpdate DNSStaticCacheFile DNSLastUpdateCacheFile SkipDNSLookupFor AllowAccessFromWebToAuthenticatedUsersOnly AllowAccessFromWebToFollowingAuthenticatedUsers AllowAccessFromWebToFollowingIPAddresses CreateDirDataIfNotExists BuildHistoryFormat BuildReportFormat SaveDatabaseFilesWithPermissionsForEveryone PurgeLogFile ArchiveLogRecords KeepBackupOfHistoricFiles DefaultFile SkipHosts SkipUserAgents SkipFiles OnlyHosts OnlyUserAgents OnlyFiles NotPageList ValidHTTPCodes ValidSMTPCodes AuthenticatedUsersNotCaseSensitive URLNotCaseSensitive URLWithAnchor URLQuerySeparators URLWithQuery URLWithQueryWithOnlyFollowingParameters URLWithQueryWithoutFollowingParameters URLReferrerWithQuery WarningMessages ErrorMessages DebugMessages NbOfLinesForCorruptedLog SplitSearchString WrapperScript DecodeUA MiscTrackerUrl OPTIONAL ACCURACY SETUP SECTION (Not required but increase AWStats features) LevelForBrowsersDetection LevelForOSDetection LevelForRefererAnalyze LevelForRobotsDetection LevelForSearchEnginesDetection LevelForKeywordsDetection LevelForFileTypesDetection LevelForWormsDetection OPTIONAL APPEARANCE SETUP SECTION (Not required but increase AWStats features) UseFramesWhenCGI DetailedReportsOnNewWindows Expires MaxRowsInHTMLOutput Lang DirLang ShowHeader ShowMenu ShowMonthStats ShowDaysOfMonthStats ShowDaysOfWeekStats ShowHoursStats ShowDomainsStats ShowHostsStats ShowAuthenticatedUsers ShowRobotsStats ShowWormsStats ShowSessionsStats ShowPagesStats ShowCompressionStats ShowFileTypesStats ShowFileSizesStats ShowOSStats ShowBrowsersStats ShowScreenSizeStats ShowOriginStats ShowKeyphrasesStats ShowKeywordsStats ShowMiscStats ShowHTTPErrorsStats ShowSMTPErrorsStats ShowClusterStats AddDataArrayMonthStats AddDataArrayShowDaysOfMonthStats AddDataArrayShowDaysOfWeekStats AddDataArrayShowHoursStats IncludeInternalLinksInOriginSection MaxNbOfDomain MinHitDomain MaxNbOfHostsShown MinHitHost MaxNbOfLoginShown MinHitLogin MaxNbOfRobotShown MinHitRobot MaxNbOfPageShown MaxNbOfOsShown MinHitOs MaxNbOfBrowsersShown MinHitBrowser MinHitFile MaxNbOfScreenSizesShown MinHitScreenSize MaxNbOfRefererShown MinHitRefer MaxNbOfKeywordsShown MinHitKeyword FirstDayOfWeek ShowFlagLinks ShowLinksOnUrl MaxLengthOfURL ShowLinksToWhoIs UseHTTPSLinksForUrl LinksToWhoIs LinksToIPWhoIs HTMLHeadSection HTMLEndSection BarWidth BarHeight Logo LogoLink StyleSheet color_Background color_TableBGTitle color_TableTitle color_TableBG color_TableRowTitle color_TableBGRowTitle color_TableBorder color_text color_titletext color_weekend color_link color_hover color_u color_v color_p color_h color_k color_s color_e color_x PLUGINS LoadPlugin EXTRA ExtraSectionNameX ExtraSectionCodeFilterX ExtraSectionConditionX ExtraSectionFirstColumnTitleX ExtraSectionFirstColumnValuesX ExtraSectionFirstColumnFormatX ExtraSectionStatTypesX ExtraSectionAddAverageRowX ExtraSectionAddSumRowX MaxNbOfExtraX MinHitExtraX ExtraTrackedRowsLimit INCLUDES Include LogFile Version : 1.0+ 3.1+ for tags %YYYY-n,%YY-n,%MM-n,%DD-n,%HH-n 3.2+ for tag %WM-n 4.0+ for tag %DW-n 4.1+ for tag %NS-n 5.0+ for tag %WY-n 5.1+ for tag %Wm-n, %Wy-n, %Dw-n
"LogFile" contains the web, ftp or mail server logfile to analyze.
You can use a full path or relative path from awstats.pl directory.
Example: "/var/log/apache/access.log"
Example: "../logs/mycombinedlog.log"
You can also use tags in this filename if you need a dynamic file name
depending on date or time (Replacement is made by AWStats at the beginning
of its execution). This is available tags :
%YYYY-n is replaced with 4 digits year we were n hours ago
%YY-n is replaced with 2 digits year we were n hours ago
%MM-n is replaced with month we were n hours ago
%MO-n is replaced with 3 letters month we were n hours ago
%DD-n is replaced with day we were n hours ago
%HH-n is replaced with hour we were n hours ago
%NS-n is replaced with number of seconds at 00:00 since 1970
%WM-n is replaced with the week number in month (1-5)
%Wm-n is replaced with the week number in month (0-4)
%WY-n is replaced with the week number in year (01-52)
%Wy-n is replaced with the week number in year (00-51)
%DW-n is replaced with the day number in week (1-7, 1=sunday)
use n=24 if you need (1-7, 1=monday)
%Dw-n is replaced with the day number in week (0-6, 0=sunday)
use n=24 if you need (0-6, 0=monday)
Use 0 for n if you need current year, month, day, hour...
Example: "/var/log/access_log.%YYYY-0%MM-0%DD-0.log"
Example: "C:/WINNT/system32/LogFiles/W3SVC1/ex%YY-24%MM-24%DD-24.log"
You can also use a pipe if log file come from a pipe.
Example: "gzip -d </var/log/apache/access.log.gz |"
If there is several log files from load balancing servers :
Example: "/pathtotools/logresolvemerge.pl *.log |"
LogFile="/var/log/httpd/mylog.log" LogType Version : 5.7+
Enter the log file type you want to analyze.
Possible values:
W - For a web log file
M - For a mail log file
F - For a ftp log file
Example: W
Default: W
LogType=W LogFormat Version : 2.1+ 3.1+ for tags %host,%logname,%time1,%time2,%methodurl,%methodurlnoprot,%method,%url, %query,%code,%bytesd,%refererquot,%referer,%uaquot,%ua,%other 3.2+ for tags %gzipin,%gzipout 4.0+ for tags %gzipratio,%syslog 4.1+ for tag %virtualname 5.6+ for tag %deflateratio 6.1+ for tag %time4 6.2+ for tag %time3
Enter here your log format (Must agree with your web server. See setup
instructions in README.txt to know how to configure your web server to have
the required log format).
Possible values: 1,2,3,4 or "your_own_personalized_log_format"
1 - Apache or Lotus Notes/Domino native combined log format (NCSA combined/XLF/ELF log format)
2 - Old IIS log format (IIS W3C log format). See FAQ for IIS 6.x.
3 - Webstar native log format.
4 - Apache or Squid native common log format (NCSA common/CLF log format)
With LogFormat=4, some features (browsers, os, keywords...) can't work.
"your_own_personalized_log_format" = If your log is ftp, mail or other format,
you must use following keys to define the log format string (See FAQ
for ftp, mail or exotic web log format examples):
%host Host client name or IP address
%lognamequot Authenticated login/user with format: "alex"
%logname Authenticated login/user with format: alex
%time1 Date and time with format: [dd/mon/yyyy:hh:mm:ss +0000] or [dd/mon/yyyy:hh:mm:ss]
%time2 Date and time with format: yyyy-mm-dd hh-mm-ss
%time3 Date and time with format: Mon dd hh:mm:ss or Mon dd hh:mm:ss yyyy
%time4 Date and time with unix timestamp format: dddddddddd
%methodurl Method and URL with format: "GET /index.html HTTP/x.x"
%methodurlnoprot Method and URL with format: "GET /index.html"
%method Method with format: GET
%url URL only with format: /index.html
%query Query string (used by URLWithQuery option)
%code Return code status (with format for web log: 999)
%bytesd Size of document in bytes
%refererquot Referer page with format: "http://from.com/from.htm"
%referer Referer page with format: http://from.com/from.htm
%uaquot User agent with format: "Mozilla/4.0 (compatible, ...)"
%ua User agent with format: Mozilla/4.0_(compatible...)
%gzipin mod_gzip compression input bytes: In:XXX
%gzipout mod_gzip compression output bytes & ratio: Out:YYY:ZZpct.
%gzipratio mod_gzip compression ratio: ZZpct.
%deflateratio mod_deflate compression ratio with format: (ZZ)
%email EMail sender (for mail log)
%email_r EMail receiver (for mail log)
%virtualname Web sever virtual hostname. Use this tag when same log
contains data of several virtual web servers. AWStats
will discard records not in SiteDomain nor HostAliases
%cluster If log file is provided from several computers (merged by
logresolvemerge.pl), this tag define field of cluster id.
If your log format has some fields not included in this list, use
%other Means another field
Examples for Apache combined logs (following two examples are equivalent):
LogFormat = 1
LogFormat = "%host %other %logname %time1 %methodurl %code %bytesd %refererquot %uaquot"
Examples for IIS (following two examples are equivalent):
LogFormat = 2
LogFormat = "%time2 %host %logname %method %url %code %bytesd %other %ua %referer"
LogFormat=1 LogSeparator Version : 5.0+
If your log field's separator is not a space, you can change this parameter.
This parameter is not used if LogFormat is a predefined value (1,2,3,4)
Example: " "
Example: "\t"
Example: "|"
Default: " "
LogSeparator=" " DNSLookup Version : 1.0+ (5.0+ for value 2)
If you want to have hosts reported by name instead of ip address, AWStats
need to make reverse DNS lookups (if not already done in your log file).
With DNSLookup to 0, all hosts will be reported by their IP addresses and
not by the full hostname of visitors (except if names are already available
in log file).
If you want/need to set DNSLookup to 1, don't forget that this will reduce
dramatically AWStats update process speed. Do not use on large web sites.
Note: Reverse DNS lookup is done on IPv4 only (Enable ipv6 plugin for IPv6).
Note: Result of DNS Lookup can be used to build the Country report. However
it is highly recommanded to enable the plugin 'geoipfree' or 'geoip' to
have an accurate Country report with no need of DNS Lookup.
Possible values:
0 - No DNS Lookup
1 - DNS Lookup is fully enabled
2 - DNS Lookup is made only from static DNS cache file (if it exists)
Default: 2
DNSLookup=2 DirData Version : 1.0+
When AWStats updates its statistics, it stores results of its analysis in
files (AWStats database). All those files are written in the directory
defined by the "DirData" parameter. Set this value to the directory where
you want AWStats to save its database and working files into.
Warning: If you want to be able to use the "AllowToUpdateStatsFromBrowser"
feature (see later), you need write permissions by webserver user on this
directory.
Example: "/var/lib/awstats"
Example: "../data"
Example: "C:/awstats_data_dir"
Default: "." (means same directory as awstats.pl)
DirData="." DirCgi Version : 1.0+
Relative or absolute web URL of your awstats cgi-bin directory.
This parameter is used only when AWStats is ran from command line
with -output option (to generate links in HTML reported page).
Example: "/awstats"
Default: "/cgi-bin" (means awstats.pl is in "/yourwwwroot/cgi-bin")
DirCgi="/cgi-bin" DirIcons Version : 1.0+
Relative or absolute web URL of your awstats icon directory.
If you build static reports ("... -output > outputpath/output.html"), enter
path of icon directory relative to the output directory 'outputpath'.
Example: "/awstatsicons"
Example: "../icon"
Default: "/icon" (means you must copy icon directories in "/mywwwroot/icon")
DirIcons="/icon" SiteDomain Version : 3.2+
"SiteDomain" must contain the main domain name or the main intranet web
server name used to reach the web site.
If you share the same log file for several virtual web servers, this
parameter is used to tell AWStats to filter record that contains records for
this virtual host name only (So check that this virtual hostname can be
found in your log file and use a personalized log format that include the
%virtualname tag).
But for multi hosting a better solution is to have one log file for each
virtual web server. In this case, this parameter is only used to generate
full URL's links when ShowLinksOnUrl option is set to 1.
If analysing mail log, enter here the domain name of mail server.
Example: "myintranetserver"
Example: "www.domain.com"
Example: "ftp.domain.com"
Example: "domain.com"
SiteDomain="" HostAliases Version : 1.0+ (5.6+ for REGEX syntax)
Enter here all other possible domain names, addresses or virtual host
aliases someone can use to access your site. Try to keep only the minimum
number of possible names/addresses to have the best performances.
You can repeat the "SiteDomain" value in this list.
This parameter is used to analyze referer field in log file and to help
AWStats to know if a referer URL is a local URL of same site or an URL of
another site.
Note: Use space between each value.
Note: You can use regular expression values writing value with REGEX[value].
Example: "www.myserver.com localhost 127.0.0.1 REGEX[.mydomain.(net|org)$]"
HostAliases="localhost 127.0.0.1 REGEX[^.*.myserver.com$]" AllowToUpdateStatsFromBrowser Version : 3.0+
When this parameter is set to 1, AWStats add a button on report page to
allow to "update" statistics from a web browser. Warning, when "update" is
made from a browser, AWStats is ran as a CGI by the web server user
defined in your web server (user "nobody" by default with Apache, "IUSR_XXX"
with IIS), so the "DirData" directory and all already existing history files
(awstatsMMYYYY[.xxx].txt) must be writable by this user. Change permissions
if required.
Warning: Update process can be long so you might experience "time out"
browser errors if you don't launch AWStats enough frequently.
When set to 0, update is only made when AWStats is ran from the command
line interface (or a task scheduler).
Possible values: 0 or 1
Default: 0
AllowToUpdateStatsFromBrowser=0 AllowFullYearView Version : 5.9+
AWStats save and sort its database on a month basis, this allows to build
build a report quickly. However, if you choose the -month=all from command
line or value '-Year-' from CGI combo form to have a report for all year,
AWStats needs to reload all data for full year, and resort them completely,
requiring a large amount of time, memory and CPU. This might be a problem
for web hosting providers that offer AWStats for large sites on shared
servers to non CPU cautious customers.
For this reason, the 'full year' is only enable on Command Line by default.
You can change this by setting this parameter to 0, 1, 2 or 3.
Possible values:
0 - Never allowed
1 - Allowed on CLI only, -Year- value in combo is not visible
2 - Allowed on CLI only, -Year- value in combo is visible but not allowed
3 - Possible on CLI and CGI
Default: 2
AllowFullYearView=2 EnableLockForUpdate Version : 5.0+
When the update process run, AWStats can set a lock file in TEMP or TMP
directory. This lock is to avoid to have 2 update processes running at the
same time to prevent unknown conflicts problems and avoid DoS attacks when
AllowToUpdateStatsFromBrowser is set to 1.
Because, when you use lock file, you can experience sometimes problems in
lock file not correctly removed (killed process for example requires that
you remove the file manualy), this option is not enabled by default (Do
not enable this option with no console server access).
Possible values: 0 or 1
Default: 0
EnableLockForUpdate=0 DNSStaticCacheFile Version : 5.0+
AWStats can do reverse DNS lookups through a static DNS cache file that was
previously created manually. If no path is given in static DNS cache file
name, AWStats will search DirData directory. This file is never changed.
This option is not used if DNSLookup=0.
Note: DNS cache file format is 'minsince1970 ipaddress resolved_hostname'
or just 'ipaddress resolved_hostname'
Example: "/mydnscachedir/dnscache"
Default: "dnscache.txt"
DNSStaticCacheFile="dnscache.txt" DNSLastUpdateCacheFile Version : 5.0+
AWStats can do reverse DNS lookups through a DNS cache file that was created
by a previous run of AWStats. This file is erased and recreated after each
statistics update process. You don't need to create and/or edit it.
AWStats will read and save this file in DirData directory.
This option is used only if DNSLookup=1.
Note: If a DNSStaticCacheFile is available, AWStats will check for DNS
lookup in DNSLastUpdateCacheFile after checking into DNSStaticCacheFile.
Example: "/mydnscachedir/dnscachelastupdate"
Default: "dnscachelastupdate.txt"
DNSLastUpdateCacheFile="dnscachelastupdate.txt" SkipDNSLookupFor Version : 3.0+ (5.6+ for REGEX syntax)
You can specify specific IP addresses that should NOT be looked up in DNS.
This option is used only if DNSLookup=1.
Note: Use space between each value.
Note: You can use regular expression values writing value with REGEX[value].
Change : Effective for new updates only
Example: "123.123.123.123 REGEX[^192.168.]"
Default: ""
SkipDNSLookupFor="" AllowAccessFromWebToAuthenticatedUsersOnly Version : 4.0+
The following two parameters allow you to protect a config file from being
read by AWStats when called from a browser if web user has not been
authenticated. Your AWStats program must be in a web protected "realm" (With
Apache, you can use .htaccess files to do so. With other web servers, see
your server setup manual).
Change : Effective immediatly
Possible values: 0 or 1
Default: 0
AllowAccessFromWebToAuthenticatedUsersOnly=0 AllowAccessFromWebToFollowingAuthenticatedUsers Version : 4.0+
This parameter gives the list of all authorized authenticated users to view
statistics for this domain/config file. This parameter is used only if
AllowAccessToAuthenticatedUsersOnly is set to 1.
Change : Effective immediatly
Example: "user1 user2"
Default: ""
AllowAccessFromWebToFollowingAuthenticatedUsers="" AllowAccessFromWebToFollowingIPAddresses Version : 5.0+
When this parameter is defined to something, the IP address of the user that
read its statistics from a browser (when AWStats is used as a CGI) is
checked and must match one of the IP address values or ranges.
Change : Effective immediatly
Example: "127.0.0.1 123.123.123.1-123.123.123.255"
Default: ""
AllowAccessFromWebToFollowingIPAddresses="" CreateDirDataIfNotExists Version : 4.0+
If the "DirData" directory (see above) does not exists, AWStats return an
error. However, you can ask AWStats to create it.
This option can be used by some Web Hosting Providers that has defined a
dynamic value for DirData (for example DirData="/home/REMOTE_USER") and
don't want to have to create a new directory each time they add a new user.
Change : Effective immediatly
Possible values: 0 or 1
Default: 0
CreateDirDataIfNotExists=1 BuildHistoryFormat Version : 6.0+
You can choose in which format the Awstats history database is saved.
Note: Using "xml" format make AWStats building database files three times
larger than using "text" format.
Change : Database format is switched after next update
Possible values: text or xml
Default: text
BuildHistoryFormat=text BuildReportFormat Version : 6.0+
If you prefer having the report output pages be built as XML compliant pages
instead of simple HTML pages, you can set this to 'xhtml' (May not works
properly with old browsers).
Possible values: html or xhtml
Default: html
BuildReportFormat=html SaveDatabaseFilesWithPermissionsForEveryone Version : 4.0+
In most case, AWStats is used as a cgi program. So AWStats process is ran
by default web server user (nobody for Unix, IUSR_xxx for IIS/Windows,...).
To make use easier and avoid permission problems between update process
(run by an admin user) and CGI process (ran by a low level user), AWStats
save its database files with read and write for everyone.
If you have experience on managing security policies (Web Hosting Provider),
you should set this parameter to 0. AWStats will keep default process user
permissions on its files.
Possible values: 0 or 1
Default: 1
SaveDatabaseFilesWithPermissionsForEveryone=1 PurgeLogFile Version : 2.23+
AWStats can purge log file, after analyzing it. Note that AWStats is able
to detect new lines in a log file, to process only them, so you can launch
AWStats as often as you want, even with this parameter to 0.
With 0, no purge is made, so you must use a scheduled task or a web server
that make this purge frequently.
With 1, the purge of the log file is made each time AWStats is ran.
This parameter doesn't work with IIS (This web server doesn't let its log
file to be purged).
Possible values: 0 or 1
Default: 0
PurgeLogFile=0 ArchiveLogRecords Version : 2.1+
When PurgeLogFile is setup to 1, AWStats will clean your log file after
processing it. You can however keep an archive file (saved in "DirData") of
all processed log records by setting this to 1 (For example if you want to
use another log analyzer).
This parameter is not used if PurgeLogFile=0
Possible values: 0 or 1
Default: 0
ArchiveLogRecords=0 KeepBackupOfHistoricFiles Version : 3.2+
Each time you run the update process, AWStats overwrite the 'historic file'
for the month (awstatsMMYYYY[.*].txt) with the updated one.
When write errors occurs (IO, disk full,...), this historic file can be
corrupted and must be deleted. Because this file contains information of all
past processed log files, you will loose old stats if removed. So you can
ask AWStats to save last non corrupted file in a .bak file. This file is
stored in "DirData" directory with other 'historic files'.
Possible values: 0 or 1
Default: 0
KeepBackupOfHistoricFiles=0 DefaultFile Version : 1.0+ (5.0+ can accept several values)
Default index page name for your web server.
Change : Effective for new updates only
Example: "index.php index.html default.html"
Default: "index.html"
DefaultFile="index.html" SkipHosts Version : 1.0+ (5.6+ for REGEX syntax)
Do not include access from clients that match following criteria.
If your log file contains IP adresses in host field, you must enter here
matching IP adresses criteria.
If DNS lookup is already done in your log file, you must enter here hostname
criteria, else enter ip address criteria.
The opposite parameter of "SkipHosts" is "OnlyHosts".
Note: Use space between each value.
Note: You can use regular expression values writing value with REGEX[value].
Change : Effective for new updates only
Example: "127.0.0.1 REGEX[^192.168.] REGEX[^10.0.0.]"
Example: "localhost REGEX[^.*.localdomain$]"
Default: ""
SkipHosts="" SkipUserAgents Version : 5.1+ (5.6+ for REGEX syntax)
Do not include access from clients with a user agent that match following
criteria. If you want to exclude a robot, you should update the robots.pm
file instead of this parameter.
The opposite parameter of "SkipUserAgents" is "OnlyUserAgents".
Note: Use space between each value. This parameter is not case sensitive.
Note: You can use regular expression values writing value with REGEX[value].
Change : Effective for new updates only
Example: "konqueror REGEX[ua_test_v\d.\d]"
Default: ""
SkipUserAgents="" SkipFiles Version : 1.0+ (5.6+ for REGEX syntax)
Use SkipFiles to ignore access to URLs that match one of following entries.
You can enter a list of not important URLs (like framed menus, hidden pages,
etc...) to exclude them from statistics. You must enter here exact relative
URL as found in log file, or a matching REGEX value.
For example, to ignore /badpage.html, just add "/badpage.html". To ignore
all pages in a particular directory, add "REGEX[^/directorytoexclude]".
The opposite parameter of "SkipFiles" is "OnlyFiles".
Note: Use space between each value. This parameter is or not case sensitive
depending on URLNotCaseSensitive parameter.
Note: You can use regular expression values writing value with REGEX[value].
Change : Effective for new updates only
Example: "/badpage.html REGEX[^/excludedirectory]"
Default: ""
SkipFiles="" OnlyHosts Version : 5.2+ (5.6+ for REGEX syntax)
Include in stats, only accesses from hosts that match one of following
entries. For example, if you want AWStats to filter access to keep only
stats for visits from particular hosts, you can add those hosts names in
this parameter.
If DNS lookup is already done in your log file, you must enter here hostname
criteria, else enter ip address criteria.
The opposite parameter of "OnlyHosts" is "SkipHosts".
Note: Use space between each value. This parameter is not case sensitive.
Note: You can use regular expression values writing value with REGEX[value].
Change : Effective for new updates only
Example: "127.0.0.1 REGEX[^192.168.] REGEX[^10.0.0.]"
Default: ""
OnlyHosts="" OnlyUserAgents Version : 5.8+
Include in stats, only accesses from user agent that match one of following
entries. For example, if you want AWStats to filter access to keep only
stats for visits from particular browsers, you can add their user agents
string in this parameter.
The opposite parameter of "OnlyUserAgents" is "SkipUserAgents".
Note: Use space between each value. This parameter is not case sensitive.
Note: You can use regular expression values writing value with REGEX[value].
Change : Effective for new updates only
Example: "msie"
Default: ""
OnlyUserAgents="" OnlyFiles Version : 3.0+ (5.6+ for REGEX syntax)
Include in stats, only accesses to URLs that match one of following entries.
For example, if you want AWStats to filter access to keep only stats that
match a particular string, like a particular directory, you can add this
directory name in this parameter.
The opposite parameter of "OnlyFiles" is "SkipFiles".
Note: Use space between each value. This parameter is or not case sensitive
depending on URLNotCaseSensitive parameter.
Note: You can use regular expression values writing value with REGEX[value].
Change : Effective for new updates only
Example: "REGEX[marketing_directory] REGEX[office/.*.(csv|sxw)$]"
Default: ""
OnlyFiles="" NotPageList Version : 3.2+
Add here a list of kind of url (file extension) that must be counted as
"Hit only" and not as a "Hit" and "Page/Download". You can set here all
images extensions as they are hit downloaded that must be counted but they
are not viewed pages. URLs with such extensions are not included in the TOP
Pages/URL report.
Note: If you want to exclude particular URLs from stats (No Pages and no
Hits reported), you must use SkipFiles parameter.
Example: "css js class gif jpg jpeg png bmp zip arj gz z wav mp3 wma mpg"
Example: ""
Default: "css js class gif jpg jpeg png bmp"
NotPageList="css js class gif jpg jpeg png bmp" ValidHTTPCodes Version : 4.0+
By default, AWStats considers that records found in log file are successful
hits if HTTP code returned by server is a valid HTTP code (200 and 304).
Any other code are reported in HTTP error chart.
However in some specific environment, with web server HTTP redirection,
you can choose to also accept other codes.
Example: "200 304 302 305"
Default: "200 304"
ValidHTTPCodes="200 304" This is examples of current HTTP codes #[Miscellaneous successes] "2xx", "[Miscellaneous successes]", "200", "OK", # HTTP request OK "201", "Created", "202", "Request recorded, will be executed later", "203", "Non-authoritative information", "204", "Request executed", "205", "Reset document", "206", "Partial Content", #[Miscellaneous redirections] "3xx", "[Miscellaneous redirections]", "300", "Multiple documents available", "301", "Moved Permanently", "302", "Found", "303", "See other document", "304", "Not Modified since last retrieval", # HTTP request OK "305", "Use proxy", "306", "Switch proxy", "307", "Document moved temporarily", #[Miscellaneous client/user errors] "4xx", "[Miscellaneous client/user errors]", "400", "Bad Request", "401", "Unauthorized", "402", "Payment required", "403", "Forbidden", "404", "Document Not Found", "405", "Method not allowed", "406", "ocument not acceptable to client", "407", "Proxy authentication required", "408", "Request Timeout", "409", "Request conflicts with state of resource", "410", "Document gone permanently", "411", "Length required", "412", "Precondition failed", "413", "Request too long", "414", "Requested filename too long", "415", "Unsupported media type", "416", "Requested range not valid", "417", "Failed", #[Miscellaneous server errors] "5xx", "[Miscellaneous server errors]", "500", "Internal server Error", "501", "Not implemented", "502", "Received bad response from real server", "503", "Server busy", "504", "Gateway timeout", "505", "HTTP version not supported", "506", "Redirection failed", #[Unknown] "xxx" ,"[Unknown]" ValidSMTPCodes Version : 5.0+
By default, AWStats considers that records found in mail log file are
successful mail transfers if field that represent return code in analyzed
log file match values defined by this parameter.
Change : Effective for new updates only
Example: "1 250 200"
Default: "1 250"
ValidSMTPCodes="1 250" AuthenticatedUsersNotCaseSensitive Version : 5.3+
Some web servers on some Operating systems (IIS-Windows) considers that a
login with same value but different case are the same login. To tell AWStats
to also considers them as one, set this parameter to 1.
Possible values: 0 or 1
Default: 0
AuthenticatedUsersNotCaseSensitive=0 URLNotCaseSensitive Version : 5.1+
Some web servers on some Operating systems (IIS-Windows) considers that two
URLs with same value but different case are the same URL. To tell AWStats to
also considers them as one, set this parameter to 1.
Possible values: 0 or 1
Default: 0
URLNotCaseSensitive=0 URLWithAnchor Version : 5.4+
Keep or remove the anchor string you can find in some URLs.
Possible values: 0 or 1
Default: 0
URLWithAnchor=0 URLQuerySeparators Version : 5.2+
In URL links, "?" char is used to add parameter's list in URLs. Syntax is:
/mypage.html?param1=value1
However, some servers/sites have also others chars to isolate dynamic part of
their URLs. You can complete this list with all such characters.
Example: "?;,"
Default: "?;"
URLQuerySeparators="?;" URLWithQuery Version : 3.2+
Keep or remove the query string to the URL in the statistics for individual
pages. This is primarily used to differentiate between the URLs of dynamic
pages. If set to 1, mypage.html?id=x and mypage.html?id=y are counted as two
different pages.
Warning, when set to 1, memory required to run AWStats is dramatically
increased if you have a lot of changing URLs (for example URLs with a random
id inside). Such web sites should not set this option to 1 or use seriously
the next parameter URLWithQueryWithoutFollowingParameters.
Possible values:
0 - URLs are cleaned from the query string (ie: "/mypage.html")
1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y")
Default: 0
URLWithQuery=0 URLWithQueryWithOnlyFollowingParameters Version : 6.0+
When URLWithQuery is on, you will get the full URL with all parameters in
URL reports. But among thoose parameters, sometimes you don't need a
particular parameter because it does not identify the page or because it's
a random ID changing for each access even if URL points to same page. In
such cases, it is higly recommanded to ask AWStats to keep only parameters
you need (if you know them) before counting, manipulating and storing URL.
Enter here list of wanted parameters. For example, with "param", one hit on
/mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r
will be reported as 2 hits on /mypage.cgi?param=abc
This parameter is not used when URLWithQuery is 0 and can't be used with
URLWithQueryWithoutFollowingParameters.
Change : Effective for new updates only
Example: "param"
Default: ""
URLWithQueryWithOnlyFollowingParameters="" URLWithQueryWithoutFollowingParameters Version : 5.1+
When URLWithQuery is on, you will get the full URL with all parameters in
URL reports. But among thoose parameters, sometimes you don't need a
particular parameter because it does not identify the page or because it's
a random ID changing for each access even if URL points to same page. In
such cases, it is higly recommanded to ask AWStats to remove such parameters
from the URL before counting, manipulating and storing URL. Enter here list
of all non wanted parameters. For example, if you enter "id", one hit on
/mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r
will be reported as 2 hits on /mypage.cgi?param=abc
This parameter is not used when URLWithQuery is 0 and can't be used with
URLWithQueryWithOnlyFollowingParameters.
Change : Effective for new updates only
Example: "PHPSESSID jsessionid"
Default: ""
URLWithQueryWithoutFollowingParameters="" URLReferrerWithQuery Version : 5.1+
Keep or remove the query string to the referrer URL in the statistics for
external referrer pages. This is used to differentiate between the URLs of
dynamic referrer pages. If set to 1, mypage.html?id=x and mypage.html?id=y
are counted as two different referrer pages.
Possible values:
0 - Referrer URLs are cleaned from the query string (ie: "/mypage.html")
1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y")
Default: 0
URLReferrerWithQuery=0 WarningMessages Version : 1.0+
AWStats can detect setup problems or show you important informations to have
a better use. Keep this to 1, except if AWStats says you can change it.
Possible values: 0 or 1
Default: 1
WarningMessages=1 ErrorMessages Version : 5.2+
When an error occurs, AWStats output a message related to errors. If you
want (in most cases for security reasons) to have no error messages, you
can set this parameter to your personalized generic message.
Example: "An error occured. Contact your Administrator"
Default: ""
ErrorMessages="" DebugMessages Version : 5.2+
AWStat can be run with debug=x parameter to ouput various informations
to help in debugging or solving troubles. If you want (in most cases for
security reasons) to disable debugging, set this parameter to 0.
Possible values: 0 or 1
Default: 1
DebugMessages=1 NbOfLinesForCorruptedLog Version : 3.2+
To help you to detect if your log format is good, AWStats report an error
if all the first NbOfLinesForCorruptedLog lines have a format that does not
match the LogFormat parameter.
However, some worm virus attack on your web server can result in a very high
number of corrupted lines in your log. So if you experience awstats stop
because of bad virus records at the beginning of your log file, you can
increase this parameter (very rare).
Default: 50
NbOfLinesForCorruptedLog=50 SplitSearchString Version : 2.24 - 4.0 (deprecated since 4.1) This parameter has been removed since 4.1. AWStats 4.1+ supports both keywords AND keyphrases by default with no need of any parameter. WrapperScript Version : 4.0+
For some particular integration needs, you may want to have CGI links to
point to another script than awstats.pl.
Use the name of this script in WrapperScript parameter.
Example: "awstatslauncher.pl"
Default: ""
WrapperScript="" DecodeUA Version : 5.0+
DecodeUA must be set to 1 if you use Roxen web server. This server converts
all spaces in user agent field into %20. This make the AWStats robots, os
and browsers detection fail in some cases. Just change it to 1 if and only
if your web server is Roxen.
Possible values: 0 or 1
Default: 0
DecodeUA=0 MiscTrackerUrl Version : 5.6+
MiscTrackerUrl can be used to make AWStats able to detect some miscellanous
things, that can not be tracked on other way like:
- Screen size
- Screen color depth
- Java enabled
- Macromedia Director plugin
- Macromedia Shockwave plugin
- Realplayer G2 plugin
- QuickTime plugin
- Mediaplayer plugin
- Acrobat PDF plugin
To enable all this features, you must copy the awstats_misc_tracker.js file
into a /js/ directory stored in your web document root and add the following
HTML code at the end of your index page (before ) :
If code is not added in index page, all this detection capabilities will be
disabled. You must also check that ShowScreenSizeStats and ShowMiscStats
parameters are set to 1 to make results appear in report page.
If you want to use another directory than /js/, you must also change the
awstatsmisctrackerurl variable into the awstats_misc_tracker.js file.
Change : Effective for new updates only.
Possible value: Full URL of javascript tracker file added in HTML code
Default: "/js/awstats_misc_tracker.js"
MiscTrackerUrl="/js/awstats_misc_tracker.js" LevelFor Version : 4.0+ 6.0+ for LevelForFileTypesDetection, LevelForSearchEnginesDetection, LevelForKeywordsDetection, LevelForWormsDetection
Following values allows you to define accuracy of AWStats entities (robots,
browsers, os, referers, file types) detection.
It might be a good idea for large web sites or ISP that provides AWStats to
high number of customers, to set this parameter to 1 (or 0), instead of 2.
Possible values:
0 = No detection,
1 = Medium/Standard detection
2 = Full detection
Change : Effective for new updates only
Default: 2 (0 for LevelForWormsDetection)
LevelForBrowsersDetection=2 # 0 disables Browsers detection.
2 reduces AWStats speed by 2%
LevelForOSDetection=2 # 0 disables OS detection.
2 reduces AWStats speed by 3%
LevelForRefererAnalyze=2 # 0 disables Origin detection.
2 reduces AWStats speed by 14%
LevelForRobotsDetection=2 # 0 disables Robots detection.
2 reduces AWStats speed by 2.5%
LevelForSearchEnginesDetection=2 # 0 disables Search engines detection.
2 reduces AWStats speed by 9%
LevelForKeywordsDetection=2 # 0 disables Keyphrases/Keywords detection.
2 reduces AWStats speed by 1%
LevelForFileTypesDetection=2 # 0 disables File types detection.
2 reduces AWStats speed by 1%
LevelForWormsDetection=0 # 0 disables Worms detection.
2 reduces AWStats speed by 15%
UseFramesWhenCGI Version : 5.0+
When you use AWStats as a CGI, you can have the reports shown in HTML views.
Frames are only available for report viewed dynamically. When you build
pages from command line, this option is not used and no frames are built.
Possible values: 0 or 1
Default: 1
UseFramesWhenCGI=1 DetailedReportsOnNewWindows Version : 4.1+ (5.0+ for value 2)
This parameter ask your browser to open detailed reports into a different
window than the main page.
Possible values:
0 - Open all in same browser window
1 - Open detailed reports in another window except if using frames
2 - Open always in a different window even if reports are framed
Default: 1
DetailedReportsOnNewWindows=1 Expires Version : 3.1+
You can add, in the HTML report page, a cache lifetime (in seconds) that
will be returned to browser in HTTP header answer by server.
This parameter is not used when report are built with -staticlinks option.
Example: 3600
Default: 0
Expires=0 MaxRowsInHTMLOutput Version : 4.0+
To avoid too large web pages, you can ask AWStats to limit number of rows of
all reported charts to this number when no other limit apply.
Default: 1000
MaxRowsInHTMLOutput=1000 Lang Version : 2.1+
Set your primary language.
Possible value:
Albanian=al, Bosnian=ba, Bulgarian=bg,
Chinese (Taiwan)=tw, Chinese (Simpliefied)=cn, Czech=cz,
Danish=dk, Dutch=nl, English=en, Estonian=et, Finnish=fi, French=fr,
German=de, Greek=gr, Hebrew=he, Hungarian=hu, Indonesian=id, Italian=it,
Japanese=jp, Korean=kr, Latvian=lv, Norwegian (Nynorsk)=nn,
Norwegian (Bokmal)=nb, Polish=pl, Portuguese=pt, Portuguese (Brazilian)=br,
Romanian=ro, Russian=ru, Serbian=sr, Slovak=sk, Spanish=es,
Spanish (Catalan)=es_cat, Swedish=se, Turkish=tr, Ukrainian=ua, Welsh=wlk.
First available language accepted by browser=auto
Default: "auto"
Lang="auto" DirLang Version : 2.1+
Set the location of language files.
Example: "/usr/share/awstats/lang"
Default: "./lang" (means lang directory is in same location than awstats.pl)
DirLang="./lang" Show... Version : 3.2 - 5.3 for ShowHeader (deprecated since 5.4) 3.2+ for ShowMenu,ShowMonthStats,ShowDaysOfWeekStats,ShowHoursStats, ShowDomainsStats,ShowHostsStats,ShowAuthenticatedUsers,ShowRobotsStats, ShowPagesStats,ShowFileTypesStats,ShowFileSizesStats,ShowBrowsersStats, ShowOSStats,ShowOriginStats,ShowKeyphrasesStats,ShowKeywordsStats,ShowHTTPErrorsStats 3.2 - 5.0 for ShowCompressionStats (deprecated since 5.1, use code C with ShowFileTypesStats instead) 4.1+ for ShowSessionsStats, ShowKeywordsStats 5.1+ for all letters codes 5.5+ for ShowDaysOfMonthStats 5.6+ for ShowMiscStats,ShowSTMPErrorsStats 5.8+ for ShowClusterStats 6.0+ for ShowWormsStats
You choose here which reports you want to see in the main page and what you
want to see in those reports.
Possible values:
0 - Topic is not shown at all
1 - Report is shown with default informations
XYZ - Report is shown with only informations defined by code X,Y,Z...
X,Y,Z... are code letters among the following:
U = Unique visitors
V = Visits
P = Number of pages
H = Number of hits (or mails)
B = Bandwith (or total mail size for mail logs)
L = Last access date
E = Entry pages
X = Exit pages
C = Web compression (mod_gzip,mod_deflate)
M = Average mail size (mail logs)
Show menu header with report links
Default: 1, Possible codes: None
ShowMenu=1
Show monthly chart
Default: UVPHB, Possible codes: UVPHB
ShowMonthStats=UVPHB
Show days of month chart
Default: VPHB, Possible codes: VPHB
ShowDaysOfMonthStats=VPHB
Show days of week chart
Default: PHB, Possible codes: PHB
ShowDaysOfWeekStats=PHB
Show hourly chart
Default: PHB, Possible codes: PHB
ShowHoursStats=PHB
Show domains/country chart
Default: PHB, Possible codes: PHB
ShowDomainsStats=PHB
Show hosts chart
Default: PHBL, Possible codes: PHBL
ShowHostsStats=PHBL
Show authenticated users chart
Default: 0, Possible codes: PHBL
ShowAuthenticatedUsers=0
Show robots chart
Default: HBL, Possible codes: HBL
ShowRobotsStats=HBL
Show worms chart
Default: 0 (See also LevelForWormsDetection if set), Possible codes: HBL
ShowWormsStats=0
Show email senders chart (For use when analyzing mail log files)
Default: 0, Possible codes: HBML
ShowEMailSenders=0
Show email receivers chart (For use when analyzing mail log files)
Default: 0, Possible codes: HBML
ShowEMailReceivers=0
Show session chart
Default: 1, Possible codes: None
ShowSessionsStats=1
Show pages-url chart.
Default: PBEX, Possible codes: PBEX
ShowPagesStats=PBEX
Show file types chart.
Default: HB, Possible codes: HBC
ShowFileTypesStats=HB
Show file size chart (Not yet available)
Default: 1, Possible codes: None
ShowFileSizesStats=0
Show operating systems chart
Default: 1, Possible codes: None
ShowOSStats=1
Show browsers chart
Default: 1, Possible codes: None
ShowBrowsersStats=1
Show screen size cha
jordi 发表于 2004-10-20 14:33 | 引用Trackback(0) | 编辑 评论