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.

Agent naming method

The default patterns used to identify the application server are as follows:

Default pattern
{type}-{ip2}-{ip3}-{cmd}-{cmd_full}

To change the default pattern value, modify whatap.conf as follows:

whatap.conf
object_name={type}-{ip2}-{ip3}-{process}-{dockerid}-{ips}

Variable of the agent name

VariableDescription
{type}Name of the application server
{ip0}The first byte of the IPv4 address is used. (e.g. 10 in 10.11.12.13)
{ip1}The second byte of the IPv4 address is used. (e.g. 11 in 10.11.12.13)
{ip2}The third byte of the IPv4 address is used. (e.g. 12 in 10.11.12.13)
{ip3}The fourth byte of the IPv4 address is used. (e.g. 13 in 10.11.12.13)
{process}Process name of the application server
{hostname}Host name
{dockerid}ID of the docker container
{ips}It is the full IP (IPv4, IPv6).
{cmd}Process name. It is the value of the executable args[0].
{cmd_full}All command lines are processed using hash value. They correspond to all executable args.

Setting the agent name

  • object_name String

    Default {app_name}-{ip2}-{ip3}-{cmd}-{cmd_full}

    It is an agent naming (ONAME) scheme to identify applications. An OID is created based on the ONAME.

  • app_name String

    It is a component used in the agent naming (ONAME) scheme to identify applications. It corresponds to the {type} among the object_name options.

  • whatap.okind String

    You can configure monitoring units by grouping multiple agents into "type-based" groups. This option allows you to monitor and manage multiple agents in groups, analyze performance metrics, and set the alerts.

    Note

    You can check it as a group option classified as By kind in the Dashboard and Analysis, Statistics menus.

  • whatap.onode String

    You can configure monitoring units by grouping multiple agents into "node-based" groups. This option allows you to monitor and manage multiple agents in groups, analyze performance metrics, and set the alerts.

    Note

    You can check it as a group option classified for nodes in the Dashboard and Analysis, Statistics menus.