Agent Installation

The following guides you to the basic installation method for using the WhaTap database monitoring service.

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.

See the following video guide.

Creating a project

Create a project before installing the agent.

1. Log in WhaTap monitoring service.

2. To create a project, on the left of the screen, select All Projects > + Project.

3. Select a product in Select product for installation.

4. Configure the settings for Project name, Data server region, and Time zone.

   

5. In Notification language setting, select the language for alert messages.

6. After all settings are finished, select Creating a project.

Note

• A Data server region refers to a region (a bundle of data centers installed to provide cloud services). Selecting a specific region stores your data in the datacenter that belongs to that region.

• Time zone is the reference time for generating alerts and reports.

• To group multiple projects for management, select a group from Project groups or add a group. For more information about grouping, see the following.

• To add a project with an organization selected, Groups of organization must be set.

Checking the project access key

Project access key is the unique ID for activating the WhaTap services.

In the installation guide section, select Getting the access key. After automatic reception of project access key, proceed to the next step.

Tip

After a project has been created, the Agent installation page appears automatically. If the Agent installation does not appear, select All projects on the left and then select a newly created project.

Downloading the WhaTap database agent

1. Download the agent file. Use the following two methods.

   • On the WhaTap monitoring service screen, select Download for downloading.

   • You can download with the Linux wget method. Use the following command.

     wget -O whatap.agent.database.tar.gz "https://service.whatap.io/download/dbx_agent?type=mongodb&format=tar.gz"
   Note

   For those who cannot download tar files due to security settings, ZIP files are also provided. On the installation screen, select the .zip Download button.

2. Copy the downloaded file to the server to be analyzed, and then unzip it. (Same for Windows and Linux)

   Agent configuration file

   File name	Description
   whatap.conf	This is the file where you can enter the address of the collection server that collects data from the database server and the server's project access key. For more information about the agent configuration, see the following.
   alert/alert.conf	This is the file that sets thresholds for monitoring items to be collected. An alert occurs when the threshold is exceeded.
   scripts/	This directory contains the scripts that can remotely run SQL scripts.
   ps.sh	This script fetches the process ID. When ending the agent process, the ID is referenced.
   stop.sh	This script is used when ending the agent process.
   uid.sh (uid.bat)	This shell script file generates an encrypted UID by combining the database connection data. It creates the db.user file. Once you have set it for the first time, it collects data from the database server to be monitored through the encrypted UID. For more details about creation of an account for monitoring, see the following.
   start.sh (start.bat)	This shell script file runs the agent. When the agent starts, it starts collecting monitoring data from the database server.
   startd.sh (startd.bat)	This shell script file runs the agent, which can be run in the background.
   whatap.agent.dbx-X.Y.Z.jar	The Tracer program is a program that collects data from the database server and transmits the collected data to the server.
   jdbc	This directory collects the libraries referenced for database server connection. Download the library for connecting the agent and database server and use it by setting the path in the class path option of Java.
   xos/	The directory contains the optional agent that can monitor the process usage of the database server.
   ⎿ xos.conf	This file is used to enter the address and communication port of the agent server for collecting the process usage of the database server and transmitting the data.
   * xcub/	This directory contains additional agent files that collect SQL texts from the CUBRID database and calculate metrics.
   ⎿ * xcub.conf	This file is used to enter the CUBRID database and additional agent connection settings.

   Note

   ^*: The files in the xcub path are dedicated files for CUBRID Monitoring.

3. Enter the unzipped folder and then check the whatap.conf file. In whatap.conf, enter the project access key, WhaTap server data, and DB connection data.

   whatap.conf

   license={Access_Key}
   whatap.server.host=13.124.11.223/13.209.172.35 # WhaTap server information
   
   dbms=mongodb
   db={Database_name} # sid
   db_ip={DB_server_IP_address}
   db_port={DB_server_port}

4. Download the JDBC driver to the following directory. /unzipped folder/jdbc

   Download the JDBC driver for the OS and version of your database server.

   MongoDB JDBC Drivers: https://github.com/mongodb/mongo-jdbc-driver

Note

• Depending on the DB configuration, the additional settings may be required in the whatap.conf file. For more information, see the following.

• To further monitor the DB server's resources, use the XOS agent. For more information, see the following.

• In /unzipped folder/jdbc/README.md, you can also see the JDBC driver installation paths for each database.

Account creation

Create an account with roles required for database monitoring. Log in with the root account and then create accounts.

Note

• To use the previous accounts, go to Create DB User File. If you do not have any permission, you may not be able to proceed with normal monitoring.

