Prepare to Install the Data Collectors

To ensure that the data collector installation is successful, complete the requirements before you install a data collector.
HID_Prepare_to_Install_the_Data_Collector
Ensure that the data collectors install successfully by completing these requirements before you install them.
In this article:
Review Data Collector Considerations
In a standard tenant deployment, each tenant has a dedicated data collector, and the data collector supports only one data aggregator. In a multi-tenant environment, a managed service provider monitors devices for multiple tenants. For multi-tenant deployments, where tenants reside in the same Internet Protocol (IP) routing space, you can configure
DX NetOps Performance Management
to use fewer data collectors.
For more information, see Tenant-Agnostic Data Collectors.
Review the following considerations:
Standard Tenant Deployment Considerations
The following considerations apply to a standard tenant deployment:
  • You can install one or more data collectors. Install each data collector on a separate host.
  • If the data aggregator is only IPv6, the data collector must support the IPv6 protocol.
    To verify that the data collector supports IPv6, take the following steps on the data aggregator host:
    1. Find the IPv6 address by issuing the following command:
      > ifconfig
    2. Ensure that the data collector can contact the data aggregator using its IPv6 address by issuing the following command:
      > ping6
      ipv6_address_of_data_aggregator
Multi-tenant Deployment Considerations
The following consideration applies to a multi-tenant deployment. You can do
one
of the following:
  • Install the data collector at the managed service provider (MSP) site.
    This setup requires that the data collector gain access through a tenant firewall to poll managed devices.
  • Install the data collector at each tenant site.
Data Collector Disk Usage Considerations
The data collector uses a disk cache. The default disk cache size is equal to 50% of the maximum data collector memory. By default, this value is equal to 45 minutes, or 500K, of data when you use a 5-minute poll rate.
For more information about the default disk cache size, see Modify the External ActiveMQ Memory Limit.
When the disk cache reaches 90% saturation of the disk cache size, the data collector rolls data off the back of the queue. The data collector uses disk space to cache poll messages (temporary messages). When the disk cache is full, the data collector drops the oldest polled messages, keeping the latest, and posts a log message to the
<DC_installation_directory>
/IMDataCollector/apache-karaf-*/data/log/karaf.log
file.
The following is an example of the log message:
DATE TIME | WARN | pool-15-thread-1 | PRQCleanupService | e.jms.health.PRQCleanupService$2 135 | 175 - com.ca.im.common.core.jms - X.X.X.RELEASE-XXX | | JMS Health: dropped 178895/178895 messages from PRQ (dropRate=10%, maxDiskUsage=2566M)
  • DC_installation_directory
    The installation directory for the data collector.
    Default:
    /opt
  • apache-karaf-*
    The installation directory for Apache Karaf.
    Example:
    apache-karaf-4.2.6
When the data aggregator and data collector connect, the data collector sends the oldest messages first. Cached poll responses can take some time before they display in
NetOps Portal
.
If you restart ActiveMQ, the cached data is lost.
To monitor the cache burndown, locate the
<DC_installation_directory>
/IMDataCollector/apache-karaf-*/etc/org.ops4j.pax.logging.cfg
file, and then create the following entries in the file:
log4j.logger.com.ca.im.core.jms.health.JmsBrokerHealthAnalyser=DEBUG,sift log4j.additivity.com.ca.im.core.jms.health.JmsBrokerHealthAnalyser=false
  • DC_installation_directory
    The installation directory for the data collector.
    Default:
    /opt
  • apache-karaf-*
    The installation directory for Apache Karaf.
    Example:
    apache-karaf-4.2.6
The
<DC_installation_directory>
/IMDataCollector/apache-karaf-*/data/log/com.ca.im.common.core.jms.log
file is created.
Verify the Prerequisites
Meet the following prerequisites before you install data collector:
  • On the data aggregator system, verify that ports 61616, 61618, 61620, and 61622 are open. These ports enable communication between the data collector and the data aggregator.
    For more information about the ports that are required to be open for
    DX NetOps Performance Management
    communications to function properly, see Installation Requirements and Considerations.
  • Verify that ports 1099 and 11099 are blocked from external access. These ports must remain open locally for internal communication.
  • Verify that Security Enhanced Linux (SELinux) is disabled on the computer where you are going to install data collector. By default, some Linux distributions enable this feature, which does not allow data collector to function properly. Disable SELinux or create a policy to exclude data collector processes from SELinux restrictions.
    For more information about how to configure an SELinux security policy, see the Red Hat documentation.
  • To avoid database corruption of ActiveMQ broker files, exclude the installation directory, and all its subdirectories, from antivirus scans. Prevent scanning by a local instance of an antivirus client and scanning by a remote antivirus instance.
  • Ensure that your desired tenant and corresponding IP domain are provisioned in
    NetOps Portal
    . While a single IP domain can be associated with more than one data collector, each data collector can have only one IP domain assigned to it.
    If you are not deploying multi-tenancy, use the Default Tenant and the Default Domain.
  • The installer requires the zip and unzip packages. If these packages are not installed, issue one of the following commands to install them:
    yum -y install zip unzip
    SLES:
    zypper install -y zip unzip
  • The data collector uses the "at" package to schedule the restart of the application when assigning a Tenant or IP Domain. Verify whether the "at" package is installed on each data collector host by issuing the following command:
    rpm -qa | grep ^at
    If the command does not return a result, install the package:
    If you are not the root user, use the sudo prefix.
    yum install at
    zypper install -y at
