Managed Service for OpenTelemetry:OpenTelemetry を使用して APISIX のトレースデータをレポートする

前提条件

• APISIX 2.13.0 以降を使用していること。

• エンドポイントを取得していること。

  エンドポイントを取得する

  新しいコンソール

  1. Managed Service for OpenTelemetry コンソール にログインします。左側のナビゲーションウィンドウで、[統合センター] をクリックします。

  2. 統合センターページで、[OpenTelemetry] カード（[オープンソースフレームワーク] セクション内）をクリックします。

  3. [OpenTelemetry] パネルで、[統合の開始] タブをクリックし、データのレポート先のリージョンを選択します。

     説明

     初めてリージョンにアクセスすると、リソースが自動的に初期化されます。

  4. [接続タイプ] パラメーターと [エクスポート プロトコル] パラメーターを構成し、エンドポイントをコピーします。

     • 接続タイプ：サービスが Alibaba Cloud にデプロイされており、選択したリージョンに存在する場合は、このパラメーターを [Alibaba Cloud VPC ネットワーク] に設定することをお勧めします。それ以外の場合は、このパラメーターを [パブリックネットワーク] に設定します。

     • エクスポートプロトコル：クライアントでサポートされているプロトコルに基づいて、このパラメーターを HTTP（推奨）または gRPC に設定します。

     

  古いコンソール

  1. Managed Service for OpenTelemetry コンソール にログインします。

  2. 左側のナビゲーションウィンドウで、[クラスタ構成] をクリックします。表示されるページで、[アクセスポイント情報] タブをクリックします。

  3. 上部のナビゲーションバーで、データのレポート先のリージョンを選択します。[クラスタ情報] セクションで、[トークンの表示] をオンにします。

  4. [クライアント] パラメーターを [OpenTelemetry] に設定します。

     表の [関連情報] 列で、エンドポイントをコピーします。

     説明

     アプリケーションが Alibaba Cloud 本番環境にデプロイされている場合は、VPC エンドポイントを使用します。それ以外の場合は、パブリックエンドポイントを使用します。

概要

OpenTelemetry を使用して APISIX のトレースデータをレポートするには、次の手順を実行します。

1. OpenTelemetry Collector をデプロイします。OpenTelemetry Collector は、トレースなどの可観測性データをさまざまなデータソースから受信、処理、エクスポートするオープンソースのコレクターです。

2. APISIX で OpenTelemetry プラグインを有効にします。APISIX の構成ファイルを修正して OpenTelemetry プラグインを有効にすることで、OpenTelemetry Collector が APISIX の可観測性データを収集できるようにすることができます。

3. OpenTelemetry プラグインの有効範囲を指定します。APISIX Admin API を使用して、OpenTelemetry プラグインの有効範囲を指定できます。

4. APISIX トレースを表示します。 Managed Service for OpenTelemetry コンソールで、OpenTelemetry プラグインによって生成された APISIX トレースを表示できます。

プロセス

...
plugins:
  ... # その他の有効なプラグイン
  - opentelemetry # OpenTelemetry プラグインを有効にする

plugin_attr:
  ...
   opentelemetry: # OpenTelemetry プラグインの構成
    resource:
      service.name: ${Service Name} # アプリケーション名
      host.ip: ${Host IP}   # ホスト IP アドレス
    collector:
      address: ${OpenTelemetry Collector Address}:4318 # OpenTelemetry Collector の OpenTelemetry Protocol (OTLP) HTTP レシーバーのエンドポイント
      request_timeout: 3
    batch_span_processor: # バッチでデータを処理するための構成
      drop_on_queue_full: false
      max_queue_size: 6
      batch_timeout: 2
      inactive_timeout: 1
      max_export_batch_size: 2

例

準備

• Git、Docker、Docker Compose をインストールします。

• APISIX 2.13.0 以降を使用していることを確認します。

• HTTP エンドポイントを取得します。

手順

1. APISIX の公式 Web サイトから Docker Compose のデモをダウンロードします。

   git clone https://github.com/apache/apisix-docker.git
   cd apisix-docker/example

