Package Manager Installation

This guide provides instructions for installing the WhaTap database monitoring agent using a package manager.

Tip

Choosing an Installation Method

• Refer to this document for Debian/Ubuntu-based systems that use the apt package manager.
• For Docker environments, refer to Docker Installation.
• For other environments, refer to Manual Installation.

Note

Supported Databases

MySQL, PostgreSQL, SQL Server

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.

1. Log in to the WhaTap Monitoring Service.

2. In the left side menu, click All Projects > + Project.

3. On the Select product screen, select the product you want to install.

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

5. After completing all settings, click the Creating a project button.

Note

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 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 already have an account with the required permissions, skip this step and proceed to the next step.

• In the example code, DB_User is the database user account name. Change it to the user account name you are using.

• Enter your user 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 (version 10 or later)

  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 (Stat/Report > DB size > Table size (TOP 50))

  SQL

  grant usage on schema {schema_name} to DB_User;

  Note

  Execute the command for each individual DB.

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

Installing the Agent

Adding the WhaTap Repository

Run the following commands to add the official WhaTap repository to your system.

curl -s https://repo.whatap.io/debian/release.gpg | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/whatap-release.gpg > /dev/null
echo "deb [signed-by=/etc/apt/trusted.gpg.d/whatap-release.gpg] https://repo.whatap.io/debian unstable/" | sudo tee /etc/apt/sources.list.d/whatap.list
sudo apt-get update

Installing the Package

Install the WhaTap database monitoring agent with the following command.

sudo apt-get install whatap-db

Configuring and Starting the Agent

Create the configuration file and start the agent.

sudo bash -c 'cat > /usr/whatap/db/whatap.conf <<EOF
license=license_key
whatap.server.host=13.124.11.223/13.209.172.35
dbms=mysql
db_ip=127.0.0.1
db_port=3306
EOF'
cd /usr/whatap/db && sudo /usr/whatap/db/uid.sh whatap whatap && cd -
sudo service whatap-db restart

Note

• You can add additional database options to the whatap.conf file.
• Modify the parameter values (database account ID and password) of the uid.sh script to match your actual environment.

Managing the Agent

Updating the Agent

To update the agent to the latest version, run the following commands.

sudo apt-get update
sudo apt-get install whatap-db
sudo service whatap-db restart

Stopping the Agent and Removing the Package

To remove the WhaTap database monitoring agent, run the following commands.

sudo service whatap-db stop
sudo apt-get remove whatap-db

Checking Agent Logs

To check the agent logs, use the following command.

sudo service whatap-db log