Skip to main content

Install Java Agent

Download Agent​

If the access key has been granted, in the Download agent section, the Download button is enabled.

  1. Select Download to download the WhaTap agent file.

    Tip

    You can directly download it from the server by using the following command:

    wget https://api.whatap.io/agent/whatap.agent.java.tar.gz

  2. Connect the server to be monitored.

  3. Unzip the agent file at the desired location of the target server to monitor. The unzipped path becomes $WHATAP_HOME.

    tar -zxvf whatap.agent.java.tar.gz

Agent installation file configuration​

The agent file consists of a tracer that extracts data for application monitoring and passes to the WhaTap collection server, and the elements that help the tracer send the data.

Configuring the whatap.conf file​

Entry of basic information​

Go to the unzipped $WHATAP_HOME path. Enter the access key and data collection server's IP address in the $WHATAP_HOME/whatap.conf file. Go to the WhaTap monitoring service screen and then copy and paste the access key and collection server IP address from the Download agent item of the Install guide section.

license={access key}
whatap.server.host={collection server IP}
Note

For more information about whatap.conf, see the following.

Setting the security key​

Set a security key to query SQL variables and perform HTTP queries, or use the Thread stop function.

  • Java Agent 2.2.2 or later

    After creating the security.conf file in the $WHATAP_HOME path, enter a 6-character password consisting of alphabets and numbers as follows:

    security.conf
    paramkey=ABCDEF # SQL variable and HTTP query lookup
    threadkill=ABCDEF # Thread stop function

  • Java agent 2.2.2 or earlier

    After creating the paramkey.txt file in the $WHATAP_HOME path, enter a 6-character password consisting of alphabets and numbers as follows:

    paramkey.txt
    ABCDEF # SQL variable and HTTP query lookup, thread stop function
Tip

When updating the Java agent version to 2.2.2, the key values in the existing paramkey.txt file are automatically applied to the security.conf file. For example, if you used FEDCBA in paramkey.txt and updated to the version 2.2.2, it is applied to the security.conf file as follows:

paramkey=FEDCBA
threadkill=FEDCBA

If the paramkey.txt file does not exist, the key value of the security.conf file is automatically created as the key value of WHATAP.

Note

  • For agent settings related to recording SQL parameters, see the following.

  • For agent settings related to recording the HTTP parameters, see the following.

Adding the JVM options​

The method how to set depending on the application server environment is provided as follows. Before installing and applying the agent, check Support environment first.

Last updated on