OpenTelemetry Collector を導入する

VaxilaはOpenTelemetryの仕組み (計装)を利用してデータを送信しています。

このページでは OpenTelemetry Collectorを使用してデータをVaxilaに送信する方法を解説します。

OpenTelemetry Collectorとは

OpenTelemetry Collector は特定ベンダーに依存しない、OpenTelemetry用エージェントです。

Dockerを使用してサイドカーにすることも、APKやDEBを通してインストールすることもできます。

このページではOpenTelemetry Collectorのインストール方法について説明します。

細かい実装については公式のドキュメントを参照してください。

CollectorOpenTelemetry

Collectorを使用するべきか

Vaxilaを使用する場合、Collectorを使わずに、SDKから直接Vaxilaにデータを送信することもできます。

どちらにするかどうかを決める際は以下のページを参考にしてください。

Collectorを使うかどうかの判断について

導入方法

OpenTelemetry Collectorを使用するためにはインストールと設定が必要です。

インストール

OpenTelemetry Collectorは

• Docker

• Kubernetes

• Linux パッケージ

などで配布されています。

例えば、apkを使用する場合以下のコマンドでインストールできます。

wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/${VERSION}/otelcol_${VERSION}_linux_amd64.deb
sudo dpkg -i otelcol_${VERSION}_linux_amd64.deb

各プラットフォームに対応したコマンドは以下にまとめられています

Getting StartedOpenTelemetry

設定

OpenTelemetry Collector はファイルと環境変数で設定することができます。

例えば、systemdを使用している場合は /etc/otelcol/config.yaml を以下のように設定すると、Vaxilaに送信することができます。

receivers:
  otlp:
    protocols:
      grpc:
      http:

processors:
  memory_limiter:
    check_interval: 1s
    limit_mib: 500
    spike_limit_mib: 100
  batch:
    # Vaxilaでは6MB以上のリクエストを受け付けません。
    # そのため、リクエストあたりの最大スパン数を適当に設定します。
    send_batch_size: 5000
    send_batch_max_size: 5000

exporters:
  otlphttp/vaxila:
    endpoint: "https://telemetry.vaxila-labs.com"
    headers:
      Accept: "*/*"
      "X-Vaxila-Token": ${env:VAXILA_TOKEN}

extensions:
  health_check:

service:
  extensions: [health_check]
  pipelines:
    traces:
      receivers: [otlp]
      processors: [batch]
      exporters: [otlphttp/vaxila]

この例では、次の項目を設定しています。

• exporters

  • exportersに otlphttp を使用します。

  • endpointをVaxilaのエンドポイント (https://telemetry.vaxila-labs.com ) にします。

  • headersには X-Vaxila-Token と Accept を設定します。

    • X-Vaxila-Token: vaxilaが発行したトークンを設定します。

    • Accept: 常に */* を設定します。 (Vaxilaが内部でAWS Lambdaを使用しているために必要な設定です。)

• service

  • pipelines の traces に作成したexporterを設定します。

これらを設定することで、CollectorからVaxilaへデータを送信するようになります。