Skip to main content

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. Set items for Project name, Data server region, Time zone, and more in order.

  5. 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 serverInstall 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

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

Assign additional roles depending on the features and operation environment.

  • PostgreSQL 10 or later

    SQL
    create user whatap with password 'DB Password'; 
    grant pg_read_all_stats to whatap;

  • Below PostgreSQL 10

    SQL
    create user whatap with password 'DB Password';
    alter user whatap 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
    alter user whatap with superuser;

  • In case of using the kill session in the AWS RDS environment

    SQL
    grant rds_superuser to whatap;

  • In case of collecting wal_count

    SQL
    grant execute on function pg_ls_dir(text) to whatap;  # In case of use of EDB
    alter user whatap with superuser;

  • In case of collecting the cache

    SQL
    grant select on pg_backend_memory_contexts to whatap;
    grant execute on function pg_get_backend_memory_contexts to whatap;

  • In case of collecting the table size

    SQL
    grant usage on schema {schema_name} to whatap;

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

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

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://dev.whatap.io/download/agent/whata.agent.database.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

DBX Agent Setting​

Follow the instructions on the agent installation screen to configure the agent. By entering the required information for each item on the screen, the settings and commands can be automatically generated.

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 (/unzipped folder/jdbc) where you unzipped the file.

Info

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

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.

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

The

uid.sh shell scrip file (or uid.bat batch file) can be found in the path where the WhaTap database agent has been installed. Set DB_USER to default if there is only a password without user.

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

Starting the monitoring​

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

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

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.

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

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

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

  4. Grant the role to run the XOS agent.

    chmod +x ./whatap.agent.xos*

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