Skip to main content

Agent Installation

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

After getting the access key, select your OS running. In the Download agent section, copy the command for the OS to install the agent.

The PHP agent installation method is Linux package installation. You can install it in the following order.

  1. Register the WhaTap repository.

  2. Install the whatap-php Linux package (yum, apt-get).

  3. Run the configuration script. Through the configuration script, the tracer is registered as PHP extension module, and the agent runs by the whatap-php service.

    php

  4. Restart Apache or PHP-FPM.

Note

For more information about the agent file structure, see the PHP agent file structure.

PHP agent file configuration

The PHP agent file consists of the tracer that extracts data for application monitoring and transfers the data to the WhaTap collection server, the agent that transfers the collected data to the server, and the installation script file that dynamically applies both tracer and agent.

  • whatap_X.Y.Z.so

    This library is added as a PHP extension module that has been registered as a tracer to collect data and send the collected data to the agent. The extension modules are classified for each PHP API version and Zend Thread Safe support. Examples are as follows:

    • whatap_zts_20041225.so

      PHP 5.2, Zend Thread safe enable

    • whatap_20041225.so

      PHP 5.2, Non Thread Safe

  • whatap-php(whatap_php)

    This program transfers the data delivered from the agent or tracer to UDP, to the collection server.

  • /etc/init.d/whatap-php

    Service script file.

  • whatap_php

    Service execution file.

  • whatap.ini

    In this file, the settings of the PHP extension module that collects data of the application server, the collection server address, and the project access key of the server are entered.

  • template.ini

    The template file is copied when creating whatap.ini.

  • whatap-install-yyyymmdd.log

    Log file generated during installation. The default storage path is /usr/whata/php/logs. The files are created by date. Only the logs for 7 days are kept by default.

  • whatap-boot-yyyymmdd.log

    Agent log file. The default storage path is /usr/whata/php/logs. The files are created by date. Only the logs for 7 days are kept by default.

  • install.sh

    Installation script. Proceed with the whatap-php service installation by installing the PHP extension module (whatap.so) to Apache or PHP-FPM. For more information, see the following.

  • WhaTap.php (sample.php)

    API reference class (/usr/whatap/php/lib/WhaTap.php) to be used in the PHP source code, and the example source file (sample.php)

The method how to set depending on the application server environment is provided as follows. Before installing and applying the agent, check Support environment first.