• All Files

Configure the HTTP Collectors

The following sections describe how to configure the Reveille User Analytics HTTP Collectors on each supported platform.

NoteThe Linux (and SUSE), Solaris, and AIX HTTP Collectors support the environment variable RRT_TMPDIR or TMPDIR for the path for the packet queue overflow files when using the MaxQueueSize option in the rrt config file. The default location is the \tmp directory.  A command line option for the indicating the LogPath is also available.
ClosedOn Windows

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

  1. On the Reveille User Analytics Collector Server, double-click the Reveille User Analytics HTTP Collector Settings desktop shortcut. The Reveille User Analytics Collector Settings window appears.

  2. 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.
  3. Click Save when finished.
  4. Click Start to start the Reveille User Analytics Collector Service.
ClosedOn Linux

To configure the Reveille User Analytics Linux HTTP 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.
  1. Navigate to the Linux Collector installation directory; the following steps are based on installing the Linux collector in the folder /opt/reveille_user_analytics.
  2. The Linux Collector is configured via the reveillecollector.confg file. Use a text editor to edit the configuration file. Before editing the file, review the following options:
    • First create the reveillecollector.config file from the reveillecollector.config.sample file using the cp command:

      cp reveillecollector.config.sample reveillecollector.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 Linux system hardware.

      sudo ./rrtcollector -adapters

    • To encode an SSL key file password use the –password option

      sudo ./rrtcollector –password

    • To display Linux collector help file; use the –help option:

      sudo./rrtcollector –help

    • Edit the reveillecollector.confg file using a text editor. A sample reveillecollector.config file is shown below: 
      # RealTime Collector configuration file.
      # Copyright (c) 2013 Reveille Software.
      #
      jjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjj
      # For example: Adapter = adapter1;adapter2;adapter3
      # 
      Adapter = eth0

      # The ip address of the RealTime Connector.
      #
      ConnectorAddress = 192.168.1.100

      # The port number used by the RealTime Connector.
      # The default port number is 3300.
      #
      ConnectorPort = 3300

      # Specifies how long the RealTime Collector waits (in minutes) for the
      # RealTime Connector to become available. Default is 5 minutes.
      #
      ConnectorRetryMins = 5

      # Specifies the number of threads/connections used in sending queued
      # packets to the connector. Default value is 1. Maximum is 20.
      #
      SendThreads = 1

      # Specifies the maximum number of packets held in memory. Once this threshold
      # is reached, additional packets are stored on disk. A value of 0 disables
      # this feature.
      #
      MaxQueueSize = 0

      # Collector options.
      # Specifies zero or more options, in the following format: option=value[;option=value]
      # Option           Description
      # ------           -----------
      # proto_filter        The list of protocols to monitor/capture.
      # http_port          The list of additional ports to associate with http traffic.
      #               Default port is 80.
      # ip_filter          The list of target ip addresses to monitor/capture.
      # client_ip_filter      The list of client ip addresses to monitor/capture. Can also
      #               indicate a range, 10.0.0.5:25 means all addresses in the range 
      #               from 10.0.0.5 to 10.0.0.25. A range of 10.00.* means all addresses
      #               in the complete range for 10.0.0.0 to 10.0.0.255. This can be used
      #               for any level of dot decimal notation (octet).
      # exclude_client_ip_filter  The list of client ip addresses and to exclude. Can also
      #               indicate a range.
      # max_data_len        The maximum amount of packet data to capture, in kilobytes.
      # timeout_response      The maximum amount of time to wait for a response, in milliseconds.
      # exclude_url_filter     The list of ending Url addresses to exclude. For example:
      #               .css,.gif,.png,.jpg,.bmp,.jar
      # 
      Options = protocol_filter=http;http_port=8080;max_data_len=100;timeout_response=1000;exclude_url_filter=.css,.gif,.png,.jpg,.bmp,.jar

      # SSL options for https.
      # Specifies zero or more options, in the following format: address=;port=;keyfile=;password=;[|address=;port=;keyfile=;password=;]
      # The list of Private Key files to use for an SSL connection for each
      # Server address and port. Valid private key files include PEM and PKCS/DER
      # formats. PEM format keys may be password encrypted.
      #
      # Example:
      #
      # SSL = address=10.0.xxx.z;port=443;keyfile=/opensslunencrypted.pem;password=cGFzc3dvcmQ=;|address=10.0.xxx.y;port=8443;keyfile=/opensslunencrypted.pem;password=cGFzc3dvcmQy;
      #
      SSL = 

      # EOF
  3. Start the Linux collector after updating the reveillecollector configuration file using the –start option.

    sudo ./rrtcollector –start

  4. 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

