                      123LogAnalyzer User Manual

Quick Start 
----------------------------------------------
123LogAnalyzer ships in a gzipped tar archive. Please extract it with the 
following command line:

  gunzip -c 123log*.tar.gz | tar xf -
  
you can now run 123LogAnalyzer by changing to the 123loganalyzer directory, 
and typing the name of the executable file "123log" from the command line.

  cd 123loganalyzer
  ./123log [command line options...]
  

For example, your web server log file is /var/log/httpd-access.log, your 
domain is xyz.com and you need to analyze it and save the reports in 
./report/, you may type in the following command line:

  ./123log -l /var/log/httpd-access.log -d xyz.com -o ./report/

The report files will be generated in HTML format and .csv format, saved 
under ./report/directory. You may browse the reports ("123LogReport.htm") 
in a web browser or import the .csv report("report.csv") into Excel.  
  

Complete command line options
----------------------------------------------

   -v                       : Show 123LogAnalyzer's version info
   
   -l <log files>           : Log files to be analyzed, wildcard characters 
      or                    : (*, ?) can be used.
   -logfile <log files>     
   
   
   -loglist <loglist file>  : loglist file is a text file that contain paths 
                              of the log files, one path per line, wildcard 
                              can also be used.
   
   
   -o <output directory>    : Output directory where the report files 
     or                     : are saved.
   -output <output directory>

   -d <domain>              : Domain name of the web site
     or                     : 
   -domain <domain>

   -startdate <mmddyyyy>    : Set the date range in the analysis job.
   -enddate <mmddyyyy>      :

   -thismonth               : Generate this month's report
   -lastmonth               : Generate last month's report
   -thisweek                : Generate this week's report
   -lastweek                : Generate last week's report
   -today                   : Generate today's report
   -yesterday               : Generate yesterday's report
   -7days                   : Generate last seven day's report
   -5                       : Generate last 5 minutes' report
   -15                      : Generate last 15 minutes' report
   -lastminutes <n>         : Generate last n minutes' report
   -lasthours <n>           : Generate last n hours' report
   -lastdays <n>            : Generate last n days' report
   
   -i <ini file>            : Use specific configuration file(ini file)
     or
   -ini <ini file>

   -t <templates path>      : Use specific location which stores report 
     or                     : template files
   -templates <templates path>

   -f <filter file>         : Use filters in the analysis job
     or
   -filter <filter file>    :   
   
   -q                       : Run 123LogAnalyzer in quiet mode.


Configuration
----------------------------------------------
You can configure 123LogAnalyzer by editing the configuration 
file "123log.ini"

Here are the syntax rules for configuring 123LogAnalyzer.

[123LOG]

# Set the maximum file list length to 100
MaxFileList=100

# Set the maximum referrer list length to 200
MaxReferrerList=200

# Set the maximum search phrase list length to 200
MaxSearchPhraseList=200

# Set the maximum single search engine report list length to 20
MaxSingleSearchEngineList=20

# Set the maximum Visitor IP list length to 10
MaxIPList=10

# Enter the number of hours that the time needs to be adjusted to 
# match your local time zone. For example if the log file uses the
# Greenwich Mean time zone but you are in the Central time zone you
# would need to adjust the time by -6 hours.
HourShift=0

# The location where the reports are saved
OutputDir=./Report/

# The domain name of the web site
Domain=123loganalyzer.com

# Set this to 1 if you need to ommit URL parameters. Set this to 0 if
# you want to keep the URL parameters.
CutCGI=0


# Set this to 1 if you need to ommit the last number of an IP address. 
# Otherwise, set this to 0
IgnoreLastIPNumber=0

# This allows you to set the default timeout for a visit session.
# The default is 30 minutes, which should be fine for most sites.
VisitSessionLength=30

# Set this to 1 if you want file downloads also be showed in the
# browsing sequence report. Otherwise, set this to 0
IncludeFileDownload=1

# Set this to 1 to enable reverse DNS lookup. Otherwise, set this to 0
UseDNS=0


Filtering
----------------------------------------------
A filter file is a text file like this:

################CUT#####################
[General]
ID=123-Filter
Title=Example web page/file filter
Count=1

[Filter0]
Type=1
Exclude=0
Name=File Filter:download.htm...
Case=1
HideOtherHits=0
MatchType=0
Files=download.htm
################CUT#####################

To easily make a 123LogAnalyzer filter file, please visit
         http://www.123loganalyzer.com/makefilter.htm

The following address contains a collection of pre-made 123LogAnalyzer filters to 
help you do indepth visitor analysis:

         http://www.123loganalyzer.com/filter/
         

Or , you can use a text editor to make your own filter file.

A filter file contains at least two sections, [General] and [Filter0]
in [General] section,

