Configuration de règles d'échantillonnage AWS X-Ray pour les API API Gateway - Amazon API Gateway

Configuration de règles d'échantillonnage AWS X-Ray pour les API API Gateway

Vous pouvez utiliser la console AWS X-Ray ou un kit SDK pour configurer des règles d'échantillonnage pour votre API Amazon API Gateway. Une règle d'échantillonnage spécifie quelles requêtes X-Ray doit enregistrer pour votre API. En personnalisant les règles d'échantillonnage, vous pouvez contrôler la quantité de données que vous enregistrez, et modifier le comportement d'échantillonnage à la volée, sans modifier ni redéployer votre code.

Avant de spécifier vos règles d'échantillonnage X-Ray, consultez les rubriques suivantes dans le Manuel du développeur X-Ray :

Valeurs des options des règles d'échantillonnage X-Ray pour les API API Gateway

Les options d'échantillonnage X-Ray suivantes s'appliquent à API Gateway. Les valeurs de chaîne peuvent comporter des caractères génériques pour correspondre à un seul caractère (?) ou à zéro caractère ou plus (*). Pour plus de détails, et pour obtenir une explication détaillée de l'utilisation des paramètres Reservoir (Réservoir) et Rate (Fréquence), consultez la section Configuration de règles d'échantillonnage dans la console AWS X-Ray.

  • Rule name (Nom de la règle) (chaîne) — Nom unique pour la règle.

  • Priority (Priorité) (nombre entier compris entre 1 et 9999) — Priorité de la règle d'échantillonnage. Les services évaluent les règles dans l'ordre croissant de priorité, et prennent une décision d'échantillonnage avec la première règle correspondante.

  • Reservoir (Réservoir) (entier positif) — Nombre fixe de demandes correspondantes à instrumenter par seconde, avant d'appliquer la fréquence fixe. Le réservoir n'est pas utilisé directement par les services, mais s'applique à tous les services qui utilisent la règle collectivement.

  • Rate (Fréquence) (nombre compris entre 0 et 100) — Pourcentage de demandes correspondantes à instrumenter une fois que le réservoir est épuisé.

  • Service name (Nom du service) (chaîne) — Nom de l'étape d'API, sous la forme {api-name}/{stage-name}. Par exemple, si vous deviez déployer l'exemple d'API PetStore sur une étape nommée test, la valeur à spécifier pour Service name (Nom du service) dans votre règle d'échantillonnage serait pets/test.

  • Service type (Type de service) (chaîne) — Pour une API API Gateway, vous pouvez spécifier AWS::ApiGateway::Stage ou AWS::ApiGateway::*.

  • Host (Hôte) (chaîne) — Nom d'hôte de l'en-tête d'hôte HTTP. Définissez cette valeur sur * pour l'associer à tous les noms d'hôte. Vous pouvez également spécifier tout ou partie d'un nom d'hôte pour le faire correspondre (par exemple, api.example.com ou *.example.com).

  • Resource ARN (ARN des ressources) (chaîne) — ARN de l'étape de l'API, au format arn:aws:execute-api:{region}:{account-id}:{api-id}/{stage-name}, par exemple, arn:aws:execute-api:us-east-1:123456789012:qsxrty/test.

    Le nom de l'étape peut être obtenu à partir de la console ou de l'interface de ligne de commande ou de l'API API Gateway. Pour plus d'informations sur les formats ARN, consultez Référence générale d'Amazon Web Services.

  • HTTP method (Méthode HTTP) (chaîne) — Méthode à échantillonner (par exemple, GET).

  • URL path (Chemin URL) (chaine) — Cette option n'est pas prise en charge pour API Gateway.

  • (facultatif) Attributes (Attributs) (clé et valeur) — En-têtes de la demande HTTP d'origine (par exemple, Connection, Content-Length, ou Content-Type). Chaque attribut peut contenir jusqu'à 32 caractères.

Exemples de règles d'échantillonnage X-Ray

Exemple de règle d'échantillonnage n°1

Cette règle échantillonne toutes les requêtes GET pour l'API testxray à l'étape test.

  • Rule name (Nom de la règle) — test-sampling

  • Priority (Priorité) — 17

  • Reservoir size (Taille du réservoir) — 10

  • Fixed rate (Fréquence fixe) — 10

  • Service name (Nom du service) — testxray/test

  • Service type (Type de service) — AWS::ApiGateway::Stage

  • HTTP method (Méthode HTTP) — GET

  • Resource ARN (ARN des ressources) — *

  • Host (Hôte) — *

Exemple de règle d'échantillonnage n°2

Cette règle échantillonne toutes les requêtes pour l'API testxray à l'étape prod.

  • Rule name (Nom de la règle) — prod-sampling

  • Priority (Priorité) — 478

  • Reservoir size (Taille du réservoir) — 1

  • Fixed rate (Fréquence fixe) — 60

  • Service name (Nom du service) — testxray/prod

  • Service type (Type de service) — AWS::ApiGateway::Stage

  • HTTP method (Méthode HTTP) — *

  • Resource ARN (ARN des ressources) — *

  • Host (Hôte) — *

  • Attributes (Attributs) {}