Managed Service for OpenTelemetry:APISIX のトレースデータを OpenTelemetry 向けマネージドサービスにレポートする

新規コンソール

1. OpenTelemetry 向けマネージドサービスコンソール にログインします。左側のナビゲーションウィンドウで、インテグレーションセンター をクリックします。

2. インテグレーションセンターのページで、OpenTelemetry カードを オープンソースフレームワーク セクション内からクリックします。

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

   リージョンへの初回アクセス時に、リソースが自動的に初期化されます。

4. 接続タイプ および エクスポートプロトコル のパラメーターを設定し、エンドポイントをコピーします。

   パラメーター	推奨値	使用タイミング
   接続タイプ	Alibaba Cloud VPC ネットワーク	ご利用のサービスが Alibaba Cloud 上の同一リージョンで実行されている場合
   接続タイプ	パブリックネットワーク	ご利用のサービスが Alibaba Cloud 外または異なるリージョンで実行されている場合
   エクスポートプロトコル	HTTP（推奨）	ほとんどのクライアントでデフォルト
   エクスポートプロトコル	gRPC	クライアントが gRPC を必要とする場合

   

旧コンソール

1. OpenTelemetry 向けマネージドサービスコンソール にログインします。

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

3. 上部のナビゲーションバーでリージョンを選択します。クラスタ情報 セクションで、トークンを表示 を有効化します。

4. クライアント パラメーターを OpenTelemetry に設定します。関連情報 列からエンドポイントをコピーします。

   アプリケーションが Alibaba Cloud の本番環境で実行される場合は、Virtual Private Cloud (VPC) エンドポイントを使用してください。それ以外の場合は、パブリックエンドポイントを使用します。

   

グローバル適用

すべてのルートに対してプラグインを有効化します：

sampler パラメーターを always_on に設定すると、すべてのリクエストがトレースされ、トレースが生成されます。

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

特定ルートへの適用

/get に一致するリクエストのみでプラグインを有効化します：

curl http://127.0.0.1:9080/apisix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' \
-X PUT -d '
{
  "uri": "/get",
  "plugins": {
      "opentelemetry": {
          "sampler": {
              "name": "always_on"
          }
      }
  },
  "upstream": {
      "type": "roundrobin",
      "nodes": {
          "httpbin.org:80": 1
      }
  }
}'

OpenTelemetry の属性の構成方法の詳細については、「opentelemetry」トピックの「属性」セクションをご参照ください。

前提条件

開始する前に、以下の条件を満たしていることを確認してください。

• Git、Docker、および Docker Compose がインストール済みであること

• APISIX 2.13.0 以降であること

• OpenTelemetry 向けマネージドサービスから取得した HTTP エンドポイントがあること

手順

1. APISIX Docker デモをクローンします。

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

2. OpenTelemetry Collector の構成を追加します。apisix-docker/example ディレクトリ内に ot_conf というフォルダを作成し、その中に config.yaml というファイルを作成します。

   ${HTTP Endpoint} を、「エンドポイントの取得」で取得したエンドポイントに置き換えてください。例：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]

3. Docker Compose に Collector サービスを追加します。apisix-docker/example/docker-compose.yml ファイルを編集し、以下のサービス定義を追加します：

      otel-collector:
        image: otel/opentelemetry-collector-contrib:0.105.0
        volumes:
          - ./ot_conf/config.yaml:/etc/otelcol-contrib/config.yaml
        ports:
          - 4317:4317 # OTLP gRPC 受信エンドポイント
          - 4318:4318 # OTLP HTTP 受信エンドポイント
        networks:
          apisix:

      #
      # 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
          ports:
            - 4317:4317 # OTLP gRPC 受信エンドポイント
            - 4318:4318 # OTLP HTTP 受信エンドポイント
          networks:
            apisix:
   
      networks:
        apisix:
          driver: bridge
   
      volumes:
        etcd_data:
          driver: local

4. APISIX で OpenTelemetry プラグインを有効化します。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 受信アドレス
            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

5. すべてのサービスを起動します。apisix-docker/example ディレクトリから、以下のコマンドを実行します：

      docker compose -p docker-apisix up -d

6. プラグインをグローバルに有効化します。

      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"
                  }
              }
          }
      }'

7. テスト用ルートを作成し、リクエストを送信します。

   1. ルートを作成します。

      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. リクエストを送信します。プラグインがトレースを生成し、OpenTelemetry 向けマネージドサービスにレポートします。

      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"
      }

      応答内の Traceparent ヘッダーにより、トレースコンテキストの伝搬が有効であることが確認できます。

8. コンソールでトレースを確認します。

   1. OpenTelemetry 向けマネージドサービスコンソール にログインします。アプリケーション ページで、APISIX アプリケーションの名前をクリックします。

   2. トレースの詳細 タブで、トレース情報を確認します。