Optional Parameters

IMPORTANT

Read more about Data Workbench’s End-of-life announcement.

Information about optional Sensor txlogd.conf file parameters.

Parameter Description
AddressFilter

Enables you to filter specified IP addresses.

When you filter a particular address, a “packet” is not logged. This feature eliminates internal or monitored agents before log processing, thereby increasing the speed of log processing and reducing data storage requirements. You can use wildcards when specifying addresses.

Example: AddressFilter 10.0.0.000

ContentFilterInclude

ContentFilterExclude

Specify whether to include or exclude certain types of content from logging.

The parameter values are prefix-matched against the content type of the reply.

For example, “image/” matches all image content types while “image/gif” matches only that type exactly. When multiple matches occur for a given content-type, the most specific match is used. Therefore, you could put “image/gif” in the ContentFilterInclude parameter and “image/” in the ContentFilterExclude parameter and “image/gif” replies are allowed but all other image types are filtered out.

Example: ContentFilterInclude *

Example: ContentFilterExclude image/,text/css,application/x-javascript

DebugLogPath

Set this parameter only when working with Adobe Consulting Services.

Enables debug logging for the web module and transmitter.

You use this parameter when the Sensor is not working correctly. After this parameter is set, you must create an empty file at the specified path location and give “write” rights to it for all users. For example (inside a unix shell on the web server):

  • % cd /var/log
  • % touch vslog.txt
  • % chmod a+w vslog.txt

You should enable debug logging for only a short period of time, after which the log file should be sent to Adobe Consulting Services to be analyzed.

Example: DebugLogPath /var/log/vslog.txt

Adobe recommends that this parameter first be set in a test environment to determine the effect on your system.

DisableField

Disables the specified field

Users can eliminate fields they do not use or do not want to store. If the field takes string values, disabling it passes a blank string. If the field takes numeric values, disabling it passes the number zero (0). You can disable the following fields:

  • sc-status
  • x-new-visitor
  • x-trackingid
  • sc-bytes
  • c-ip
  • cs-method
  • cs-uri-stem
  • cs-uri-query
  • s-dns
  • cs(referrer)
  • cs(cookie)
  • cs(user-agent)
  • cs(useragent)
  • sc(content-type)
  • x-experiment

Example: DisableField x-trackingid

ExpFile

Path to the Controlled Experiment configuration file.

Example: ExpFile C:\VisualSensor\experiment.txt

ExpCookieURL

Resource that, when requested, causes a new tracking ID to be generated and the user to be placed in an experiment group.

Note: This resource does not have to physically exist on the web server.

Example: ExpCookieURL /setcookie.htm

ExpPartialMatch

If you want to enable your controlled experiments to remap your entire site or an entire subdirectory of your site to another location, set this parameter to “on.” The default is “off.”

Example: ExpPartialMatch off

Note: Be very careful when setting this parameter to “on.”

LogAllNewUsers

Determines whether every new user’s first click is logged even if the user requests a document type that is filtered out by the ContentFilterExclude parameter.

The default is “no.”

Typically image files are filtered out by the ContentFilterExclude parameter. If LogAllNewUsers is set to “yes” and the very first document a new user gets from the server is an image, that request is logged. If the LogAllNewUsers parameter is either set to “no” or not set at all (and assuming that images are filtered out by the ContentFilterExclude parameter) and the very first document a new user gets from the server is an image, that request is not logged.

Example: LogAllNewUsers no

MaxPageLoadTime

The amount of time in seconds that the transmitter waits to send the next batch of packets.

The default is 15.

Example: MaxPageLoadTime 15

Note: Do not change this parameter value without first contacting Adobe Consulting Services.

PrivacyID

Enables you to disable visitor tracking, which can be used to comply with opt-out policies.

When enabled, Sensor does not log a “packet” for any visitor whose V1st cookie is set to the PrivacyID specified. Because no information is logged for those visitors, no information about those visitors is sent to the data workbench server for processing.

To enable this feature, you must complete the following steps:

  1. PrivacyID must be defined with a value of 0 (zero) in the txlogd.conf file for the Sensor.

    Example: PrivacyID 0

  2. Website owners must write code to set visitor (V1st) cookies such that the cookie ID value matches the PrivacyID value defined “ txlogd.conf."

SiteTest

Location to which the transmitter (txlogd) periodically sends requests to see if the website is operating correctly.

Note that the location is specified in the following format, not as a URL:

http,serverAddress,port,/resource

where serverAddress is server name or IP address, port is server’s HTTP listening port, and resource is the specific resource to request (can include a query string).

You can specify multiple SiteTest lines.

Example: SiteTest http,localhost,80,/test.html

Note: Only http is supported at this time.

TrackingCookie

The name of the cookie set on the visitor’s browser.

The default is “v1st.”

Example: TrackingCookie v1st

VerifyCertName

Indicates whether to validate the server against CertName parameter

The default is “on.”

Example: VerifyCertName on

Parameter Description
IISCaptureBytesSent

Set this parameter only when working with Adobe Consulting Services.

Tells the IIS Sensor which of two possible logging “hooks” should be used to log a packet

Use this parameter when the IIS Sensor is not logging packets correctly. This parameter would be set to “off” if the default logging hook was not working correctly. The default is “on.”

Example: IISCaptureBytesSent on

IISUseAlternateHandler

Set this parameter only when working with Adobe Consulting Services.

Tells the Sensor which of two possible “hooks” should be used to set the v1st cookie.

You use this parameter when the IIS Sensor is not setting the v1st cookie correctly. This parameter would be set to “yes” if the default hook was not correctly setting the v1st cookie. The default is “no.”

Example: IISUseAlternateHandler no

NewUserCacheControl

CacheControl

By default, Sensor sends cache control response headers on each request. When the cache control feature is enabled Sensor sends an Expires header with a value of Thu, 01 Dec 1994 16:00:00 GMT to the browser.

You can modify the response strings as desired by editing the following two lines in the txlogd.conf file:

NewUserCacheControl < string1>

CacheControl < string2>

Example:

NewUserCacheControl no-cache=Set-Cookie

CacheControl private,max-age=0,must-revalidate

To disable the sending of cache control response headers, type a hyphen for each line as shown below:

NewUserCacheControl -

CacheControl -

In this Parameter... Specify...
ApacheUseAlternateHandler

Set this parameter only when working with Adobe Consulting Services.

Tells the Sensor which of two possible “hooks” should be used to set the v1st cookie.

You use this parameter when the Apache Sensor is not setting the v1st cookie correctly. This parameter would be set to “yes” if the default hook was not correctly setting the v1st cookie. The default is “no.”

Example: ApacheUseAlternateHandler no

ApacheUseBothHandlers

Set this parameter only when working with Adobe Consulting Services.

Instructs the Sensor to try setting the v1st cookie in both hooks.

You use this parameter when the Apache Sensor is not setting the v1st cookie correctly. The default is “yes.”

If set to “yes” and the v1st cookie is not properly set in the first hook, the second hook is used. If set to “no,” you would set the ApacheUseAlternateHandler parameter to indicate which hook to use to set the v1st cookie.

Example: ApacheUseBothHandlers yes

NewUserCacheControl

CacheControl

By default, Sensor sends cache control response headers on each request. When the cache control feature is enabled Sensor sends an Expires header with a value of Thu, 01 Dec 1994 16:00:00 GMT to the browser.

You can modify the response strings as desired by editing the following two lines in the txlogd.conf file:

NewUserCacheControl < string1>

CacheControl < string2>

Example:

NewUserCacheControl no-cache=Set-Cookie

CacheControl private,max-age=0,must-revalidate

To disable the sending of cache control response headers, type a hyphen for each line as shown below:

NewUserCacheControl -

CacheControl -

Note: Adobe recommends that you do not disable this feature.

In this Parameter... Specify...
ApacheUseAlternateHandler

Set this parameter only when working with Adobe Consulting Services.

Tells the Sensor which of two possible “hooks” should be used to set the v1st cookie.

You use this parameter when the Apache Sensor is not setting the v1st cookie correctly. This parameter would be set to “yes” if the default hook was not correctly setting the v1st cookie. The default is “no.”

Example: ApacheUseAlternateHandler no

ApacheUseBothHandlers

Set this parameter only when working with Adobe Consulting Services.

Instructs the Sensor to try setting the v1st cookie in both hooks.

You use this parameter when the Apache Sensor is not setting the v1st cookie correctly. The default is “yes.”

If set to “yes” and the v1st cookie is not properly set in the first hook, the second hook is used. If set to “no,” you would set the ApacheUseAlternateHandler parameter to indicate which hook to use to set the v1st cookie.

Example: ApacheUseBothHandlers yes

On this page