"ID=123-Filter"  shows it is a 123LogAnalyzer filter file
"Title=Example web page/file filter" gives a name for this filter file, this
name will appear in the reports.
"Count=1" shows how many filters are there in this filter file, default is 1.
If you have more than 1 filters, you can add more filter sections starting from
[Filter0] to [[Filter1] to ...[FilterN]

in [Filter0] section, a 123LogAnalyzer's filter is described here.
In the above case,
"Type=1" shows that this filter is a page/file filter.
"Exclude=0" shows that this filter is a "inclusion" filter.
"Name=File Filter:download.htm..." gives a name for this filter
"Case=1" means use case sensitive match
HideOtherHits=0 means also show other pages that the matched visitor visited.
MatchType=0 means match visitors who visited ANY of the above files
MatchType=1 means match visitors who visited ALL of the above files
"Files=download.htm" means match all the visitors who visited download.htm


****Type 1: Visitors who accessed specific pages or files


Example 1: Tracking Overture PPC listing visitors.
           All the Overture PPC listing links to /index.html?fromOverture

################CUT#####################           
[General]
ID=123-Filter
Title=Example: Overture Tracking
Count=1

[Filter0]
Type=1
Exclude=0
Name=File Filter:fromOverture...
Case=1
HideOtherHits=0
MatchType=0
Files=fromOverture
################CUT#####################           

"Type=1" shows that this filter is a page/file filter.
"Exclude=0" shows that this filter is a "inclusion" filter.
"Name=File Filter:fromOverture..." gives a name for this filter
"Case=1" means use case sensitive match
HideOtherHits=0 means also show other pages that the matched visitor visited.
MatchType=0 means match visitors who visited ANY of the above files
MatchType=1 means match visitors who visited ALL of the above files
"Files=fromOverture" means match all the visitors whose visits contains 
"fromOverture" substring


Example 2: Tracking visits to specific directory /linux/
################CUT#####################           
[General]
ID=123-Filter
Title=Example: Tracking /linux/
Count=1

[Filter0]
Type=1
Exclude=0
Name=File Filter:/linux/...
Case=1
HideOtherHits=1
MatchType=0
Files=/linux/
################CUT#####################           
"Type=1" shows that this filter is a page/file filter.
"Exclude=0" shows that this filter is a "inclusion" filter.
"Name=File Filter:/linux/..." gives a name for this filter
"Case=1" means use case sensitive match
HideOtherHits=1 means show only the visits under /linux/ directory.
MatchType=0 means match visitors who visited ANY of the above files
MatchType=1 means match visitors who visited ALL of the above files
"Files=fromOverture" means match all the visitors whose visits contains 
"fromOverture" substring


****Type 2: Visitors who came from specific referring urls.

Example 1: Tracking visitors who came from google.com
           
################CUT#####################           
[General]
ID=123-Filter
Title=Example: Google Tracking
Count=1

[Filter0]
Type=2
Exclude=0
Name=Referring URL: google.com...
URLs=google
################CUT#####################           
"Type=2" shows that this filter is a referrer filter.
"Exclude=0" shows that this filter is a "inclusion" filter.
"Name=Referring URL: google.com..." gives a name for this filter
"URLs=google" means match all the visitors whose referrer urls contains 
"google" substring


****Type 5: Visitors whose first visit is the specific page.

Example 1: Tracking visitors whose first visit is "specialoffer.htm"
           
################CUT#####################           
[General]
ID=123-Filter
Title=Example: Special offer Tracking
Count=1

[Filter0]
Type=5
Exclude=0
Name=Entry Page: specialoffer.htm...
Case=1
Pages=specialoffer.htm
################CUT#####################           
"Type=5" shows that this filter is an entry page filter.
"Exclude=0" shows that this filter is a "inclusion" filter.
"Name=Entry Page: specialoffer.htm..." gives a name for this filter
"Case=1" means use case sensitive match
"Pages=specialoffer.htm" means match all the visitors whose entry page is
"specialoffer.htm"



****Type 7: Visitors whose have specific IP addresses.

Example 1: Exclude visitors whose IP addresses are 192.168.0.1 and 192.168.0.2
           
################CUT#####################           
[General]
ID=123-Filter
Title=Example: Exclude IP addresses
Count=1

[Filter0]
Type=7
Exclude=1
Name=IP addresses: 192.168.0.1 192.168.0.2...
IPTXT=192.168.0.1 192.168.0.2
################CUT#####################           
"Type=7" shows that this filter is an IP address filter.
"Exclude=1" shows that this filter is a "exclusion" filter.
"Name=IP addresses: 192.168.0.1 192.168.0.2..." gives a name for this filter
"IPTXT=192.168.0.1 192.168.0.2" gives an IP addresses list



You can also download 123LogAnalyzer's Windows version to generate the filter 
file in GUI mode.
