Kit SDK AWS X-Ray pour Go

Le kit SDK X-Ray pour Go est un ensemble de bibliothèques pour les applications Go qui fournit des classes et des méthodes permettant de générer et d'envoyer des données de suivi pour le démon X-Ray. Les données de suivi inclut des informations sur les demandes HTTP entrantes servies par l'application et les appels que l'application effectue vers les services en aval à l'aide duAWSSDK, clients HTTP ou connecteur de base de données SQL. Vous pouvez également créer des segments manuellement et ajouter des informations de débogage dans les annotations et les métadonnées.

Téléchargez le kit de développement logiciel (SDK) à partir de son référentiel GitHub à l'aide de l'instruction go get :

$ go get -u github.com/aws/aws-xray-sdk-go/... 

Pour les applications web, commencez par utiliser la xray.Handler fonction pour suivre les demandes entrantes. Le gestionnaire de messages crée un segment pour chaque demande suivie et met fin au segment lorsque la réponse est envoyée. Tandis que le segment soit ouvert, vous pouvez utiliser les méthodes du client du SDK pour ajouter des informations au segment et créer des sous-segments afin de suivre les appels en amont. Le kit de développement logiciel (SDK) enregistre aussi automatiquement les exceptions que votre application renvoie quand le segment est ouvert.

Pour les fonctions Lambda appelées par une application ou un service instrumenté, Lambda lit leEn-tête de suiviet suit automatiquement les demandes échantillonnées. Pour d'autres fonctions, vous pouvezconfiguration de Lambdapour échantillonner et suivre les demandes entrantes. Dans les deux cas, Lambda crée le segment et le fournit au SDK X-Ray.

Note

Sur Lambda, le kit SDK X-Ray est facultatif. Si vous ne l'utilisez pas dans votre fonction, votre carte de service inclura toujours un nœud pour le service Lambda et un pour chaque fonction Lambda. En ajoutant le SDK, vous pouvez instrumenter votre code de fonction pour ajouter des sous-segments au segment de fonction enregistré par Lambda. Pour plus d'informations, consultez AWS Lambda et AWS X-Ray.

Ensuite, enveloppez votre client avec un appel à la fonction AWS. Cette étape garantit que X-Ray instrumente les appels à toutes les méthodes client. Vous pouvez également instrumenter les appels vers les bases de données SQL.

Une fois que vous êtes initié à utiliser le kit SDK, personnalisez son comportement enconfiguration de l'enregistreur et du middleware. Vous pouvez ajouter des plug-ins pour enregistrer les données sur les ressources de calcul exécutant votre application, personnaliser le comportement d'échantillonnage en définissant des règles d'échantillonnage et définir le niveau de journal afin d'afficher plus ou moins d'informations du kit de développement logiciel dans vos journaux d'application.

Enregistrez les informations supplémentaires sur les demandes et le travail que votre application effectue dans les annotations et les métadonnées. Les annotations sont de simples paires clé-valeur, indexées en vue de leur utilisation avec les expressions de filtre, de telle sorte que vous pouvez explorer les suivis qui contiennent des données spécifiques. Les entrées des métadonnées sont moins restrictives et peuvent enregistrer des objets et tableaux entiers (tout ce qui peut être sérialisé en JSON).

Annotations et métadonnées

Les annotations et les métadonnées sont du texte arbitraire que vous ajoutez aux segments avec le kit SDK X-Ray. Les annotations sont indexées pour pouvoir être utilisées avec les expressions de filtre. Les métadonnées ne sont pas indexées, mais peuvent être visualisées dans le segment brut avec la console X-Ray ou l'API. Toute personne que vous accordez un accès en lecture à X-Ray peut consulter ces données.

Lorsque vous avez un grand nombre de clients instrumentés dans votre code, un seul segment de demande peut contenir un grand nombre de sous-segments, un par appel effectué à l'aide d'un client instrumenté. Vous pouvez organiser et grouper les sous-segments en enveloppant les appels clients dans des sous-segments personnalisés. Vous pouvez créer un sous-segment personnalisé pour une fonction complète ou une quelconque section du code, puis enregistrer les métadonnées et les annotations sur le sous-segment au lieu de tout écrire sur le segment parent.

Prérequis

Le kit SDK X-Ray pour Go nécessite Go 1.9 ou version ultérieure.

Le kit de développement logiciel dépend des bibliothèques suivantes lors de la compilation et de l'exécution :

• AWSKit SDK for Go version 1.10.0 ou plus récente

Ces dépendances sont déclarées dans le fichier README.md du kit de développement logiciel.

Documentation de référence

Une fois que vous avez téléchargé le kit SDK, générez et hébergez la documentation en local pour l'afficher dans un navigateur web.

Pour consulter la documentation de référence

1. Accédez au répertoire $GOPATH/src/github.com/aws/aws-xray-sdk-go (Linux ou Mac) ou au dossier %GOPATH%\src\github.com\aws\aws-xray-sdk-go (Windows)

2. Exécutez la commande godoc.

   $ godoc -http=:6060

3. Ouvrez un navigateur à l'adresse http://localhost:6060/pkg/github.com/aws/aws-xray-sdk-go/.