すべてのプロダクト
Search

このプロダクト

    API Gateway:トレース分析の設定

    ドキュメントセンター

    API Gateway:トレース分析の設定

    最終更新日:Jul 31, 2024

    このトピックでは、API Gatewayコンソールでトレース分析を設定して、トレースログをAlibaba Cloud Managed Service for OpenTelemetryにアップロードする方法について説明します。 Managed Service for OpenTelemetryには、サービス呼び出しの完全なトレースのマッピング、リクエスト数の計算、トレーストポロジの取得、アプリケーションの依存関係の分析に使用できる一連のツールが用意されています。 このツールは、サービスの効率的な開発と問題のトラブルシューティングに役立ちます。 トレース分析機能は、専用インスタンスでのみ使用できます。

    前提条件

    1. OpenTelemetryのマネージドサービスに権限を付与する

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

    1.2 [概要] ページで、[今すぐ権限を付与] をクリックして、OpenTelemetryのManaged ServiceがSimple Log Serviceデータの読み取りと書き込みを許可します。

    1.3 [Cloud Resource Access Authorization] ページで、必要な権限を選択し、[Confirm Authorization Policy] をクリックします。

    1.4 権限が付与されたら、次の操作を実行してエンドポイントを表示します。[概要] ページで、[アクセスプロセス] タブをクリックします。 このタブで、[アクセスポイント情報の表示] をクリックします。 [トークンの表示] をオンにし、[クライアント] パラメーターに [Jaeger] を選択します。 [Reporting through HTTP] セクションに表示されるエンドポイントを保存します。

    2. API Gatewayコンソールでのトレース分析の設定

    2.1 API Gatewayコンソールにログインします。

    2.2 左側のナビゲーションウィンドウで、[APIの管理] > [APIグループ] を選択します。 管理するAPIグループの名前をクリックして、[グループの詳細] ページに移動します。 [カスタムログトレース] セクションで、関連するパラメーターを設定します。

    • トレースフィールドの位置: トレースされたフィールドの位置を指定します。 有効な値: ヘッダーとクエリ。

    • トレースフィールド名: トレースされたフィールドの名前を指定します。

      • トレースされたフィールドは、クライアントによって生成される。 API Gatewayは、トレースされたフィールドをバックエンドサービスに渡し、トレースされたフィールドをCustomTraceIdフィールドに記録します。 API Gatewayは、トレースされたフィールドの値をトレースIDとして使用して、トレース分析にログを報告します。 tracedフィールドの値は、16ビットまたは32ビットの16進数である標準のTraceId形式である必要があります。

      • クライアントがトレースされたフィールドを生成しない場合、またはフィールド値が有効な形式でない場合、API GatewayはランダムなトレースIDを生成して、トレース分析にログを報告します。

    • EagleEye関連のヘッダー (Eagleeye-Rpcid、Eagleeye-Traceid、またはEagleeye-Sampled) をTransparently PassまたはGenerate: チェックボックスをオンにすると、API Gatewayはクライアントからバックエンドサービスに送信されるEagleEye関連のヘッダーを渡します。 このようなヘッダーがクライアントから送信されない場合、API Gatewayはヘッダーを生成してバックエンドサービスに渡します。 このパラメーターは、共有インスタンスと専用インスタンスに対して有効になります。

    • B3プロパゲーションヘッダー (X-B3-traceid、X-B3-Parentspanid、X-B3-Spanid、またはX-B3-Sampled) を透過的に渡すか生成する: チェックボックスをオンにすると、API Gatewayはクライアントからバックエンドサービスに送信されるB3-relatedヘッダーパラメーターを渡します。 このようなヘッダーパラメーターがクライアントから送信されない場合、API Gatewayはパラメーターを生成してバックエンドサービスに渡します。 このパラメーターは、共有インスタンスと専用インスタンスに対して有効になります。

    • トレースログをAlibaba Cloud Tracing Analysisにアップロードします (専用インスタンスのみ) 。

      • アプリ名: トレース分析を設定するアプリケーションの名前を指定します。

      • Arms Endpoint: このトピックの「セクション1.4」で取得したエンドポイントを入力します。 サービスが同じリージョンにデプロイされている場合は、効率を高めるためにプライベートエンドポイントを使用することを推奨します。

      • ログサンプリング戦略: 要件に基づいてオプションを選択します。 有効な値: すべてのアップロード、アップロードの割合、および1秒あたりの固定アップロード数。

    API Gatewayコンソールでトレース分析を設定した後、tracing analysisコンソールでリクエストのトレースを表示できます。

    Tracing Analysisの使用方法の詳細については、「API呼び出し」をご参照ください。