ClosedOn Solaris

To configure the Reveille 8 User Analytics Solaris HTTP 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.
  1. Navigate to the Solaris Collector installation directory; the following steps are based on installing the Solaris collector in the folder /opt/reveille_user_analytics.
  2. The Solaris Collector is configured through the reveillecollector.confg file. Use a text editor to edit the configuration file. Before editing the file, review the following options:
    • First create the reveillecollector.config file from the reveillecollector.config.sample file using the cp command:

      cp reveillecollector.config.sample reveillecollector.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 Solaris system hardware.

      ./rrtcollector -adapters

    • To encode an SSL key file password use the –password option

      ./rrtcollector –password

    • To display Solaris collector help file; use the –help option:

      ./rrtcollector –help

    • Edit the reveillecollector.confg file using a text editor. A sample reveillecollector.config file is shown below: 
      # RealTime Collector configuration file.
      # Copyright (c) 2013 Reveille Software.
      #
      # The names of the adapters on the local machine to monitor, separated by semicolons.
      # For example: Adapter = adapter1;adapter2;adapter3
      # 
      Adapter = eth0

      # The ip address of the RealTime Connector.
      #
      ConnectorAddress = 192.168.1.100

      # The port number used by the Reveille User Analytics Connector.
      # The default port number is 3300.
      #
      ConnectorPort = 3300

      # Specifies how long the RealTime Collector waits (in minutes) for the
      # RealTime Connector to become available. Default is 5 minutes.
      #
      ConnectorRetryMins = 5

      # Specifies the number of threads/connections used in sending queued
      # packets to the connector. Default value is 1. Maximum is 20.
      #
      SendThreads = 1

      # Specifies the maximum number of packets held in memory. Once this threshold
      # is reached, additional packets are stored on disk. A value of 0 disables
      # this feature.
      #
      MaxQueueSize = 0

      # Collector options.
      # Specifies zero or more options, in the following format: option=value[;option=value]
      # Option           Description
      # ------           -----------
      # proto_filter        The list of protocols to monitor/capture.
      # http_port          The list of additional ports to associate with http traffic.
      #               Default port is 80.
      # ip_filter          The list of target ip addresses to monitor/capture.
      # client_ip_filter      The list of client ip addresses to monitor/capture. Can also
      #               indicate a range, 10.0.0.5:25 means all addresses in the range 
      #               from 10.0.0.5 to 10.0.0.25. A range of 10.00.* means all addresses
      #               in the complete range for 10.0.0.0 to 10.0.0.255. This can be used
      #               for any level of dot decimal notation (octet).
      # exclude_client_ip_filter  The list of client ip addresses and to exclude. Can also
      #               indicate a range.
      # max_data_len        The maximum amount of packet data to capture, in kilobytes.
      # timeout_response      The maximum amount of time to wait for a response, in milliseconds.
      # exclude_url_filter     The list of ending Url addresses to exclude. For example:
      #               .css,.gif,.png,.jpg,.bmp,.jar
      # 
      Options = protocol_filter=http;http_port=8080;max_data_len=100;timeout_response=1000;exclude_url_filter=.css,.gif,.png,.jpg,.bmp,.jar

      # SSL options for https.
      # Specifies zero or more options, in the following format: address=;port=;keyfile=;password=;[|address=;port=;keyfile=;password=;]
      # The list of Private Key files to use for an SSL connection for each
      # Server address and port. Valid private key files include PEM and PKCS/DER
      # formats. PEM format keys may be password encrypted.
      #
      # Example:
      #
      # SSL = address=10.0.xxx.z;port=443;keyfile=/opensslunencrypted.pem;password=cGFzc3dvcmQ=;|address=10.0.xxx.y;port=8443;keyfile=/opensslunencrypted.pem;password=cGFzc3dvcmQy;
      #
      SSL = 

      # EOF
  3. Start the Solaris collector after updating the reveillecollector configuration file using the –start option.

    ./rrtcollector –start

