Configure the TCP Collectors

On Windows

To configure the Reveille 8 User Analytics TCP Collector software on Windows, complete the following steps:

On the Reveille 8 User Analytics Collector Server, double-click the Reveille 8 User Analytics TCP Collector Settings desktop shortcut. The Reveille 8 User Analytics TCP Collector Settings window appears.
Update the connector settings values for each tab as appropriate for your application environment following the contextual field help at the bottom of the panel as a guideline.
Click Save when finished.

Click Start to start the Reveille 8 User Analytics TCP Collector Service.

On Linux

To configure the Reveille 8 User Analytics Linux TCP Collector software, complete the following steps:

NoteSome commands may require root privileges on the Linux system to execute. If you are not logged in as root then a recommended way is to use the sudo command. Adding a user to sudo allows that user to execute commands with elevated permissions when not logged in as root. Contact your Linux system administrator for more information on adding a user to sudo.

Navigate to the Linux Collector installation directory; the following steps are based on installing the Linux collector in the folder /opt/reveille_user_analytics.

The Linux Collector is configured via the rrttcpcollector.confg file. Use a text editor to edit the configuration file. Before editing the file, review the following options:

First create the reveilletcpcollector.config file from the reveilletcpcollector.config.SAMPLE file using the cp command:
cp reveilletcpcollector.config.SAMPLE reveilletcpcollector.config
To determine the network adapter to collect packets, use the –adapters option with reveilletcpcollector executable. Note that this option requires root privileges in order to access the Linux system hardware.
sudo ./rrttcpcollector-adapters
To encode an SSL key file password use the –password option
sudo ./rrttcpcollector–password
To display Linux collector help file; use the –help option:
sudo./rrttcpcollector–help

Edit the reveilletcpcollector.confg file using a text editor. A sample reveilletcpcollector.config file is shown below:

###############################################################################
# File Name: reveilletcpcollector.config.SAMPLE
#
# RealTime TCP Collector configuration file (SAMPLE)
# Copyright (c) 2015 Reveille Software.
#
# This file contains common settings that control the Reveille 8 User Analytics TCP
# Collector.
#
# To use this file, copy it to the location of the
# Reveille 8 User Analytics TCP Collector, and rename it to "reveilletcpcollector.config".
# Note that file names are case sensitive.
#
# For a description of all available settings, see file
# reveilletcpcollector.config.FULL.
# 
###############################################################################  
###############################################################################   

# [GENERAL]
#
ConnectorAddress = 192.168.1.100
ConnectorPort = 3400
DeviceNames = eth0
ConnectorEncryptData = false
ConnectorMaxQueueSize = 0
ConnectorMetricsTimeInterval = 60
ConnectorRetryMins = 5
ConnectorSendThreads = 5
#sslOptions = address=10.0.60.225;port=8443;keyfile=tomcatkey.pem;password=cmV2ZWlsbGU=;|address=10.94.77.83;port=12010;keyfile=/Workspace/tcpcollector/Debug/xtrac_workingkey.pem;password=;
UseGlobalFilters = false
#GlobalFilters = HostAddressFilter = 10.0.0.5;10.0.0.23; ClientAddressFilter = 10.0.0.*; ExcludeClientAddressFilter = 10.0.0.5:25

###############################################################################   
# [TCP]
#
TCP.Capture = true
#TCP.TcpPorts = 80,8080
#TCP.Filters = HostAddressFilter = 10.0.0.5;10.0.0.23; ClientAddressFilter = 10.0.0.*; ExcludeClientAddressFilter = 10.0.0.5:25

###############################################################################    
# [TDS]
#
TDS.Capture = true
TDS.SendMessages = true
#TDS.TcpPorts = 1433,2433
#TDS.Filters = HostAddressFilter = 10.0.0.5;10.0.0.23; ClientAddressFilter = 10.0.0.*; ExcludeClientAddressFilter = 10.0.0.5:25

###############################################################################     
# [DFC]
DFC.Capture = true
DFC.SendMessages = true
#DFC.TcpPorts = 1489,1490,47625,47632
#DFC.Filters = HostAddressFilter = 10.0.0.5;10.0.0.23; ClientAddressFilter = 10.0.0.*; ExcludeClientAddressFilter = 10.0.0.5:25

###############################################################################     
# [FileNet]
FileNet.Capture = false
#FileNet.TcpPorts = 2809,7001-7002,1099,3528-3529,9100
#FileNet.Filters = HostAddressFilter = 10.0.0.5;10.0.0.23; ClientAddressFilter = 10.0.0.*; ExcludeClientAddressFilter = 10.0.0.5:25

