mod_usertrack.html revision 8963f69f11b106d3dc23f07aaf5ae6579e2111ce
2a21a474a93152e7a1637578953dfc3093f374b2vboxsync<!--#include virtual="header.html" -->
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncPrevious releases of Apache have included a module which generates a
2a21a474a93152e7a1637578953dfc3093f374b2vboxsync'clickstream' log of user activity on a site using cookies. This was
2a21a474a93152e7a1637578953dfc3093f374b2vboxsynccalled the "cookies" module, mod_cookies. In Apache 1.2 and later this
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncmodule has been renamed the "user tracking" module,
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncmod_usertrack. This module has been simplified and new directives
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncPreviously, the cookies module (now the user tracking module) did its
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncown logging, using the <tt>CookieLog</tt> directive. In this release,
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncthis module does no logging at all. Instead, a configurable log
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncformat file should be used to log user click-streams. This is possible
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncbecause the logging module now allows <a
2a21a474a93152e7a1637578953dfc3093f374b2vboxsynchref="/multilogs.html">multiple log files</a>. The cookie itself is
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncin the log file format. For example:
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncFor backward compatibility the configurable log module implements the
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncold <tt>CookieLog</tt> directive, but this should be upgraded to the
2a21a474a93152e7a1637578953dfc3093f374b2vboxsync<strong>Syntax:</strong> CookieExpires <em>expiry-period</em><br>
2a21a474a93152e7a1637578953dfc3093f374b2vboxsync<strong>Context:</strong> server config, virtual host<br>
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncWhen used, this directive sets an expiry time on the cookie generated
fd50d469f529bf08da58eb189b69a2addbb900cdvboxsyncby the usertrack module. The <i>expiry-period</i> can be given either
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncas a number of seconds, or in the format such as "2 weeks 3 days 7
2a21a474a93152e7a1637578953dfc3093f374b2vboxsynchours". Valid denominations are: years, months, weeks, hours, minutes
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncand seconds.
fd50d469f529bf08da58eb189b69a2addbb900cdvboxsync<p>If this directive is not used, cookies last only for the current
fd50d469f529bf08da58eb189b69a2addbb900cdvboxsyncbrowser session.</p>
fd50d469f529bf08da58eb189b69a2addbb900cdvboxsync<a name="cookietracking"><h2>CookieTracking</h2></A>
fd50d469f529bf08da58eb189b69a2addbb900cdvboxsync<strong>Syntax:</strong> CookieTracking <em>on | off</em><br>
fd50d469f529bf08da58eb189b69a2addbb900cdvboxsync<strong>Context:</strong> server config, virtual host, directory,
fd50d469f529bf08da58eb189b69a2addbb900cdvboxsync.htaccess<br>
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncWhen the user track module is compiled in, and "CookieTracking on" is
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncset, Apache will start sending a user-tracking cookie for all new
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncrequests. This directive can be used to turn this behavior on or off
2a21a474a93152e7a1637578953dfc3093f374b2vboxsyncon a per-server or per-directory basis. By default, compiling
fd50d469f529bf08da58eb189b69a2addbb900cdvboxsyncmod_usertrack will not activate cookies.
2a21a474a93152e7a1637578953dfc3093f374b2vboxsync<!--#include virtual="footer.html" -->