Agent Installation
To use the WhaTap monitoring service, after Sign in, create a project and install the agent to the target server. For more information about registration as a member, see the following.
Creating a project
Create a project before installing the agent.
-
Log in to the WhaTap Monitoring Service.
-
In the left side menu, click All Projects > + Project.
-
On the Select product screen, select the product you want to install.
-
Enter or select the following items:
-
Project name: Enter the project name.
-
Data server region: Select the data server region. A region is a group of data centers that provide cloud services. Your data will be stored in the selected region.
-
Time zone: Set the time zone to be used for alerts and report generation.
-
Notification language setting: Set the language for alert notifications. (Supports Korean and English)
-
Project groups: Group multiple projects for easier management. Select a group if applicable.
-
Project description: Add additional details or a description for your project.
-
-
After completing all settings, click the Creating a project button.
If you add a project while an organization is selected, you must set the Groups of organization field.
For more information about groups, see the related document.
Checking the access key
The access key is the unique ID to enable the WhaTap service.
In the installation guide section, select Getting the access key. After the access key has been issued automatically, proceed to the next step.
After a project has been created, the Agent installation page appears automatically. If the Agent installation does not appear, select Management > Agent installation on the left of the screen.
Download Agent
If the access key has been granted, in the Download agent section, the Download button is enabled.
-
Select Download to download the WhaTap agent file.
TipYou can directly download it from the server by using the following command:
wget https://api.whatap.io/agent/whatap.agent.java.tar.gz -
Connect the server to be monitored.
-
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}
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_HOMEpath, enter a 6-character password consisting of alphabets and numbers as follows:security.confparamkey=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_HOMEpath, enter a 6-character password consisting of alphabets and numbers as follows:paramkey.txtABCDEF # SQL variable and HTTP query lookup, thread stop function
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.
-
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.