###############################################################################
# [TNS]
#
TNS.Capture = false
TNS.SendMessages = true
#TNS.TcpPorts = 1521
#TNS.Filters = 

###############################################################################    
# END OF FILE
###############################################################################

Start the Linux collector after updating the reveilletcpcollectorconfiguration file using the –start option.
sudo ./rrttcpcollector–start
If using a 64-bit Linux collector, increase the socket receive buffer by using these Linux commands:
sudo sysctl -w net.core.rmem_max=4194304
sudo sysctl -w net.core.rmem_default=4194304
To make the socket receive buffer changes permanent, update the /etc/sysctl.conf file with these values:
net.core.rmem_max=4194304
net.core.rmem_default=4194304

On Solaris

To configure the Reveille 8 User Analytics Solaris TCP Collector software, complete the following steps:

NoteSeveral commands require root privileges on the Solaris system to execute. Contact your Solaris system administrator for more information on providing root level access.

Navigate to the Solaris Collector installation directory; the following steps are based on installing the Solaris collector in the folder /opt/reveille_user_analytics.

The Solaris Collector is configured through the reveilletcpcollector.config file. Use a text editor to edit the configuration file. Before editing the file, review the following options:

First create the reveilletcpcollector.config file from the reveilletcpcollector.config.SAMPLE file using the cp command:
cp reveilletcpcollector.config.SAMPLE reveilletcpcollector.config
To determine the network adapter to collect packets, use the –adapters option with reveilletcpcollector executable. Note that this option requires root privileges in order to access the Solaris system hardware.
./rrttcpcollector-adapters
To encode an SSL key file password use the –password option
./rrttcpcollector–password
To display Solaris collector help file; use the –help option:
./rrttcpcollector–help

Edit the reveilletcpcollector.config file using a text editor. A sample reveilletcpcollector.config file is shown below:

###############################################################################
# File Name: reveilletcpcollector.config.SAMPLE
#
# RealTime TCP Collector configuration file (SAMPLE)
# Copyright (c) 2015 Reveille Software.
#
# This file contains common settings that control the Reveille 8 User Analytics TCP
# Collector.
#
# To use this file, copy it to the location of the
# Reveille 8 User Analytics TCP Collector, and rename it to "reveilletcpcollector.config".
# Note that file names are case sensitive.
#
# For a description of all available settings, see file
# reveilletcpcollector.config.FULL.
# 
###############################################################################  
###############################################################################   

# [GENERAL]
#
ConnectorAddress = 192.168.1.100
ConnectorPort = 3400
DeviceNames = eri0
ConnectorEncryptData = false
ConnectorMaxQueueSize = 0
ConnectorMetricsTimeInterval = 60
ConnectorRetryMins = 5
ConnectorSendThreads = 5
#sslOptions = address=10.0.60.225;port=8443;keyfile=tomcatkey.pem;password=cmV2ZWlsbGU=;|address=10.94.77.83;port=12010;keyfile=/Workspace/tcpcollector/Debug/xtrac_workingkey.pem;password=;
UseGlobalFilters = false
#GlobalFilters = HostAddressFilter = 10.0.0.5;10.0.0.23; ClientAddressFilter = 10.0.0.*; ExcludeClientAddressFilter = 10.0.0.5:25

###############################################################################   
# [TCP]
#
TCP.Capture = true
#TCP.TcpPorts = 80,8080
#TCP.Filters = HostAddressFilter = 10.0.0.5;10.0.0.23; ClientAddressFilter = 10.0.0.*; ExcludeClientAddressFilter = 10.0.0.5:25

###############################################################################    
# [TDS]
#
TDS.Capture = true
TDS.SendMessages = true
#TDS.TcpPorts = 1433,2433
#TDS.Filters = HostAddressFilter = 10.0.0.5;10.0.0.23; ClientAddressFilter = 10.0.0.*; ExcludeClientAddressFilter = 10.0.0.5:25

###############################################################################     
# [DFC]
DFC.Capture = true
DFC.SendMessages = true
#DFC.TcpPorts = 1489,1490,47625,47632
#DFC.Filters = HostAddressFilter = 10.0.0.5;10.0.0.23; ClientAddressFilter = 10.0.0.*; ExcludeClientAddressFilter = 10.0.0.5:25

###############################################################################     
# [FileNet]
FileNet.Capture = false
#FileNet.TcpPorts = 2809,7001-7002,1099,3528-3529,9100
#FileNet.Filters = HostAddressFilter = 10.0.0.5;10.0.0.23; ClientAddressFilter = 10.0.0.*; ExcludeClientAddressFilter = 10.0.0.5:25

###############################################################################
# [TNS]
#
TNS.Capture = false
TNS.SendMessages = true
#TNS.TcpPorts = 1521
#TNS.Filters = 

