Configuration reference

The WT1 tracker backend is configured using a standard Java properties configuration file named config.properties, located in the WEB-INF subdirectory of the web application deployment directory.

The WT1 package contains two example configuration files named config-sample.properties and config-flume.properties in this directory.

Global configuration parameters

The following configuration parameters are available in all deployment modes.

Parameter name	Default value	Description
maxQueueSize	5000	Size of the internal event queue. When this queue fills up because the storage handler of a custom handler cannot keep up, incoming events are dropped.
sessionExpiration	1800	Duration of a visitor session, in seconds.
thirdPartyCookies	false	Enable third-party cookie tracking. See Cookies usage. When enabled, a global visitor id will be maintained for each tracked visitor and appended to the generated log file as a supplementary column.
optoutCallbackUrl		Callback URL for the IAB-compliant opt-out functionality. See Cookies usage. Valid only when third-party cookie tracking is enabled.
p3pHeader		Optional P3P header to be sent along with cookie-setting HTTP responses. See Cookies usage. Valid only when third-party cookie tracking is enabled.
ignoreDNT	false	Ignore DNT (Do Not Track) HTTP headers. See Cookies usage. Valid only when third-party cookie tracking is enabled.
maintenanceFile		When present, name of a file watched by the health-checking servlet. See Monitoring and operations.
inlinedVisitorParams		Optional comma-separated list of visitor parameters. See WT1 Analyst's Guide. When present, these parameters will be extracted from tracking requests and appended to the generated log file as supplementary columns, in order.
inlinedSessionParams		Optional comma-separated list of session parameters. See WT1 Analyst's Guide. When present, these parameters will be extracted from tracking requests and appended to the generated log file as supplementary columns, in order.
inlinedEventParams		Optional comma-separated list of events parameters. See WT1 Analyst's Guide. When present, these parameters will be extracted from tracking requests and appended to the generated log file as supplementary columns, in order.

Storage engine configuration parameters

One storage engine MUST be configured with the storage.class parameter.

Storage engine configuration parameters have a name prefixed with storage.params. They are specific to each storage engine.

Reference configuration information for provided storage engines can be found on the Storage engines page.

Parameter name	Description
storage.class	Java class to use for the storage engine. Mandatory.
storage.params.PARAMETER_NAME	Storage engine-specific configuration parameter.

Event handler configuration parameters

Additional event handlers can be instantiated with the handler.ID.class parameter, where string ID is the identifier of the handler to create.

Event handler configuration parameters for handler ID have a name prefixed with handler.ID.params. They are specific to each event handler.

Reference configuration information for provided event handlers can be found on the Event handlers page.

Parameter name	Description
handler.ID.class	Java class to use for event handler ID. Mandatory for each handler to instantiate.
handler.ID.params.PARAMETER_NAME	Event handler-specific configuration parameter for event handler ID.

Logging Configuration

The logging behavior or the WT1 backend can be configured using the WEB-INF/classes/log4j.properties log4j configuration file. See log4j documentation for details.

For example, when run under Tomcat 7, the following log4j configuration sends wt1 warning and error messages to the Tomcat console, and stores other informational messages in a dedicated set of daily rotating log files in the Tomcat log directory:

log4j.rootLogger = INFO, CONSOLE, LOGFILE
 
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=[%d{yyyy/MM/dd-HH:mm:ss.SSS}] [%p] [%t] [%c]\t%x %m%n
log4j.appender.CONSOLE.Threshold=WARN
 
log4j.appender.LOGFILE=org.apache.log4j.DailyRollingFileAppender
log4j.appender.LOGFILE.File=${catalina.base}/logs/wt1_log
log4j.appender.LOGFILE.Encoding=UTF-8
log4j.appender.LOGFILE.DatePattern='.'yyyy-MM-dd'.log'
log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
log4j.appender.LOGFILE.layout.ConversionPattern=[%d{yyyy/MM/dd-HH:mm:ss.SSS}] [%p] [%t] [%c]\t%x %m%n