Readme for analog3.32

Quick reference

This section is divided into the following parts:

• Notation
• Input and output files
• LOGFORMAT commands
• ALIAS commands
• INCLUDE/EXCLUDE commands
• DNS commands
• Sub-item commands
• LOWMEM commands
• Report commands
• GRAPH commands
• BACK commands
• ROWS commands
• COLS commands
• SORTBY commands
• FLOOR commands
• Hyperlinks
• Language commands
• Cosmetic commands
• Diagnostics

Notation

"stuff"        the word stuff
x y            x followed by y
(x | y)        x or y
[x]            optional x
subset("...")  any letters from the string, in any order
perm("...")    all the letters from the string, in any order
*x             x may contain wildcards * and ? (and often comma-separated list)
x := y         x is defined to be y
COMMAND        the command under discussion

char           a single character
string         a string
digit          a digit
number         a non-negative integer (i.e. a string of digits)
real           a non-negative real number
file           a filename within your server's filespace;
                   e.g. /index.html
localfile      a filename within your system's filespace;
                   e.g. /usr/local/analog.html
localfmtfile   as localfile, but may contain date codes;
                   e.g. /usr/local/analog%y%M.html
referrer       a URL of a referring page;
                   e.g. http://search.yahoo.com/
URL            a URL which may be absolute, or relative to the output page;
                   e.g. images/ or /~fred/images/
                      or http://www.fred.com/images/

Note: I have occasionally opted for clarity above strict accuracy where I don't think it will cause any confusion!

The syntax for commands in general was given earlier: remember that an argument which contains a hash or a space must be put in quotes or parentheses.

Input and output files

Syntax

LOGFILE (*localfile | "-" | "none") [prefix_string]
OUTFILE (localfmtfile | "-" | "none")
CACHEFILE (*localfile | "-" | "none")
CACHEOUTFILE (localfmtfile | "-" | "none")
UNCOMPRESS *localfile program

Examples