2. OpenTelemetry Collector を Docker Compose のデモに追加します。

   1. apisix-docker/example フォルダーに ot_conf という名前のフォルダーを作成し、config.yaml という名前のファイルを作成します。

      説明

      • ${HTTP Endpoint} を、このトピックの「前提条件」セクションで取得した HTTP エンドポイントに置き換えます。例：http://tracing-analysis-dc-hz.aliyuncs.com/adapt_xxxxx/api/otlp/traces。

      receivers:
        otlp:
          protocols:
            grpc:
              endpoint: 0.0.0.0:4317
            http:
              cors:
                allowed_origins:
                - http://*
                - https://*
              endpoint: 0.0.0.0:4318
      processors:
        batch:
      
      exporters:
        otlphttp:
          traces_endpoint: '${HTTP Endpoint}'
          tls:
            insecure: true
      
      service:
        pipelines:
          traces:
            receivers: [otlp]
            processors: [batch]
            exporters: [otlphttp]

   2. apisix-docker/example/docker-compose.yml ファイルを変更して、OpenTelemetry Collector を Docker Compose のデモに追加します。

      次のサンプルコードは、変更後の docker-compose.yml ファイルの内容全体を示しています。

      #
      # Licensed to the Apache Software Foundation (ASF) under one or more
      # contributor license agreements.  See the NOTICE file distributed with
      # this work for additional information regarding copyright ownership.
      # The ASF licenses this file to You under the Apache License, Version 2.0
      # (the "License"); you may not use this file except in compliance with
      # the License.  You may obtain a copy of the License at
      #
      #     http://www.apache.org/licenses/LICENSE-2.0
      #
      # Unless required by applicable law or agreed to in writing, software
      # distributed under the License is distributed on an "AS IS" BASIS,
      # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      # See the License for the specific language governing permissions and
      # limitations under the License.
      #
      
      version: "3"
      
      services:
        apisix:
          image: apache/apisix:${APISIX_IMAGE_TAG:-3.9.0-debian}
          restart: always
          volumes:
            - ./apisix_conf/config.yaml:/usr/local/apisix/conf/config.yaml:ro
          depends_on:
            - etcd
          ##network_mode: host
          ports:
            - "9180:9180/tcp"
            - "9080:9080/tcp"
            - "9091:9091/tcp"
            - "9443:9443/tcp"
            - "9092:9092/tcp"
          networks:
            apisix:
      
        etcd:
          image: bitnami/etcd:3.5.11
          restart: always
          volumes:
            - etcd_data:/bitnami/etcd    environment:
            ETCD_ENABLE_V2: "true"
            ALLOW_NONE_AUTHENTICATION: "yes"
            ETCD_ADVERTISE_CLIENT_URLS: "http://etcd:2379"
            ETCD_LISTEN_CLIENT_URLS: "http://0.0.0.0:2379"
          ports:
            - "2379:2379/tcp"
          networks:
            apisix:
      
        web1:
          image: nginx:1.19.0-alpine
          restart: always
          volumes:
            - ./upstream/web1.conf:/etc/nginx/nginx.conf
          ports:
            - "9081:80/tcp"
          environment:
            - NGINX_PORT=80
          networks:
            apisix:
      
        web2:
          image: nginx:1.19.0-alpine
          restart: always
          volumes:
            - ./upstream/web2.conf:/etc/nginx/nginx.conf
          ports:
            - "9082:80/tcp"
          environment:
            - NGINX_PORT=80
          networks:
            apisix:
      
        prometheus:
          image: prom/prometheus:v2.25.0
          restart: always
          volumes:
            - ./prometheus_conf/prometheus.yml:/etc/prometheus/prometheus.yml
          ports:
            - "9090:9090"
          networks:
            apisix:
      
        grafana:
          image: grafana/grafana:7.3.7
          restart: always
          ports:
            - "3000:3000"
          volumes:
            - "./grafana_conf/provisioning:/etc/grafana/provisioning"
            - "./grafana_conf/dashboards:/var/lib/grafana/dashboards"
            - "./grafana_conf/config/grafana.ini:/etc/grafana/grafana.ini"
          networks:
            apisix:
      
        otel-collector:
          image: otel/opentelemetry-collector-contrib:0.105.0
          volumes:
            - ./ot_conf/config.yaml:/etc/otelcol-contrib/config.yaml # OpenTelemetry Collector の構成ファイルをマウントする
          ports:
            - 4317:4317 # OTLP gRPC レシーバー
            - 4318:4318 # OTLP HTTP レシーバー
          networks:
            apisix:
      
      networks:
        apisix:
          driver: bridge
      
      volumes:
        etcd_data:
          driver: local