• In the example code, whatap is the DB user account name. Change it to your account name.

• Enter your password in DB_Password in the example code.

db.createUser(
  {
    user: "whatap",
    pwd: "DB_Password",
    roles: [
        { "role" : "clusterMonitor", "db" : "admin" },
   ]
  }
)

Note

• If the user and pwd values ​​include special characters, they must be converted using the percent encoding. For example, if the password is whatap@#, it must be converted to whatap%40%23 for entry. For more information, see the following link.

• For more information about the account creation in the MongoDB environment, see the following link.

DB user file creation

Tip

If you do not use the user and password (you can access MongoDB without authentication), you can skip the Create database user file step.

Generate an encrypted UID for database connection. Enter the username and password and then run the shell script (or batch file).

Linux

BASH

./uid.sh {DB_USER} {DB_PASSWORD}

Note

• After setting it once, it collects data from the database server to be monitored through the encrypted UID.

• To create a DB user file, enter the project access key in the whatap.conf file. Checking the access key

• In the Azure database environment, enter DB_USER in the form of DB_USER@DB_name.

• If special characters are included in DB_USER or DB_PASSWORD, enter the escape character (\) together before any special characters.

  Example

  ./uid.sh whatap whatap\!pwd
  
  # If there are multiple special characters, add the escape character(\) for each.
  ./uid.sh whatap whatap\!\@pwd

Windows

CMD

uid.bat "DB_USER" "DB_PASSWORD"

Note

• After setting it once, it collects data from the database server to be monitored through the encrypted UID.

• To create a DB user file, enter the project access key in the whatap.conf file. Checking the access key

• In the Azure database environment, enter DB_USER in the form of DB_USER@DB_name.

• If special characters are included in DB_USER or DB_PASSWORD, enter the escape character (\) together before any special characters.

  Example

  uid.bat whatap whatap\!pwd
  
  # If there are multiple special characters, add the escape character(\) for each.
  uid.bat whatap whatap\!\@pwd

Starting the monitoring

Execute a shell script (or batch file) from the path where you have installed the agent.

Linux

./start.sh

To use it like a daemon, execute the following command. However, it works only in the environment where nohup has been installed.

./startd.sh

Windows

start.bat

You can set the service to automatically start the agent when the Windows system starts. See the following commands.

# In case of registering the service
install_WindowsService.bat create WhatapDBXAgent

# In case of deleting the service
install_WindowsService.bat delete WhatapDBXAgent

Note

In Control Panel > Windows Tools > Services (services.msc), you can start or stop the WhatapDBXAgent service. Depending on the Windows version, the service path may differ.

You completed installing the agent for database monitoring. In the following, check the post-installation checklist.

Installing the additional agent (XOS) and applying other options

To additionally monitor the resources of the database server, run a separate XOS agent process on the database server to collect data.

Note

• It can be applied to only the OS environment running on the x86 architecture.

• The additional agent installation process is optional.

• For more information about the XOS agent configuration options, see the following.

Configuring the whatap.conf file

Set the following options in the whatap.conf file in the path where the DBX agent has been installed.

whatap.conf

xos=1
xos_port=3002

Move the xos folder (/unzip folder/xos/) to the database server.

Configuring the xos.conf file

Set the following options in the xos.conf file in the xos path moved to the database server.

xos.conf

dbx_ip={DB_Agent_IP}
dbx_port=3002 # default 3002
cpu_limit=0
mem_limit=10240

Tip

In Agent Installation, when you enter the DB data to DB Agent IP and DB Agent Port, the agent options are automatically generated.

Running the XOS agent

1. Grant the role to run the XOS agent.

   chmod +x ./whatap.agent.xos*

2. Run the XOS agent.

   ./start.sh

Note

• To transmit monitored data to the DBX agent, the port set to dbx_port (default 3002) must have been open. (UDP Outbound)

• To run the XOS agent in the background, run the ./startd.sh file.

Next steps

• Checking the installation

  If you have created a project, installed an agent, and applied all agent options, see the checklist in the following.

• Installation troubleshooting

  It provides various problems that may occur when installing the agent and specific instructions for resolving them. For more information, see the following.

• Agent setting

  It provides various features for monitoring by applying some options to the agent configuration file (whatap.conf). For more information, see the following.

  To additionally monitor the database server resources, set more options in the additional agent (XOS). For more information, see the following.

• Starting the monitoring

  After configuring all settings, the agent starts collecting metrics data from the database server. First, check whether the monitoring data has been collected in Instance List. For more information about Instance List, see the following.