(Optional) Configure the Sudo User Account for Data Collector
If you do not have root access to install and run the data collector, configure the sudo user account. As a sudo user, you can add the sudo prefix to all commands to install the data collector, for example
sudo ./install.bin
.
Follow these steps:
  1. Locate the
    /etc/sudoers
    file on the data collector host.
  2. Add
    one
    of the following command aliases with the following permissions to the file:
    • Default:
      Cmnd_Alias CA_DATACOLL = /tmp/install.bin,/sbin/service dcmd *, /opt/IMDataCollector/Uninstall/Uninstall, /opt/IMDataCollector/RemoteEngineer/re.sh, /opt/IMDataCollector/scripts/dcmd, /usr/bin/crontab
      ## Allows the <caimdc> user to manage the <caimdc>
      sudouser
      ALL = CA_DATACOLL
      • sudouser
        Specify the user who can run the sudo commands.
        This command alias details the commands that the sudo user must be able to run.
    • SLES:
      Cmnd_Alias CA_DATACOLL = /tmp/install.bin,/usr/sbin/service dcmd *,/usr/sbin/service activemq *,/opt/IMDataCollector/Uninstall/Uninstall, /opt/IMDataCollector/RemoteEngineer/re.sh, /opt/IMDataCollector/scripts/dcmd, /usr/bin/crontab
      ## Allows the <caimdc> user to manage the <caimdc>
      sudouser
      ALL = CA_DATACOLL
      • sudouser
        Specify the user who can run the sudo commands.
        This command alias details the commands that the sudo user must be able to run.
Configure UTF-8 Support
Configure the data collector host to support UTF-8 encoding. If UTF-8 encoding is not enabled, characters might not display properly during the installation.
The appropriate language packs are also required to support localized deployments.
Some of the scripts used in the installation of selected components are not localized and run in English.
For more information, see the
Localization Status Readme
file.
Follow these steps:
  1. Do
    one
    of the following steps:
    • Issue the following command from a Korn or bash shell:
      export LANG=LANG_value ; export LC_ALL=$LANG
      • LANG_value
        specifies the value of the language you want the product to support. The following variables are supported:
        English:
        en_US.utf8
        French:
        fr_FR.utf8
        Japanese:
        ja_JP.utf8
        Simplified Chinese:
        zh_CN.utf8
        Traditional Chinese:
        zh_TW.utf8
      For example:
      export LANG=zh_TW.utf8 ; export LC_ALL=$LANG
    • Issue the following command from a Bourne shell:
      LANG=
      LANG_value
      ; export LANG
      LC_ALL=
      LANG_value
      ; export LC_ALL
      For example:
      LANG=zh_CN ; export LANG
      LC_ALL=zh_CN ; export LC_ALL
    The language variable is set.
Set a Unique Hostname for the Data Collector Host
Set a unique hostname for the computer where you plan to install data collector.
Follow these steps:
  1. As the root user, log in to the data collector host.
  2. Verify the unique hostname on the computer.
    The hostname for the computer must be associated with the IP address and
    not
    the loopback address of 127.0.0.1.
  3. Verify that the following lines appear in the
    /etc/hosts
    file on the computer:
    Do not remove the following line, or various programs
    # that require network functionality will fail.
    127.0.0.1 localhost localhost.localdomain localhost4 localhost4.localdomain4
    ::1 localhost localhost.localdomain localhost6 localhost6.localdomain6
    IP address of your host YourHostName YourHostName.ca.com
  4. If the hostname required any changes, restart the network by issuing the following command:
    service network restart
    The
    /etc/hosts
    file is configured correctly.
    The unique host name is set.
These ports must remain open locally for communication between the data aggregator and the data collectors.
(Optional) Plan for a
DX NetOps Virtual Network Assurance
Installation on the Same Host as the Data Collector
If you plan to monitor software-defined networking (SDN) and network functions virtualization (NFV) using
DX NetOps Virtual Network Assurance
(VNA), and you plan to install VNA on the
same
host as the data collector, ensure that you allocate enough memory to the host.
Best Practice:
Install VNA on a
separate
host as the data collector.
Determine how much memory the data collector will require using the DX NetOps Sizing Tool.