Apache::SearchEngineLog 0.10 README
-----------------------------------

Apache::SearchEngineLog is a mod_perl module for apache to log the terms
used in searchengines to a SQL database.

Table Layout
------------

Apache::SearchEngineLog needs two tables: one for storing configuration
data, and one for storing the actual data wanted. The two tables should
look as follows:

This is the table for the actual reference data, by default named "hits".
  +--------+-------------+------+-----+---------------------+-------+
  | Field  | Type        | Null | Key | Default             | Extra |
  +--------+-------------+------+-----+---------------------+-------+
  | term   | varchar(50) |      |     |                     |       |
  | uri    | varchar(50) |      |     |                     |       |
  | domain | varchar(20) |      |     |                     |       |
  | date   | datetime    |      |     | 0000-00-00 00:00:00 |       |
  +--------+-------------+------+-----+---------------------+-------+

This is the table "config", used for storing collected information about
searchengines.
  +--------+-------------+------+-----+---------+-------+
  | Field  | Type        | Null | Key | Default | Extra |
  +--------+-------------+------+-----+---------+-------+
  | domain | varchar(20) |      | PRI |         |       |
  | field  | varchar(10) |      |     |         |       |
  +--------+-------------+------+-----+---------+-------+

You can use the included "createtable.sql" file to create these tables.


Configuration
-------------

Apache::SearchEngineLog is configured using environment variables which
you can set in apache's httpd.conf; An configuration could be:

  #in httpd.conf

  PerlSetEnv DBI_data_source  dbi:driver:dsn
  PerlSetEnv DBI_username     username
  PerlSetEnv DBI_password     password
  PerlSetEnv DBI_table        db_table #optional, defaults to "hits"

  PerlModule Apache::SearchEngineLog

  <Location /test>
    PerlLogHandler Apache::SearchEngineLog
  </Location>


Performance
-----------

Since this is the very first release I don't have any information on this
topic yet. If you experience any difficulties under load, please let me
know.


Evaluation
----------

There is a script, called 'analyse.pl', in this bundle which may be used
to analyse the collected data. (who would have guessed?! ;) It is really
simple and not very detailed, so I propably will write a better one..

--
Florian 'octo' Forster
octopus@verplant.org
