Required Parameters

A character string that uniquely identifies this Sensor.

Sensor attaches the SensorID to each event record it sends to the data workbench server. The SensorID enables the event data from this web server to be distinguished from the event data captured by other Sensors.

Although a SensorID can consist of any string of characters, by convention, the name of the web server whose events the Sensor is capturing is used. Using the server name as the SensorID makes it easy to determine the source of an event during the analysis stage. It also ensures that the SensorID is unique within the implementation.

Example: SensorID web001a

The address of the data workbench server to which this Sensor sends event data.

Note:

When working in a clustered environment, Sensor should be configured to access the master data workbench server to avoid synchronization issues. In Data Workbench you can view information about the processing data workbench servers in your cluster using the Related Servers menu item in the Servers Manager. For more information about the Servers Manager, see the Data Workbench Sensor Guide.

If your web server can resolve server names through DNS, you can specify the server’s address by name. If not, you must specify the server’s numeric IP address.

Example: ServerAddress 10.1.0.7 or

ServerAddress vserver01.mycompany.com

Whether Sensor communicates with data workbench server using HTTP or HTTPS. Set to “on” for HTTPS or “off” for HTTP.

Example: SSL on

The port on which the data workbench server listens for event data.

Example: ServerPort 443

Required only if the SSL parameter is set to “on.”

The common name of the data workbench server to which this Sensor sends event data.

The value you specify must exactly match the common name that appears on the data workbench server license certificate.

Example: CertName vserver01.mycompany.com

Required only if the SSL parameter is set to “on.”

The directory in which the certificate authority ( trust_ca_cert.pem) file is located

Examples:

CertPath /usr/local/visualsensor

CertPath C:\VisualSensor

Not needed for Sensor installations on Microsoft Windows 2000 or 2003 Server machines running Internet Information Service (IIS) versions 5.x or 6.x.

The fully qualified name of the disk queue file.

Although you can assign any name to this file, by convention, the queue file is named VisualSensor.dat.

For Sensor installations on Unix, you can place this file anywhere. On Windows running a Java web server, you must place this file in the same directory as the transmitter. For all other web servers, this file should reside in the /var/queue directory.

Example: QueueFile /var/queue/VisualSensor.dat

Note: Make sure that the device to which you assign this file has enough free space to accommodate a queue of the size you need.

An integer that represents the size of the disk queue file in MB.

For Sensor installations on Microsoft Windows, the queue file itself is created in the same directory as the transmitter and is named Diskq2000.log.

The following example sets the queue size to 200 MB:

QueueSize 200

The following example sets the queue size to 2 GB:

QueueSize 2000