本文へスキップ

エージェントのインストール

注意

OpenTelemetryのモニタリングはベータ版で、予期しないエラーが発生する可能性があります。 重要なデータがある環境や運用環境では使用することをお勧めしません。 フィードバックや問題点が発生したら、サポートチーム(support@whatap.io)までお問い合わせください。

OpenTelemetryエージェントのインストール方法を案内します。

エージェントダウンロード​

次のコマンドを実行してOpenTelemetry Collectorがインストールされているインスタンスにエージェントをダウンロードします。

# 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

エージェントのデフォルト設定​

エージェント設定には、WhaTapプロジェクトのアクセスキーと収集サーバーのIPアドレスが必要です。 WhaTapモニタリングサービスでアプリケーション(Application)商品のプロジェクトに移動します。 管理 > エージェントインストール メニューでアクセス キーと収集サーバーのIPアドレスを確認して準備します。

whatap.confファイルを設定する​

エージェント設定(whatap.conf)ファイルへのアクセスキーと収集サーバーのIPアドレスを設定します。

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

環境変数で設定する​

環境変数(Environment)でアクセスキーと 収集サーバーのIP アドレスを設定できます。

WHATAP_ACCESSKEY={ACCESS_KEY}
WHATAP_SERVER_HOST={COLLECTOR_SERVER_IP_ADDRESS}
WHATAP_OTEL_GRPC_SERVER_PORT={gRPC_SERVER_LISTENING_PORT}
ノート

環境変数とwhatap.confファイルをすべて設定した場合、whatap.confファイルの設定値が優先されます。

Opentelemetry Collectorの設定​

whatap-otelでデータを伝達するようにOTLP Exporterを設定します。

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

  • エンドポイント(endpoint)設定：127.0.0.1:6600

    ローカルにインストールしたエージェントが使用するデフォルトのポートは 6600です。

  • tls.secure設定：insecure: true

  • gzip圧縮設定をデフォルトで使用します。 (gzip使用)

情報

OpenTelemetry Collectorインストールの詳細については、次のリンクを参考にしてください。

その他のプラットフォーム​

Tyk Gateway​

Tyk GatewayのOpenTelemetry機能を活性化した上でOpenTelemetry Collecotrを通じてトランザクション情報を確認することができます。

  1. OpenTelemetry CollectorをTyk Gatewayに接続します。
tyk.conf
{
  "log_level": "debug" ,
  "listen_port": 8081,

  ...

  "opentelemetry": {
      "enabled": true,
      "endpoint": "111.222.333.444:4317",
  }
}
  1. 接続されたOpenTelemetry Collectorにwhatap-otelエージェントが接続されたら、トレース情報を収集します。

モニタリングの開始​

  • すべての設定を完了した後、アプリケーションサーバーを再起動すると、エージェントが情報を収集します。 ダッシュボード > アプリケーションダッシュボードメニューに移動して、収集されたデータをリアルタイムでモニタリングしてください。

  • エージェント設定の詳細については、次の文書を確認してください。