Agent Installation

Caution

OpenTelemetry monitoring is a Beta version so unexpected errors may occur. It is not recommended for using it for sensitive data or in the operation environment. If you have any feedback or issues, feel free to contact the support team at support@whatap.io.

It guides you how to install the OpenTelemetry agent.

Download agent

Execute the following command to download the agent to the instance where the OpenTelemetry Collector has been installed.

Red Hat/Centos

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

# Install package
$ sudo yum install whatap-otel

Debian/Ubuntu

# Register package repository
$ wget https://repo.whatap.io/debian/release.gpg -O -|sudo apt-key add -
$ wget https://repo.whatap.io/debian/whatap-repo_1.0_all.deb
$ sudo dpkg -i whatap-repo_1.0_all.deb
$ sudo apt-get update

# Install package
$ sudo apt-get install whatap-otel

Amazon Linux

# Register package repository
$ sudo rpm --import https://repo.whatap.io/centos/release.gpg
$ echo "[whatap]" | sudo tee /etc/yum.repos.d/whatap.repo > /dev/null
$ echo "name=whatap packages for enterprise linux" | sudo tee -a /etc/yum.repos.d/whatap.repo > /dev/null
$ echo "baseurl=https://repo.whatap.io/centos/latest/\$basearch" | sudo tee -a /etc/yum.repos.d/whatap.repo > /dev/null
$ echo "enabled=1" | sudo tee -a /etc/yum.repos.d/whatap.repo > /dev/null
$ echo "gpgcheck=0" | sudo tee -a /etc/yum.repos.d/whatap.repo > /dev/null

# Install package
$ sudo yum install whatap-otel

Alpine Linux

$ wget https://s3.ap-northeast-2.amazonaws.com/repo.whatap.io/alpine/x86_64/whatap-otel.tar.gz
$ tar -xvzf whatap-otel.tar.gz -C /

Alpine Linux Docker

FROM alpine

FROM alpine

RUN apk update && apk upgrade
# Install WhaTap Go monitoring agent
RUN wget https://s3.ap-northeast-2.amazonaws.com/repo.whatap.io/alpine/x86_64/whatap-otel.tar.gz
RUN tar -xvzf whatap-otel.tar.gz -C /

Default agent settings

To configure the agent, the WhaTap project's access key and collection server IP address are required. In WhaTap monitoring service, move to the project for the application product. In Management > Agent Installation, check the access key and collection server IP address for preparation.

Configuring the whatap.conf file

Set the access key and collection server IP address in the agent configuration (whatap.conf) file.

echo "accesskey={ACCESS_KEY}" >> /usr/whatap/otel/whatap.conf 
echo "whatap.server.host={COLLECTOR_SERVER_IP_ADDRESS}" >> /usr/whatap/otel/whatap.conf 

Configuring with environment variables

You can set the access key and collection server IP address as environment variables.

WHATAP_ACCESSKEY={ACCESS_KEY}
WHATAP_SERVER_HOST={COLLECTOR_SERVER_IP_ADDRESS}
WHATAP_OTEL_GRPC_SERVER_PORT={gRPC_SERVER_LISTENING_PORT}

Note

If both environment variables and the whatap.conf file have been configured, the settings in the whatap.conf file take precedence.

Configuring the Opentelemetry Collector

Configure the OTLP Exporter to forward data to whatap-otel.

otel-collector-config.yaml

receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317
processors:
  batch:

exporters:
  logging:
  # otlp exporter에 whatap-otel을 대상으로 설정합니다.
  otlp:
    endpoint: 127.0.0.1:6600
    tls:
      insecure: true

service:
  pipelines:
    traces:
      receivers:
      - otlp
      processors:
      - batch
      exporters:
      - logging
      - otlp
  telemetry:
    logs:
      level: debug #activate debug mode

• End point (endpoint) setting: 127.0.0.1:6600

  The default port for local agents is 6600.

• tls.secure setting: insecure: true

• The gzip compression settings are used by default. (gzip is used)

Info

For more information about the OpenTelemetry Collector installation, see the following link.

• Install the Collector

• Building a custom collector

Other platforms

Tyk Gateway

Enable the OpenTelemetry function of Tyk Gateway and then check the transaction information through the OpenTelemetry Collecotr.

1. Connect the OpenTelemetry Collector to the Tyk Gateway.

tyk.conf

{
  "log_level": "debug" ,
  "listen_port": 8081,

  ...

  "opentelemetry": {
      "enabled": true,
      "endpoint": "111.222.333.444:4317",
  }
}

1. When the whatap-otel agent is connected to the OpenTelemetry Collector, trace data is collected.

Starting the monitoring

• If the application server is restarted after all settings are made, the agent collects data. Go to the Dashboard > Application dashboard menu and then perform monitoring for the collected data in real time.

• For more information about the agent configuration, see the following.