###############################################################################    
# END OF FILE
###############################################################################

Start the Solaris collector after updating the reveilletcpcollector configuration file using the –start option.
./rrttcpcollector–start

On AIX

To configure the Reveille 8 User Analytics AIX TCP Collector software, complete the following steps:

NoteSome commands may require root privileges on the AIX system to execute. If you are not logged in as root then a recommended way is to use the sudo command. Adding a user to sudo allows that user to execute commands with elevated permissions when not logged in as root. Contact your AIX system administrator for more information on adding a user to sudo.

Navigate to the AIX TCP Collector installation directory; the following steps are based on installing the AIX TCP Collector in the folder /opt/reveille_user_analytics.

The AIX TCP Collector is configured via the reveilletcpcollector.config file. Use a text editor to edit the configuration file. Before editing the file, review the following options:

First create the reveilletcpcollector.config file from the reveilletcpcollector.config.SAMPLE file using the cp command:
cp reveilletcpcollector.config.SAMPLE reveilletcpcollector.config
To determine the network adapter to collect packets, use the –adapters option with reveillecollector executable. Note that this option requires root privileges in order to access the AIX system hardware.
sudo ./rrttcpcollector–adapters
To encode an SSL key file password use the –password option
sudo ./rrttcpcollector–password
To display AIX collector help file; use the –help option:
sudo ./rrttcpcollector–help

Edit the reveilletcpcollector.config file using a text editor. A sample reveilletcpcollector.config file is shown below:

###############################################################################
# File Name: reveilletcpcollector.config.SAMPLE
#
# RealTime TCP Collector configuration file (SAMPLE)
# Copyright (c) 2015 Reveille Software.
#
# This file contains common settings that control the Reveille 8 User Analytics TCP
# Collector.
#
# To use this file, copy it to the location of the
# Reveille 8 User Analytics TCP Collector, and rename it to "reveilletcpcollector.config".
# Note that file names are case sensitive.
#
# For a description of all available settings, see file
# reveilletcpcollector.config.FULL.
# 
###############################################################################  
###############################################################################   

# [GENERAL]
#
ConnectorAddress = 192.168.1.100
ConnectorPort = 3400
DeviceNames = en0
ConnectorEncryptData = false
ConnectorMaxQueueSize = 0
ConnectorMetricsTimeInterval = 60
ConnectorRetryMins = 5
ConnectorSendThreads = 5
#sslOptions = address=10.0.60.225;port=8443;keyfile=tomcatkey.pem;password=cmV2ZWlsbGU=;|address=10.94.77.83;port=12010;keyfile=/Workspace/tcpcollector/Debug/xtrac_workingkey.pem;password=;
UseGlobalFilters = false
#GlobalFilters = HostAddressFilter = 10.0.0.5;10.0.0.23; ClientAddressFilter = 10.0.0.*; ExcludeClientAddressFilter = 10.0.0.5:25

###############################################################################   
# [TCP]
#
TCP.Capture = true
#TCP.TcpPorts = 80,8080
#TCP.Filters = HostAddressFilter = 10.0.0.5;10.0.0.23; ClientAddressFilter = 10.0.0.*; ExcludeClientAddressFilter = 10.0.0.5:25

###############################################################################    
# [TDS]
#
TDS.Capture = true
TDS.SendMessages = true
#TDS.TcpPorts = 1433,2433
#TDS.Filters = HostAddressFilter = 10.0.0.5;10.0.0.23; ClientAddressFilter = 10.0.0.*; ExcludeClientAddressFilter = 10.0.0.5:25

###############################################################################     
# [DFC]
DFC.Capture = true
DFC.SendMessages = true
#DFC.TcpPorts = 1489,1490,47625,47632
#DFC.Filters = HostAddressFilter = 10.0.0.5;10.0.0.23; ClientAddressFilter = 10.0.0.*; ExcludeClientAddressFilter = 10.0.0.5:25

###############################################################################     
# [FileNet]
FileNet.Capture = false
#FileNet.TcpPorts = 2809,7001-7002,1099,3528-3529,9100
#FileNet.Filters = HostAddressFilter = 10.0.0.5;10.0.0.23; ClientAddressFilter = 10.0.0.*; ExcludeClientAddressFilter = 10.0.0.5:25

###############################################################################
# [TNS]
#
TNS.Capture = false
TNS.SendMessages = true
#TNS.TcpPorts = 1521
#TNS.Filters =
 
###############################################################################    
# END OF FILE
###############################################################################

Start the AIX collector after updating the reveilletcpcollector configuration file using the –start option.
sudo ./rrttcpcollector–start