DocsDeployment & Installation > On-Prem Deployment & Installation > Deployment on Existing Kubernetes Cluster

vuHealthAgent – Java – 1.2.0 : AIX and Solaris


vuHealthAgent is a data collection agent used on systems running Solaris and AIX for

  1. Collection of system health metrics
  2. Node and Port heartbeat

The collected metrics and heartbeat data are sent to the vuSmartMaps data collection node or the shipper.


  1. vuHealthAgent needs java version 1.6 or higher. Ensure that a supported java version is installed on the system and is available to the user $PATH.
  2. A sudo user with elevated privilege or root user access is required to create startup scripts during installation.
  3. The agent does not need any superuser privileges for running.
  4. Firewalls, if any, should allow the outgoing TCP port of the vuSmartMaps Data collector/shipper from the node on which this agent is installed.

Firewall Requirements

The node on which the agent is installed should be allowed to connect to the vuSmartMaps data collector/shipper IP and TCP/UDP port configured for the agent.

The default ports on which data is sent are

  • TCP/UDP – 5090
  • Kafka – 9092

Supported OS

  • AIX – 7.1, 7.2, 7.3
  • Solaris – 11.2, 11.3, 11.4


  1. extract the package and run the install script.

    tar -xvf vuhealthagent-java.tar


  2. Choose the installation option:
    1. Select “1” to install the agent for the first time
    2. Select “2” to upgrade the agent. The upgrade option will only update the binaries and leave the configurations intact.
  3. Enter to accept the default directory. If you want the agent to be installed elsewhere, please specify the directory path.example,

    /home/$USER          – The installation will create vuHealthAgent directory inside /home/$USER/

    /home/$USER/agents  – The agents directory should exist in the system.

  4. The installation will ask to provide sudo access to create soft links for the startup script.Enter [y] to accept this and provide the root username and password to proceed with.If you don’t have sudo access enter ‘n’ and skip the above steps. But, you have to run these steps manually with sudo access.

Enabling services at startup manually

Login with sudo user or root user and run the below commands based on your os.


ln -s (VUHEALTHAGENT_HOME)/etc/init.d/vuhealthagent-boot /etc/rc3.d/S99vuhealthagent
ln -s (VUHEALTHAGENT_HOME)/etc/init.d/vuhealthagent-boot /etc/rc3.d/K99vuhealthagent


ln -s (VUHEALTHAGENT_HOME)/etc/rc.d/init.d/vuhealthagent-boot /etc/rc.d/rc3.d/S99vuhealthagent
ln -s (VUHEALTHAGENT_HOME)/etc/rc.d/init.d/vuhealthagent-boot /etc/rc.d/rc3.d/K99vuhealthagent

Note: (VUHEALTHAGENT_HOME) is the directory where vuHealthAgent is installed.


After the installation, the script will ask for the configuration of the installed agent. press y to configure the agent on the go or press n to skip the configuration and you have to manually configure it by updating (VUHEALTHAGENT_HOME)/conf.d/config.yml

The configuration will update the following attributes:

  1. Shipper/Target IP  –  The remote vuSmartMaps system where the data is to be sent
  2. PROTOCOL  –  The protocol to be used to communicate to the remote machine.We support the below output channels:
    1. Kafka
    2. logstash
  3. PORT  –  The port on which the agent has to be connected on the remote machine.
  4. INTERVAL  –  The frequency of data collection.
  5. TOPIC   –  The topic name where we have to send the data in case of Kafka protocol.

Note: A general assumption is agents are installed with the knowledge of the exact collection method and listening port setup at the vuSmartMaps end. If this information is not yet known, contact Vunet support.

Understand the config.json

Common Options

  1. tenant_id => Tenant ID. This is an id given to identify a unique organization/installation in a multi-tenant environment. Please set it to “1” if this installation is not part of a multi-tenant vuSmartMaps setup.
  2. bu_id => Bu ID. This is an ID to identify a sub-organization within a main organization/installation in a multi-tenant environment. Please set it to “1” if this installation is not part of a multi-tenant vuSmartMaps setup.
  3. output => This configuration part is to set the target protocol, ip and port
  4. host => The host where the agent runs.
  5. metricsets => The metric sets to be collected.

Heartbeat Block

This part of the configuration contains options to configure targets and ports to determine a given service availability using periodic heartbeat.

The agent supports service heartbeat only.

List of dictionary blocks, each containing the following mandatory fields:

  1. hosts => list of hosts:port to send heartbeat packets to.
  2. fetchInterval => Heartbeat interval in seconds


– metricset: serviceAvailability
enabled: false


– type: tcpping

– doc_type: heartbeat

fetchInterval: 120


– url/ip:port

– url/ip:port

Note: You have to manually uncomment the heartbeat block in the config file to enable it.

Health Metricsets

This part of the configuration is used to enable the list of system metrics to collect from the node. Each block will contain the following mandatory fields.

  • enabled => Define if the module is enabled or not for the data collection


– metricset: memory
enabled: true


– metricset.module: system

– memory

– doc_type: metricbeat

– type: memory

– tags: vuagent

Currently supported health metricsets are:

  1. memory
  2. pagingSpace
  3. load
  4. core
  5. cpu
  6. disk
  7. process
  8. diskio
  9. network

Note: The default configuration enables memory, load, core, cpu, disk, process, and diskio.  The agent install wizard will assist in adding only the required metrics.


Logs are written to (VUHEALTHAGENT_HOME)/log/vuhealthagent.log by default.

The default log level is DEBUG. This can be changed in


Managing vuHealthAgent Service


(VUHEALTHAGENT_HOME)/etc/init.d/vuhealthagent start
(VUHEALTHAGENT_HOME)/etc/init.d/vuhealthagent stop
(VUHEALTHAGENT_HOME)/etc/init.d/vuhealthagent status


(VUHEALTHAGENT_HOME)/etc/rc.d/init.d/vuhealthagent start
(VUHEALTHAGENT_HOME)/etc/rc.d/init.d/vuhealthagent stop
(VUHEALTHAGENT_HOME)/etc/rc.d/init.d/vuhealthagent status

Know the Version

/path/to/service/vuhealthagent version


The vuHealthAgent package comes with an uninstall script to uninstall.

To uninstall, simply go to the extracted setup directory and run


Uninstallation is then complete.


Browse through our resources to learn how you can accelerate digital transformation within your organisation.

Quick Links