mod_usertrack.html revision ead9af34e38b625bb50f47ddd1789668b8d7dce9
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail<!--#include virtual="header.html" -->
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish MoodalbailPrevious releases of Apache have included a module which generates a
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail'clickstream' log of user activity on a site, using cookies. This was
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailcalled the "cookies" module, mod_cookies. In Apache 1.2 and later, this module
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailbeen renamed the "user tracking" module, mod_usertrack. This module
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailsimplified and new directives added.
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish MoodalbailPreviously, the cookies module (now the user tracking module) did its
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailown logging, using the <tt>CookieLog</tt> directive. In this release,
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailthis module does no logging at all. Instead, a configurable log
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailformat file should be used to log user click-streams. This is possible
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailbecause the logging module now allows <a
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailhref="/multilogs.html">multiple log files</a>. The cookie itself is
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbaillogged by using the text <tt>%{cookie}n </tt>
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailin the log file format. For example:
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish MoodalbailCustomLog logs/clickstream "%{cookie}i %r %t"
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish MoodalbailFor backward compatibility the configurable log module implements the
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailold <tt>CookieLog</tt> directive, but this should be upgrade to the
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail<li><a href="#cookieexpires">CookieExpires</a>
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail<li><a href="#cookietracking">CookieTracking</a>
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail<a name="cookieexpires"><h2>CookieExpires</h2></A>
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail<strong>Syntax:</strong> CookieExpires <em>expiry-period</em><br>
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail<strong>Context:</strong> server config, virtual host<br>
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish MoodalbailWhen used, this directive sets an expiry time on the cookie generated
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailby the usertrack module. The <i>expiry-period</i> can be given either
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailas a number of seconds, or in the format such as "2 weeks 3 days 7
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailhours". Valid denominations are: years, months, weeks, hours, minutes
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail<p>If this directive is not used, cookies last only for the current
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailbrowser session.</p>
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail<a name="cookieexpires"><h2>CookieTracking</h2></A>
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail<strong>Syntax:</strong> CookieTracking <em>on | off</em><br>
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail<strong>Context:</strong> server config, virtual host, directory,
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish MoodalbailWhen the user track module is compiled in, and "CookieTracking on" is
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailset, Apache will start sending a user-tracking cookie for all new
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailrequests. This directive can be used to turn this behavior on or off
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailon a per-server or per-directory basis. By default, compiling
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailmod_usertrack will not activate cookies.
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail<!--#include virtual="footer.html" -->