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.

Log in WhaTap monitoring service.
To create a project, on the left of the screen, select All Projects > + Project.
Select a product in Select product for installation.
Configure the settings for Project name, Data server region, and Time zone.
In Notification language setting, select the language for alert messages.
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 configuration diagram

The DBX agent can be installed on a separate server or on the DB server. Select a method how to install the agent and check its configuration and firewall.

Install on a separate server	Install on the DB server

Account creation

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

Note

If you have an account with roles, skip this step and then proceed to Next Step.
In the example code, DB_User is the DB user account name. Change it to your account name.

Enter your password in DB_Password in the example code.

Assign additional roles depending on the features and operation environment.

PostgreSQL 10 or later

SQL
create user DB_User with password 'DB Password'; 
grant pg_monitor to DB_User;

Below PostgreSQL 10

SQL
create user DB_User with password 'DB Password';
alter user DB_User with superuser;

In case of using the kill session

Database monitoring provides the Kill Session function that allows you to kill an active session. To use this function, set the role as follows:
SQL
```
grant pg_signal_backend to DB_User;
```

In case of collecting the table size

SQL
grant usage on schema {schema_name} to DB_User;

In case of collecting the object information (Analysis > Top Object)

SQL
grant select on all tables in schema {schema_name} to DB_User;

Support features for each role

The roles other than the Default role do not need to be assigned depending on the environment. However, some functions may not work.

Role	command	Menu and feature	Details
Default role	`grant pg_monitor to whatap;`	Monitoring a Database Instance / Monitoring Multiple Instances / SQL Statistics	It is the same as `grant pg_read_all_stats,pg_read_all_settings to DB_User;`.
Role details	`grant usage on schema {schema_name} to whatap;`	DB size / Table size (TOP 50)	The roles for all schemas in the DB are required.
	`grant select on all tables in schema {schema_name} to whatap;`	Table layout query	-
	`grant pg_read_all_settings to whatap;`	Parameter query	Specific parameter values may be invisible.
Session kill	`grant pg_signal_backend to whatap;`	Active sessions > Session kill	PostgreSQL 9.6 or earlier requires the superuser privilege.

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.

Note

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.

Downloading the DBX agent

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

You can download it by using the 'wget' command.

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

If you cannot download it with the command, select Download on the WhaTap monitoring service screen.

Download the DBX agent file and then unzip it.

BASH
tar -zxvf whatap.agent.database.tar.gz

Note

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

DBX Agent Setting

Follow the instructions on the agent installation screen to configure the agent. By entering the required items on the screen, the configuration and commands can be auto-completed.

Tip

You can quickly and easily configure the agent by running the setup.sh file among the DBX agent configuration files. For more information, see the following.

whatap.conf configuration

Go to 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={AccessKey}
whatap.server.host=13.124.11.223/13.209.172.35 # WhaTap server information
dbms=postgresql
db=postgres
db_ip={DB_Server_IP}
db_port={DB_Server_Port} 

Downloading JDBC

Download the JDBC driver that matches the operating system and version of the database server to the DBX agent path where you unzipped the file. /unzipped folder/jdbc

Info

PostgreSQL 9.2 or later: https://jdbc.postgresql.org/download

Note

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

DB user file creation

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

Linux
Windows

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

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
Windows

./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

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.

XOS
RDS : AWS CloudWatch

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.
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.
Grant the role to run the XOS agent.
```
chmod +x ./whatap.agent.xos*
```
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.

Set the following options in the whatap.conf file on the agent server. Due to the nature of CloudWatch, it is recommended to call every 60 seconds (cloud_watch_interval).

whatap.conf
aws_region={AWS_RDS_Region_Name}
aws_arn=arn:aws:iam::999999999999:role/UpdateApp
cloud_watch=on
cloud_watch_instance=RDS_DB_Instance_Name
cloud_watch_interval=60
cloud_watch_metrics=CPUUtilization,FreeableMemory,FreeStorageSpace,NetworkTransmitThroughput,NetworkReceiveThroughput

Execute the following command to view the AWS CloudWatch metrics. Change the DB_Instance_Name and then execute the following command.

aws cloudwatch list-metrics --namespace AWS/RDS --dimensions Name=DBInstanceIdentifier,Value={DB_Instance_Name}

Note

In Agent Installation, enter values for AWS RDS Region, RDS DB Instance Name, and DB Instance Name. Then the agent options and commands are automatically generated.

For more information about the aws_arn option for AWS authentication, see the following.

For more information about the AWS CLI installation and update, see the following link.
For more information about the AWS CLI configuration, see the following link.

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.

Creating a project​

Checking the configuration diagram​

Account creation​

Checking the access key​

Downloading the DBX agent​

DBX Agent Setting​

whatap.conf configuration​

Downloading JDBC​

DB user file creation​

Starting the monitoring​

Installing the additional agent (XOS) and applying other options​

Next steps​

Creating a project

Checking the configuration diagram

Account creation

Checking the access key

Downloading the DBX agent

DBX Agent Setting

whatap.conf configuration

Downloading JDBC

DB user file creation

Starting the monitoring

Installing the additional agent (XOS) and applying other options

Next steps