LOGFILE /httpd/logs/*
LOGFILE c:\logs\log1,c:\logs\log2
OUTFILE "Hard Disk:Report%Y%M.html"
UNCOMPRESS *.gz "/usr/bin/gzip -cd"

LOGFORMAT commands

Syntax

format_string := (see documentation)
Apache_format_string := (see Apache documentation)
logformat := ("COMMON" | "COMBINED" | "REFERRER" | "BROWSER" | "EXTENDED" |
              "MICROSOFT-NA" | "MICROSOFT-INT" | "WEBSITE-NA" | "WEBSITE-INT" |
              "MS-EXTENDED" | "MS-COMMON" | "NETSCAPE" | "WEBSTAR" | "AUTO" |
              format_string)
LOGFORMAT logformat
DEFAULTLOGFORMAT logformat
APACHELOGFORMAT Apache_format_string
APACHEDEFAULTLOGFORMAT Apache_format_string

Notes

LOGFORMAT and APACHELOGFORMAT only affect logfiles occurring later in the same configuration file.

Examples

LOGFORMAT (%S - %u [%d/%M/%Y:%h:%n:%j %j] "%j %r %j" %c %b)
DEFAULTLOGFORMAT MS-EXTENDED
APACHELOGFORMAT (%h %l %u %t \"%r\" %s %b)

ALIAS commands

1. Commands (items)

FILEALIAS, HOSTALIAS, BROWALIAS, REFALIAS, USERALIAS, VHOSTALIAS

Syntax

COMMAND *olditem newitem

Notes

Aliases item in all reports. Items with the same resultant name are combined. newitem may contain one * if olditem contains exactly one *.

Example

FILEALIAS /football/* /soccer/*

2. Commands (reports)

TYPEOUTPUTALIAS, HOSTOUTPUTALIAS, REQOUTPUTALIAS, REDIROUTPUTALIAS, FAILOUTPUTALIAS, DIROUTPUTALIAS, DOMOUTPUTALIAS, REFOUTPUTALIAS, REFSITEOUTPUTALIAS, REDIRREFOUTPUTALIAS, FAILREFOUTPUTALIAS, BROWOUTPUTALIAS, FULLBROWOUTPUTALIAS, VHOSTOUTPUTALIAS, USEROUTPUTALIAS, FAILUSEROUTPUTALIAS

Syntax

COMMAND *item string

Notes

Aliases item on one line of one report only. string may contain one * if item contains exactly one *.

Example

REQOUTPUTALIAS /football/ "/football/ (Main football page)"

3. Other commands: syntax

CASE ("SENSITIVE" | "INSENSITIVE")
DIRSUFFIX suffix
LOGTIMEOFFSET ["+" | "-"] number
TIMEOFFSET ["+" | "-"] number

Examples

CASE SENSITIVE
DIRSUFFIX index.htm
LOGTIMEOFFSET -300

INCLUDE/EXCLUDE commands

1. Commands (items)

FILEINCLUDE, FILEEXCLUDE, HOSTINCLUDE, HOSTEXCLUDE, BROWINCLUDE, BROWEXCLUDE, REFINCLUDE, REFEXCLUDE, USERINCLUDE, USEREXCLUDE, VHOSTINCLUDE, VHOSTEXCLUDE

Syntax

COMMAND (*item | "")

Notes

Excludes all logfile entries containing an excluded item from all reports. Includes and excludes are done after aliases, so the item is the aliased name, if applicable.

Examples

FILEINCLUDE /jim/*
HOSTEXCLUDE proxy*.aol.com
USEREXCLUDE ""

2. Syntax (including and excluding dates)

partdate := ["+" | "-"] digit digit
date := partdate partdate partdate [":" partdate partdate]
FROM date
TO date

Examples

FROM 990719:1200
TO -00-0101

3. Commands (reports)

REQINCLUDE, REQEXCLUDE, REDIRINCLUDE, REDIREXCLUDE, FAILINCLUDE, FAILEXCLUDE, TYPEINCLUDE, TYPEEXCLUDE, DIRINCLUDE, DIREXCLUDE, HOSTREPINCLUDE, HOSTREPEXCLUDE, DOMINCLUDE, DOMEXCLUDE, REFREPINCLUDE, REFREPEXCLUDE, REFSITEINCLUDE, REFSITEEXCLUDE, REDIRREFINCLUDE, REDIRREFEXCLUDE, FAILREFINCLUDE, FAILREFEXCLUDE, BROWSUMINCLUDE, BROWSUMEXCLUDE, FULLBROWINCLUDE, FULLBROWEXCLUDE, VHOSTREPINCLUDE, VHOSTREPEXCLUDE, USERREPINCLUDE, USERREPEXCLUDE, FAILUSERINCLUDE, FAILUSEREXCLUDE

Syntax

COMMAND *item

Notes

Excludes an excluded item from one report only. Only affects the top level of hierarchical reports.

Example

REQINCLUDE pages

4. Syntax (miscellaneous)

PAGEINCLUDE *file
PAGEEXCLUDE *file
ARGSINCLUDE *file
ARGSEXCLUDE *file
REFARGSINCLUDE *referrer
REFARGSEXCLUDE *referrer

Example

PAGEINCLUDE *.asp

DNS commands

Syntax

DNSFILE localfile
DNS ("NONE" | "READ" | "LOOKUP" | "WRITE")
DNSLOCKFILE localfile
DNSGOODHOURS number
DNSBADHOURS number

Examples

DNSFILE dnscache.txt
DNS WRITE
DNSBADHOURS 48

Sub-item commands

Syntax

SUBDIR *file
SUBDOMAIN *subdomain
SUBTYPE *extension
SUBBROW *browser
REFDIR *referrer

Examples

SUBDIR /jim/*/*
SUBTYPE *.gz

LOWMEM commands

Commands

FILELOWMEM, HOSTLOWMEM, BROWLOWMEM, REFLOWMEM, USERLOWMEM, VHOSTLOWMEM

Syntax

COMMAND ("0" | "1" | "2" | "3")

Example

HOSTLOWMEM 3

Report commands

Commands

