Skip to main content

Agent name identification

WhaTap basically uses the data collected from application servers to identify each server while collecting monitoring data. Basic information uses the application server as a unique identifier by a combination of application server's type, IP address, and such. If necessary, use the name set by the user or change the pattern to a unique value. The agent name must be unique.

The reason why the data extracted from the application server is used, is like the following. When a communication loss caused by the stop of the application server, network disconnection, or agent problem between the collection server and the agent, is restored, the continuity of the data from the reconnected agent is maintained.

  • The agent names must be unique on a project basis.
  • If the agent ID and name have been changed, previous data is not connected.
  • In WhaTap Monitoring, the object and agent can be used interchangeably as the monitoring target.

How to determine the default name

If there is no setting for whatap.oname as an JVM option, agent names are automatically assigned in the following priority.

  1. whatap.type is identified.
  2. When whatap.type is a servlet container, the port used by the application is identified.
  3. If the port cannot be identified, the process ID (PID) is retrieved.
  4. By adding the third and fourth IPv4 addresses to the identified information, the final name is determined.

For example, if Tomcat is started with the port 8080 on a server whose IP address is, the agent name is automatically assigned with TC-12-13-8080.

Variable of the agent name

Available name variables are as follows:

StringThe entered string is used.
{type}The container type is automatically identified and assigned.
{ip0}The first byte of the IPv4 address is used. (e.g. 10 in
{ip1}The second byte of the IPv4 address is used. (e.g. 11 in
{ip2}The third byte of the IPv4 address is used. (e.g. 12 in
{ip3}The fourth byte of the IPv4 address is used. (e.g. 13 in
{pid}The process ID (PID) of Java is used.
{port}The port that the application listens to is used.

Setting the agent name

Instead of the name that has been automatically assigned, you can enter the name by adding the JVM option into the startup script.

OptionSetting locationDescription
-Dwhatap.nameJVM OptionsSet the agent name as a pattern.
default: {type}-{ip2}-{ip3}-{port}
-Dwhatap.onameJVM OptionsSet the agent name to a fixed value. If the
option is not set, the pattern set in the option is applied.

In the environment where the IP address is and the port number is 8000,

  • In case the -Dwhatap.oname option is not applied: whatap.oname defaults to JAVA-12-13-8000 according to the pattern set in

  • In case the -Dwhatap.oname option is applied: The option is ignored and the agent name is applied as the value set in the -Dwhatap.oname option.

  • In the scale out environment of the cloud, VM can be copied and used. Thus, it is important that object names are automatically assigned.
  • If two VPC environments have been created and the network has been set to use the same private IP, the two VPCs must not be duplicated. For example, it can be separated as another project or the option can be set by combining the name variables in different ways.

The following options can be applied as an agent name to whatap.conf.

  • String

    Default {type}-{ip2}-{ip3}-{port}

    Set the agent name with patterns.

  • whatap.okind String

    Set the group unit to which the agent belongs. By setting multiple agents together, the topology can be checked by the group name.

  • whatap.onode String

    Set the node unit to which the agent belongs.

  • auto_oname_enabled Boolean

    Default false

    The function to automatically obtain the agent name (whatap.oname) from the server is activated. Upon application, the options for and -Dwhatap.oname are ignored. It obtains whatap.oname through communication with the collection server and then starts the agent's operation.

  • auto_oname_prefix String

    Default agent

    When an agent name is automatically granted from the server, the prefix of the agent name (business name as usual) is used. The prefix + serial number (from 1) is assigned.


    The auto_oname_enabled option that automatically assigns agent names, must be enabled (true) to use the option.

  • auto_oname_reset Int

    Default 0

    Modify it to obtain a new agent name from the server. If the agent name is automatically granted, the system environment variable, whatap.oname is set. Once set, the system environment variables are not changed until the Java instance is restarted. For a reset, modify the value of auto_oname_reset. If you change it to a value different from the current setting, it is to be applied.