Basic Configuration

The WhaTap server monitoring agent controls its operations through the whatap.conf configuration file. This document guides you through the basic agent configuration.

Note

Configuration file location

• Unix/Linux: $WHATAP_HOME/whatap.conf
• Windows: %WHATAP_HOME%\whatap.conf

After changing the configuration, you must restart the agent for the changes to take effect.

Agent name identification

WhaTap basically uses the data collected from the server for identifying the infrastructure server that is the target of monitoring data collection. The default value is the server's hostname.

Caution

• The agent names must be unique on a project basis.
• If the agent ID and name have been changed, previous data is not connected.

Note

To see the user-defined agent name in WhaTap Monitoring Service, restart the server.

For a user-friendly name, you can specify it in the configuration file as follows.

• Linux Shell

  export WHATAP_SERVER_NAME=user-friendly name
  
  echo "oname=$WHATAP_SERVER_NAME" |sudo tee -a /usr/whatap/infra/conf/whatap.conf

• Windows Power Shell

  # The admin role is required.
  $WHATAP_SERVER_NAME="user-friendly name"
  
  Add-Content "C:\Program Files\WhatapInfra\whatap.conf" "oname=$WHATAP_SERVER_NAME"

Network configuration

WhaTap transfers monitoring data after TCP connection between the server and the agent.

The agent handles data transfer and server control requests through a single TCP session. The node agent does not use UDP communication. Open the firewall from the node agent to the WhaTap collection server.

Collection server address and port

WhaTap servers are divided into data region servers, front servers, and Eureka. The data regions include Proxy, Yard, Keeper, etc. Among them, the agent communicates with the proxy server.

Set the proxy server address of the Whatap server in the Node agent (e.g. whatap.server.host=10.0.3.1/10.0.3.2). When setting the server address, enter as many addresses as the proxy server count. WhaTap server can use one or multiple proxy servers depending on the installation method.

WhaTap Proxy server listens on the port 6600. If there is no separate setting in the agent, the agent attempts to connect the port 6600.

whatap.conf

whatap.server.port=6600

Note

wo proxy servers cannot use different ports. When using multiple proxy servers, the listening port must be the same.

Connection and security

WhaTap is designed to collect monitoring data over public networks. Therefore, all monitoring data is encrypted before being transmitted to the server. To minimize overhead, WhaTap selectively encrypts data. The communication process between the agent and server is as follows:

1. Generate and copy the project access key when creating a project.
2. The project access key contains a secret key, so ensure it is not exposed externally.
3. When the agent starts, it establishes a TCP session with the WhaTap collection server.
4. The agent encrypts data using the communication secret key included in the project access key to request a new session security key.
5. The server generates the requested session security key and delivers it to the agent.
6. Subsequently, the agent encrypts data such as text and numbers before transmitting them to the server.

Note

To apply the changes, restart the server.

Agent resource limits

The WhaTap server monitoring agent for Linux and Windows servers provides the following agent settings to help maintain server stability and minimize the resource usage impact when any overload occurs.

Linux / Windows

Memory usage protection

The WhaTap agent automatically restarts the process when the memory usage exceeds the threshold (100 MB) to protect available memory on your server.

memory.usage.limit=104857600  # Memory usage threshold (100 MB, unit of byte)

Automatic restart

The WhaTap agent automatically restarts once a day. The cycle can be adjusted via user settings. This feature is provided to address data collection failures and temporary process malfunctions.

housekeeping.enabled=true             # Activation of automatic restart (Default: true)
housekeeping.hour=2                   # Restart time (based on the server time, Default: 2 O'clock)
housekeeping.exitoncheckfail=true     # Automatic restart upon collection failure (Default: true)

The restart time can also be specified in minutes, not only in hours. When you also set the housekeeping.minute option, the agent restarts after the time pointed to by housekeeping.hour and housekeeping.minute. In an environment with many servers, you can assign a different minute value per server so that the restart times do not pile up on the hour.

housekeeping.hour=2                   # Restart time (based on the server time, Default: 2 O'clock)
housekeeping.minute=30                # Restart minute (Default: 0)

Item	Description
housekeeping.hour	Hour of the restart time. Default 2
housekeeping.minute	Minute of the restart time. Default 0. With 0, the agent restarts within the specified hour as before

The supported agent versions are Linux and Windows 2.9.22 or later, and Unix (AIX, HP-UX, Solaris) 1.4.13 or later.

CPU usage protection

When the CPU usage exceeds the threshold, the WhaTap agent automatically adjusts the execution speed to protect the CPU availability of the server. It is disabled by default and can be enabled if necessary.

cpu.limit.enabled=false           # Disable the CPU usage protection (Default: false)
cpu.usage.limit=50                # CPU usage threshold (50% based on the sigle core)

Windows

Handle usage protection

In the Windows environment, if the number of handles used by the WhaTap agent exceeds the threshold (1,000), it is automatically restarted to protect the available handles of the user server.

windows.handle.threshold=1000    # Handle usage threshold (Default: 1,000)

Watchdog communication method

For an agent in a Windows environment, the monitoring process (watchdog) and the collection process exchange their status with each other. This communication uses a named pipe by default, and you can change it to a local TCP socket in environments where pipe writes fail and the communication is disconnected.

housekeeping.rpc.mode=socket     # Watchdog communication method (Default: pipe)
housekeeping.rpc.port=6601       # Port used in the socket method (Default: 6601)

Item	Description
housekeeping.rpc.mode	Watchdog communication method. With socket, a local TCP socket is used. The default is a named pipe
housekeeping.rpc.port	TCP port used in the socket method. Default 6601

The socket method is used only for internal (local) communication on the server, so you do not need to open an external firewall. However, make sure that the specified port is not in use by another program.