3. APISIX で OpenTelemetry プラグインを有効にします。

   ファイルの末尾に次の内容を追加して、APISIX の apisix-docker/example/apisix_conf/config.yaml 構成ファイルを変更します。

   plugins:
     - opentelemetry
   
   plugin_attr:
     prometheus:
       export_addr:
         ip: "0.0.0.0"
         port: 9091
     opentelemetry:
       resource:
         service.name: APISIX
         host.ip: 127.0.0.1
       collector:
         address: docker-apisix-otel-collector-1:4318 # OTLP HTTP Receiver アドレス
         request_timeout: 3
       batch_span_processor:
         drop_on_queue_full: false
         max_queue_size: 6
         batch_timeout: 2
         inactive_timeout: 1
         max_export_batch_size: 2

4. APISIX Docker Compose のデモを起動します。

   apisix-docker/example ディレクトリで次のコマンドを実行します。

   docker compose -p docker-apisix up -d

5. OpenTelemetry プラグインをグローバルに有効にするように構成します。

   APISIX Admin API を使用して、OpenTelemetry プラグインをグローバルに有効にするように構成します。

   curl 'http://127.0.0.1:9180/apisix/admin/global_rules/1' \
   -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' \
   -X PUT -d '{
       "plugins": {
           "opentelemetry": {
               "sampler": {
                   "name": "always_on"
               }
           }
       }
   }'
   

6. APISIX ルートを作成し、トレースデータのレポートテストを実行します。

   1. APISIX Admin API を使用してルートを作成します。

      curl "http://127.0.0.1:9180/apisix/admin/routes/1" -H "X-API-KEY: edd1c9f034335f136f87ad84b625c8f1" -X PUT -d '
      {
        "methods": ["GET"],
        "host": "example.com",
        "uri": "/anything/*",
        "upstream": {
          "type": "roundrobin",
          "nodes": {
            "httpbin.org:80": 1
          }
        }
      }'

   2. 次の curl コマンドを実行します。APISIX OpenTelemetry プラグインは、このリクエストのトレースを生成し、Managed Service for OpenTelemetry にトレースデータをレポートします。

      curl -i -X GET "http://127.0.0.1:9080/anything/foo?arg=10" -H "Host: example.com"

      期待される出力：

      # curl -i -X GET "http://127.0.0.1:9080/anything/foo?arg=10" -H "Host: example.com"
      HTTP/1.1 200 OK
      Content-Type: application/json
      Content-Length: 501
      Connection: keep-alive
      Date: Wed, 24 Jul 2024 03:26:11 GMT
      Access-Control-Allow-Origin: *
      Access-Control-Allow-Credentials: true
      Server: APISIX/3.9.0
      
      {
        "args": {
          "arg": "10"
        }, 
        "data": "", 
        "files": {}, 
        "form": {}, 
        "headers": {
          "Accept": "*/*", 
          "Host": "example.com", 
          "Traceparent": "00-xxxxxx-xxxx-01", 
          "User-Agent": "curl/7.61.1", 
          "X-Amzn-Trace-Id": "Root=1-xxx-xxxx", 
          "X-Forwarded-Host": "example.com"
        }, 
        "json": null, 
        "method": "GET", 
        "origin": "x.x.x.x, x.x.x.x", 
        "url": "http://example.com/anything/foo?arg=10"
      }

7. Managed Service for OpenTelemetry コンソール にログインし、OpenTelemetry によって生成された APISIX トレースを表示します。

   1. [アプリケーション] ページで、APISIX アプリケーションの名前をクリックします。

   2. [トレースの詳細] タブで、APISIX トレース情報を表示します。

参考資料

APISIX は、Apache APISIX コミュニティによってメンテナンスされているクラウドネイティブ API ゲートウェイです。APISIX は、動的構成、リアルタイム応答、高パフォーマンスをサポートし、負荷分散やカナリアリリースなどのさまざまなトラフィック管理機能を提供します。詳細については、Apache APISIX 公式 Web サイトをご覧ください。