Skip to main content

Agent Installation

The following guides you to the basic installation method for using the WhaTap Telegraf agent.

Metrics collected by Telegraf can be forwarded to the WhaTap collection server. The collected data can be checked in the WhaTap's project. This page explains how to install the whatap-telegraf agent to relay the data from Telegraf to the collection server.

Enable the socket_writer output plugin of the installed Telegraf to pass the data to the whatap-telegraf (Local TCP) agent.

To use the WhaTap service, after sign in, you must create a project and install the agent to the target server. For more information about sign in, see the following.

Note

Telegraf agents must be installed and configured directly on the service.

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

Tip

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.

Installation order and file configuration​

  1. Install the WhaTap repository.
  2. Install the whatap-telegraf Linux package (yum, apt-get).
  3. Set the project access key and ** WhaTap server information** settings.
  4. Set the Telegraf's socket_writer output plugin to link the data.
Configuring the Telegraf agent file

  • whatap_telegraf

    By using the service running file, this program sends the data from Telegraf to the collection server.

  • /etc/init.d/whatap-telegraf (FreeBSD /usr/local/etc/whatap_telegraf)

    Service script file.

  • whatap.conf

    It is the configuration file. This is the file where the address of the collection server and the server's project access key are entered.

  • whatap-telegraf-#.log

    Agent log file. (/usr/whatap/telegraf/logs)

Installing the package​

  1. Install the WhaTap repository.

    $ sudo rpm -Uvh https://repo.whatap.io/centos/5/noarch/whatap-repo-1.0-1.noarch.rpm

  2. Install the package with the following command.

    $ sudo yum install whatap-telegraf

  3. Run the configuration script to start the service.

    echo "license=[granted project access key]" |sudo tee /usr/whatap/telegraf/whatap.conf
    echo "whatap.server.host=[WhaTap server address]" |sudo tee -a /usr/whatap/telegraf/whatap.conf
    sudo service whatap-telegraf restart

Telegraf integration​

By setting socket_writer output plugin in Telegraf.conf, the data collected via whatap-telegraf is sent.

TOML
# # Generic socket writer capable of handling multiple socket types.
 [[outputs.socket_writer]]

#   ## URL to connect to
    address = "tcp://127.0.0.1:6600"

#   # data_format = "influx"
    data_format = "json"
  • [[outputs.socket_writer]] Uncomment the line
  • Enter the TCP connection setting in the address field.
  • Set the data type in json format.

You have finished installation of the Telegraf agent. In the following check the installation troubleshooting.

Last updated on