Skip to main content

Agent Installation

This document has been created based on the MySQL Monitoring V2. For the MySQL monitoring V1 document, see the following.

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

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

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://api.whatap.io/download/agent/whata.agent.database.tar.gz
  2. Copy the downloaded file to the server to be analyzed, and then unzip it. (Same for Windows and Linux)

    Agent configuration file
    File nameDescription
    whatap.confThis 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.confThis 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.shThis script fetches the process ID. When ending the agent process, the ID is referenced.
    stop.shThis 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.jarThe Tracer program is a program that collects data from the database server and transmits the collected data to the server.
    jdbcThis 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.confThis 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.confThis file is used to enter the CUBRID database and additional agent connection settings.
    *: The files in the xcub path are dedicated files for CUBRID Monitoring.
  1. 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=Project access key
    whatap.server.host=13.124.11.223/13.209.172.35 # WhaTap server Info

    dbms=mysql
    db_ip={DB server IP}
    db_port={DB server port number}

    In case the MySQL server and agents are installed in localhost (default 3306 port)

    whatap.conf
    dbms=mysql
    db_ip=127.0.0.1
    db_port=3306
  2. Download the JDBC driver to the following directory. /unzipped folder/jdbc

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

    Mysql & MariaDB 5.5 or later

  • When using the JDBC driver version 8.x or later, if the serverTimezone setting is required in the URL to connect, set the options as follows.

    whatap.conf
    connect_option=?serverTimezone={SERVER_TIMEZONE}
    # ex) connect_option=?serverTimezone=UTC
  • To use SSL, set the options as follows.

    whatap.conf
    connect_option=?useSSL=true&verifyServerCertificate=false
  • 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.

Creating the monitoring account

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

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

create user whatap identified by 'DB_PASSWORD'; # Enter a desired password.
grant process on *.* to whatap;
grant select on performance_schema.* to whatap;
grant show databases on *.* to whatap;

# In case of collecting the table data
grant select on *.* to whatap;
# In case of monitoring tables only in a specific DB
# grant select on {DB_NAME}.* to whatap;

# In case of using replication
grant replication client on *.* to whatap;
grant replication slave on *.* to whatap;

# In case of using the kill session
grant super on *.* to whatap;
grant execute on procedure mysql.rds_kill to whatap; # In case of using AWS RDS

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 {props.name} if there is only a password without user.

./uid.sh DB_USER DB_PASSWORD
  • 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 project 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

Running the agent

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.