ClosedOn AIX

To configure the Reveille 8 User Analytics AIX HTTP 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.
  1. Navigate to the AIX Collector installation directory; the following steps are based on installing the AIX collector in the folder /opt/reveille_user_analytics.
  2. The AIX Collector is configured via the reveillecollector.confg file. Use a text editor to edit the configuration file. Before editing the file, review the following options:
    • First create the reveillecollector.config file from the reveillecollector.config.sample file using the cp command:

      cp reveillecollector.config.sample reveillecollector.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 ./rrtcollector –adapters

    • To encode an SSL key file password use the –password option

      sudo ./rrtcollector –password

    • To display AIX collector help file; use the –help option:

      sudo ./rrtcollector –help

    • Edit the reveillecollector.confg file using a text editor. A sample reveillecollector.config file is shown below: 
      # RealTime Collector configuration file.
      # Copyright (c) 2014 Reveille Software.
      #
      # The names of the adapters on the local machine to monitor, separated by semicolons.
      # For example: Adapter = adapter1;adapter2;adapter3
      # 
      Adapter = eth0
      # The ip address of the RealTime Connector.
      #
      ConnectorAddress = 192.168.1.100
      # The port number used by the RealTime Connector.
      # The default port number is 3300.
      #
      ConnectorPort = 3300

      # Specifies how long the RealTime Collector waits (in minutes) for the
      # RealTime Connector to become available. Default is 5 minutes.
      #
      ConnectorRetryMins = 5

      # Specifies the number of threads/connections used in sending queued
      # packets to the connector. Default value is 1. Maximum is 20.
      #
      SendThreads = 1

      # Specifies the maximum number of packets held in memory. Once this threshold
      # is reached, additional packets are stored on disk. A value of 0 disables
      # this feature.
      #
      MaxQueueSize = 0

      # Collector options.
      # Specifies zero or more options, in the following format: option=value[;option=value]
      # Option           Description
      # ------           -----------
      # proto_filter        The list of protocols to monitor/capture.
      # http_port          The list of additional ports to associate with http traffic.
      #               Default port is 80.
      # ip_filter          The list of target ip addresses to monitor/capture.
      # client_ip_filter      The list of client ip addresses to monitor/capture. Can also
      #               indicate a range, 10.0.0.5:25 means all addresses in the range 
      #               from 10.0.0.5 to 10.0.0.25. A range of 10.00.* means all addresses
      #               in the complete range for 10.0.0.0 to 10.0.0.255. This can be used
      #               for any level of dot decimal notation (octet).
      # exclude_client_ip_filter  The list of client ip addresses and to exclude. Can also
      #               indicate a range.
      # max_data_len        The maximum amount of packet data to capture, in kilobytes.
      # timeout_response      The maximum amount of time to wait for a response, in milliseconds.
      # exclude_url_filter     The list of ending Url addresses to exclude. For example:
      #               .css,.gif,.png,.jpg,.bmp,.jar
      # 
      Options = protocol_filter=http;http_port=8080;max_data_len=100;timeout_response=1000;exclude_url_filter=.css,.gif,.png,.jpg,.bmp,.jar

      # SSL options for https.
      # Specifies zero or more options, in the following format: address=;port=;keyfile=;password=;[|address=;port=;keyfile=;password=;]
      # The list of Private Key files to use for an SSL connection for each
      # Server address and port. Valid private key files include PEM and PKCS/DER
      # formats. PEM format keys may be password encrypted.
      #
      # Example:
      #
      # SSL = address=10.0.xxx.z;port=443;keyfile=/opensslunencrypted.pem;password=cGFzc3dvcmQ=;|address=10.0.xxx.y;port=8443;keyfile=/opensslunencrypted.pem;password=cGFzc3dvcmQy;
      #
      SSL = 

      # EOF
  3. Start the AIX collector after updating the reveillecollector configuration file using the –start option.

    sudo ./rrtcollector –start

Was this helpful?

Thank you.