Configuration du AWS X-Ray daemon

Vous pouvez utiliser les options de ligne de commande ou un fichier de configuration pour personnaliser le comportement du daemon X-Ray. La plupart des options sont disponibles en utilisant les deux méthodes, mais certaines ne sont disponibles que dans les fichiers de configuration et d'autres uniquement sur la ligne de commande.

Pour commencer, la seule option que vous devez connaître est -n ou--region, que vous utilisez pour définir la région utilisée par le daemon pour envoyer les données de suivi à X-Ray.

~/xray-daemon$ ./xray -n us-east-2

Si vous exécutez le démon localement, c'est-à-dire pas sur Amazon EC2, vous pouvez ajouter l'option permettant de ne pas vérifier -o les informations d'identification du profil de l'instance afin que le démon soit prêt plus rapidement.

~/xray-daemon$ ./xray -o -n us-east-2

Le reste des options de ligne de commande vous permettent de configurer la journalisation, d'écouter sur un autre port, de limiter la quantité de mémoire utilisée par le démon ou d'assumer un rôle pour envoyer des données de suivi à un autre compte.

Vous pouvez transmettre un fichier de configuration au daemon pour accéder aux options de configuration avancées et notamment limiter le nombre d'appels simultanés à X-Ray, désactiver la rotation des journaux et envoyer le trafic vers un proxy.

Variables d'environnement prises en charge

Le daemon X-Ray prend en charge les variables d'environnement suivantes :

• AWS_REGION— Spécifie le point Région AWSde terminaison du service X-Ray.

• HTTPS_PROXY— Spécifie une adresse proxy par laquelle le démon doit télécharger des segments. Il peut s'agir des noms de domaine DNS ou des adresses IP et des numéros de port utilisés par vos serveurs proxy.

Utilisation d'options de ligne de commande

Transmettez ces options au démon lorsque vous l'exécutez en local ou avec un script de données utilisateur.

Options de ligne de commande

• -b, --bind — Écoutez les documents segmentés sur un autre port UDP.

  --bind "127.0.0.1:3000"

  Par défaut —2000.

• -t, --bind-tcp — Écoutez les appels vers le service X-Ray sur un autre port TCP.

  -bind-tcp "127.0.0.1:3000"

  Par défaut —2000.

• -c, --config — Charge un fichier de configuration depuis le chemin spécifié.

  --config "/home/ec2-user/xray-daemon.yaml"

• -f, --log-file — Affiche les journaux dans le chemin de fichier spécifié.

  --log-file "/var/log/xray-daemon.log"

• -l, --log-level — Niveau de journalisation, du plus détaillé au moins détaillé : dev, debug, info, warn, error, prod.

  --log-level warn

  Par défaut — prod

• -m, --buffer-memory — Modifiez la quantité de mémoire en Mo que les tampons peuvent utiliser (minimum 3).

  --buffer-memory 50

  Par défaut : 1 % de la mémoire disponible.

• -o, --local-mode — Ne vérifiez pas les métadonnées de l'instance EC2.

• -r, --role-arn — Assumez le rôle IAM spécifié pour télécharger des segments vers un autre compte.

  --role-arn "arn:aws:iam::123456789012:role/xray-cross-account"

• -a, --resource-arn — Amazon Resource Name (ARN) de la AWS ressource exécutant le daemon.

• -p, --proxy-address — Téléchargez des segments AWS X-Ray via un proxy. Le protocole du serveur proxy doit être spécifié.

  --proxy-address "http://192.0.2.0:3000"

• -n, --region — Envoyez des segments au service X-Ray d'une région spécifique.

• -v, --version — Affiche la version du AWS X-Ray démon.

• -h, --help — Affiche l'écran d'aide.

Utilisation d'un fichier de configuration

Vous pouvez également utiliser un fichier au format YAML pour configurer le démon. Transmettez le fichier de configuration au démon à l'aide de l'option -c.

~$ ./xray -c ~/xray-daemon.yaml

Configuration des options du fichier

• TotalBufferSizeMB— Taille maximale de la mémoire tampon en Mo (minimum 3). Choisissez 0 pour utiliser 1 % de la mémoire hôte.

• Concurrency— Nombre maximum d'appels simultanés AWS X-Ray pour télécharger des documents segmentés.

• Region— Mettez des segments en AWS X-Ray service dans une région spécifique.

• Socket— Configure la liaison du démon.

  • UDPAddress— Modifiez le port sur lequel le daemon écoute.

  • TCPAddress— Écoutez les appels vers le service X-Ray sur un autre port TCP.

• Logging— Configurez le comportement de journalisation.

  • LogRotation— Réglé sur false pour désactiver la rotation des journaux.

  • LogLevel— Modifiez le niveau de journalisation, du plus détaillé au moins détaillé :dev,, info oudebug,prod,warn,error. prod La valeur par défaut estprod, ce qui équivaut àinfo.

  • LogPath— Affiche les journaux dans le chemin de fichier spécifié.

• LocalMode— Définissez sur true pour ignorer la vérification des métadonnées de l'instance EC2.

• ResourceARN— Amazon Resource Name (ARN) de la AWS ressource exécutant le daemon.

• RoleARN— Assumez le rôle IAM spécifié pour télécharger des segments vers un autre compte.

• ProxyAddress— Téléchargez des segments AWS X-Ray via un proxy.

• Endpoint— Modifiez le point de terminaison du service X-Ray auquel le démon envoie les documents de segment.

• NoVerifySSL— Désactive la vérification des certificats TLS.

• Version— Version du format du fichier de configuration du démon. La version du format de fichier est un champ obligatoire.

Exemple xray-daemon.yaml

Ce fichier de configuration remplace le port d'écoute du démon par 3000, désactive les vérifications des métadonnées d'instance, définit un rôle à utiliser pour le chargement des segments et modifie les options de région et de journalisation.

Socket:
  UDPAddress: "127.0.0.1:3000"
  TCPAddress: "127.0.0.1:3000"
Region: "us-west-2"
Logging:
  LogLevel: "warn"
  LogPath: "/var/log/xray-daemon.log"
LocalMode: true
RoleARN: "arn:aws:iam::123456789012:role/xray-cross-account"
Version: 2