GENERAL, ALL, MONTHLY, WEEKLY, FULLDAILY, DAILY, FULLHOURLY, HOURLY, QUARTER, FIVE, HOST, DOMAIN, REQUEST, DIRECTORY, FILETYPE, SIZE, REDIR, FAILURE, REFERRER, REFSITE, REDIRREF, FAILREF, FULLBROWSER, BROWSER, VHOST, USER, FAILUSER, STATUS

Syntax

REPORTCOMMAND ("ON" | "OFF")

Examples

ALL OFF
FULLHOURLY ON

GRAPH commands

Commands

ALLGRAPH, MONTHGRAPH, WEEKGRAPH, DAYGRAPH, FULLDAYGRAPH, HOURGRAPH, FULLHOURGRAPH, QUARTERGRAPH, FIVEGRAPH

Syntax

COMMAND ("R" | "r" | "P" | "p" | "B" | "b")

Example

ALLGRAPH B

BACK commands

Commands

ALLBACK, MONTHBACK, WEEKBACK, FULLDAYBACK, FULLHOURBACK, QUARTERBACK, FIVEBACK

Syntax

COMMAND ("ON" | "OFF")

Example

ALLBACK ON

ROWS commands

Commands

MONTHROWS, WEEKROWS, FULLDAYROWS, FULLHOURROWS, QUARTERROWS, FIVEROWS

Syntax

COMMAND number

Example

QUARTERROWS 192

COLS commands

1. Commands (time reports)

TIMECOLS, MONTHCOLS, WEEKCOLS, DAYCOLS, FULLDAYCOLS, HOURCOLS, FULLHOURCOLS, QUARTERCOLS, FIVECOLS

Syntax

cols1 := subset("RrPpBb")
COMMAND cols1

Example

MONTHCOLS bRP

2. Commands (most success reports)

HOSTCOLS, DOMCOLS, DIRCOLS, SIZECOLS, REFCOLS, REFSITECOLS, FULLBROWCOLS, BROWCOLS, VHOSTCOLS, USERCOLS

Syntax

cols2 := subset("DRrPpBb")
COMMAND cols2

Example

USERCOLS BD

3. Commands (Request and File Type Reports)

REQCOLS, TYPECOLS

Syntax

cols3 := subset("DRrpBb")
COMMAND cols3

Example

TYPECOLS Rb

4. Commands (failure, redirection and Status Code reports)

REDIRCOLS, FAILCOLS, REDIRREFCOLS, FAILREFCOLS, FAILUSERCOLS, STATUSCOLS

Syntax

cols4 := subset("DRr")
COMMAND cols4

Example

FAILCOLS D

SORTBY commands

1. Commands (most success reports)

HOSTSORTBY, DOMSORTBY, DIRSORTBY, REFSORTBY, REFSITESORTBY, FULLBROWSORTBY, BROWSORTBY, VHOSTSORTBY, USERSORTBY, SUBDIRSORTBY, SUBDOMSORTBY, SUBBROWSORTBY, REFDIRSORTBY, REFARGSSORTBY

Syntax

sortby1 := ("REQUESTS" | "PAGES" | "BYTES" | "DATE" | "ALPHABETICAL" | "RANDOM")
COMMAND sortby1

Example

DOMSORTBY ALPHABETICAL

2. Commands (Request and File Type Reports)

REQSORTBY, TYPESORTBY, REQARGSSORTBY, SUBTYPESORTBY

Syntax

sortby2 := ("REQUESTS" | "BYTES" | "DATE" | "ALPHABETICAL" | "RANDOM")
COMMAND sortby2

Example

REQSORTBY REQUESTS

3. Commands (failure, redirection and Status Code reports)

REDIRSORTBY, FAILSORTBY, REDIRREFSORTBY, FAILREFSORTBY, FAILUSERSORTBY, STATUSSORTBY, REDIRARGSSORTBY, FAILARGSSORTBY, REDIRREFARGSSORTBY, FAILREFARGSSORTBY

Syntax

sortby3 := ("REQUESTS" | "DATE" | "ALPHABETICAL" | "RANDOM")
COMMAND sortby3