Detailed instructions for installing and configuring Sensor for JBoss Server 4.0.5 or later running under Microsoft Windows Server 2000 or later.
The program files for Sensor are packaged in an installation file that you obtain from the Adobe download site. If you do not already have the Sensor installation file for your particular web server, download it (or obtain it from your Adobe representative) before you begin the following procedures.
Supported J2EE implementations include:
To install and configure Sensor, you must perform the following steps:
Procedure to extract and install the program files for Sensor.
On your JBoss Server, create a directory in which to install the Sensor program files. Keep in mind that your disk queue resides in this directory, so be sure the device you choose has sufficient space to hold a queue of the size you need.
Extract the contents of the installation file into the directory you just created. During this step, Sensor installs the following files:
|mod_visual_sciences.so||The collector load module.||IBMHttpServer/modules|
|The transmitter program.||
|txlogd.conf||The Sensor configuration file.||/etc|
|trust_ca_cert.pem||The certificate used to validate the digital certificate that Insight Server presents during the connection process||/usr/local/visual_sciences|
The installation package contains a spreadsheet file called TestExperiment.xls. This spreadsheet is a tool that architects use to configure a controlled experiment. Sensor itself does not use this file, so it is not necessary to install the file on the machine where Sensor is running (although you can choose to do so). You might want to, instead, copy the file to a location where your architects can access it or simply extract the file from the installation package as needed. For more information about controlled experimentation, see the Insight Controlled Experiments Guide.
The txlogd.conf file contains the configuration parameters for Sensor.
You must edit this file to specify, among other things, the size and location of the disk queue file, the address of the Insight Server, and the ID that will be attached to the event data produced by this sensor.
The configuration file contains required parameters and optional parameters.
To edit the Sensor configuration file
To edit the Sensor configuration file
After you configure the txlogd.conf file, you can start the transmitter program, register it as a Windows service, and create the disk queue.
From the Start menu in Windows, select Accessories > Command Prompt.
In the command prompt window, navigate to the directory in which you installed Sensor and execute the following command:
This command starts the transmitter, creates the disk queue, and registers Sensor as a Windows service.
To confirm that the transmitter is running correctly, click Start > Control Panel > Administrative Tools > Services.
This command sequence might vary depending on which version of Windows you are using.
To check whether transmitter experienced any errors during start-up, click Start > Control Panel > Administrative Tools > Event Viewer to open the Event Viewer.
When you finish examining the Applications log, close the Event Viewer.
Verify that the transmitter has created the disk queue (Diskq2000.log) in the directory where you installed the Sensor program files and that it is the size that you specified in the QueueSize parameter in the txlogd.conf file.
If the queue has not been created correctly:
Examine the txtlogd.conf file and verify that the QueueSize parameter is set correctly.
Check that the device on which you installed Sensor has sufficient space available to hold a file of the size specified in the QueueSize parameter.
Using the Services control panel in Windows, stop the transmitter.
Delete the queue file.
Re-register Sensor as a Windows service: from the Start menu in Windows, select Accessories > Command Prompt. In the command prompt window, navigate to the directory in which you installed Sensor and execute the following command:
The transmitter is designed to run continuously. If you restart the machine, the transmitter restarts automatically. If you need to start and stop the transmitter manually, you can do so using the Services control panel in Windows.
For JBoss servers, the collector operates as a filter in the servlet container.
To add the collector to your web server, you must edit the web.xml file as described below and restart your web application.
Using a text editor, open the web.xml file for the web server whose events Sensor captures.
Add the following
<filter-mapping> elements to the descriptor file. If you did not install txlogd.conf in the /etc directory, you need to enter the correct path to this file in the
<filter> <filter-name>VSCollectorFilter</filter-name> <description></description> <filter-class> com.visualsciences.collector.VSCollectorFilter </filter-class> <init-param> <param-name>configPath</param-name> <param-value>C:/VisualSensor/txlogd.conf</param-value> <description></description> </init-param> </filter> <filter-mapping> <filter-name>VSCollectorFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>
These lines are case sensitive. Type them exactly as they appear above.
Restart the web server process (you do not have to reboot the entire server computer, simply restart the web server process). The collector is loaded with the web server and begins collecting event data and writing it to the disk queue.
Before modifying the startup script, ensure that the JAVA_HOME variable is defined in the Windows environment.
In the run.bat file (for example, C:\jboss-4.0.5.GA\bin\run.bat), add the following lines near the end of the file just before the “echo” lines that precede the startup command of the JBoss server:
set JBOSS_CLASSPATH=%JBOSS_CLASSPATH%;C:\jboss-4.0.5.GA\server\default\lib\javax.servlet.jar;C:\VisualSciences\J2EECollector.jar set JAVA_OPTS=%JAVA_OPTS% -Djava.library.path=C:\VisualSciences
You can capture additional measurement data from J2EE-based web applications using the appendToLog() functionality.
Add the following code to the top of the .jsp page from which you want to capture data:
<%@ page import="com.visualsciences.collector.VSCollector" %>
Use the appendToLog() method of the collector object to append the desired name-value pairs to the requested .jsp page’s query string. The following example appends “A=1” and “B=2” to the requested .jsp page’s query string for the /index.jsp page:
<html> <body> <h1>Hello World</h1> <% VSCollector collector = new VSCollector(request, response); collector.appendToLog("A", "1"); collector.appendToLog("B", "2"); %> </body> </html>
The resulting request URI is /index.jsp?A=1&B=2.
Repeat this procedure for each .jsp page from which you want to capture additional data.