API Gateway:Configurer l'analyse de traces

Prérequis

• Vous utilisez une instance dédiée d'API Gateway.

• Activez Tracing Analysis.

• Activez Simple Log Service.

Accorder des autorisations à Tracing Analysis

1. Connectez-vous à la console Tracing Analysis .

2. Sur la page Overview, cliquez sur Authorize Now pour accorder à Tracing Analysis l'autorisation de lire et d'écrire vos données Simple Log Service.

3. Sur la page Cloud Resource Access Authorization, sélectionnez les autorisations requises et cliquez sur Confirm Authorization Policy.

4. Après l'autorisation, accédez à la page Overview depuis le volet de navigation de gauche. Dans la section Access Process , cliquez sur View Access Point Information . Sur la page Access Point Information, activez l'option Show Token et sélectionnez Jaeger comme Client-side Collection Tool . Vous pouvez ensuite trouver et enregistrer l'adresse de l'endpoint dans la section Report Data over HTTP .

Configurer l'analyse de traces dans API Gateway

1. Connectez-vous à la console API Gateway .

2. Dans le volet de navigation de gauche, choisissez API Management > API Groups . Dans la liste API Groups , cliquez sur un groupe d'API pour ouvrir la page Group Details . Sur la page Group Details , configurez les paramètres suivants.

   • Trace Field Position : spécifiez l'emplacement du champ de trace. Les valeurs valides sont Header et Query.

   • Tracing Field Name : spécifiez le nom du champ tracé.

     • Le champ tracé est généré par un client. API Gateway transmet le champ tracé au service backend et l'enregistre dans le champ CustomTraceId. API Gateway utilise la valeur du champ tracé comme ID de trace pour envoyer les journaux à Tracing Analysis. La valeur du champ tracé doit être au format TraceId standard, c'est-à-dire un nombre hexadécimal de 16 ou 32 bits.

     • Si le client ne génère pas le champ tracé ou si la valeur du champ n'est pas dans un format valide, API Gateway génère un ID de trace aléatoire pour envoyer les journaux à Tracing Analysis.

   • Transmettre ou générer les en-têtes liés à EagleEye (Eagleeye-Rpcid, Eagleeye-Traceid, Eagleeye-Sampled) : si vous sélectionnez cette option, API Gateway transmet les en-têtes liés à EagleEye du client au service backend. Si le client n'envoie pas ces en-têtes, API Gateway les génère et les transmet au service backend. (Cette fonctionnalité est disponible pour les instances Serverless et dédiées).

   • Transmettre ou générer les en-têtes liés à B3 (X-B3-traceid, X-B3-Parentspanid, X-B3-Spanid, X-B3-Sampled) : si vous sélectionnez cette option, API Gateway transmet les en-têtes liés à B3 du client au service backend. Si le client n'envoie pas ces en-têtes, API Gateway les génère et les transmet au service backend. (Cette fonctionnalité est disponible pour les instances Serverless et dédiées).

   • Envoyer les journaux de trace vers Alibaba Cloud Tracing Analysis (pour les instances dédiées uniquement) :

     • App Name : spécifiez le nom de l'application pour laquelle vous souhaitez configurer l'analyse de traces.

     • Endpoint : saisissez l'adresse de l'endpoint indiquée à l'étape 4 de la section Accorder des autorisations à Tracing Analysis . Si vos services se trouvent dans la même région, utilisez un endpoint de réseau interne pour de meilleures performances.

     • Log Sampling Strategy : sélectionnez une option en fonction de vos besoins. Les valeurs valides sont : Upload all, Percentage upload et Fixed number of uploads per second.

Une fois que vous avez configuré Tracing Analysis dans la console API Gateway, vous pouvez consulter les traces de requêtes dans la console Tracing Analysis. Pour plus d'informations sur l'utilisation de Tracing Analysis, consultez la rubrique Afficher les détails des appels d'API .