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.

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.

    Create Project

  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 configuration diagram​

It is the configuration to install the agent on the database server for Oracle Pro monitoring.

Firewall settings are required and all data is transmitted encrypted. The port 6600 is used for communication with the WhaTap collection 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.

  • In general cases

    SQL
    create user whatap identified by DB_Password;
    grant create session to whatap;
    grant select any dictionary to whatap;

  • Multi-tenant in 12c or later: Add the prefix c##.

    SQL
    create user c##whatap identified by DB_Password;
    grant reate session to c##whatap;
    grant select any dictionary to c##whatap;
    alter user c##whatap set container_data = ALL container = CURRENT;

  • In case of using the kill session

    SQL
    grant alter system 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.

Download agent​

On the agent Installation screen, select the Oracle version that matches your environment and then select Download.

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.

Agent CONFIG.​

The agent is recommended to be installed with an Oracle account and the Oracle connection environment variables must have been set. Proceed with the agent configuration in the following order.

Note

In case of installation from the user account other than the Oracle account

  • You need the role (read) to read the shared memory created by Oracle.

  • If the perms value is 640 in the output of the ipcs -m command, the agent can be installed by another account in the same group.

  • If the perms value is ** 600 ** and ** in the result of the ipcs -m command for Oracle 12c r2 or later, you can set the parameter to change the perms value to ** 640 ** as follows. To apply the changes, restart the DB.

    alter system set allow_group_access_to_sga=true scope=spfile;

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

whatap.conf
license={AccessKey}
whatap.server.host=13.124.11.223/13.209.172.35 # WhaTap server information
ipckey={ipckey}
Tip

  • The ipckey option value can be acquired via the ipcs -m command. This is the key value (hexadecimal) of the Oracle to be monitored.

  • If you have installed multiple databases on a server, see the following to enter the ipckey.

Creating the initial configuration file​

To create an initial configuration file, connect to the database with the SYS account (or an equivalent account) to receive and process information. The account and password are not saved.

BASH
./dmxinit.sh {sys_user} {sys_password}

After execj\uting the command, the following five files are created:

dmx.init, class.init, dbname.init, stat.init, event.init

Note

  • If you can connect without sys_user and sys_password (as connecting with sqlplus '/as sysdba'), you do not need to add sys_user and sys_password as arguments.

    BASH
    ./dmxinit.sh

  • If the sys_user and sys_password strings contain special characters, add the escape character (\) before each special character.

    BASH
    ./dmxinit.sh whatap whatap\!\@pwd

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

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

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.

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