Configuration du X-Ray SDK pour Go

Vous pouvez spécifier la configuration du X-Ray SDK for Go via des variables d'environnement, en Configure appelant avec Config un objet ou en utilisant des valeurs par défaut. Les variables d'environnement ont priorité sur les valeurs Config, qui prévalent elles-même sur n'importe quelle valeur par défaut.

Plug-ins de service

Permet plugins d'enregistrer des informations sur le service hébergeant votre application.

Pour utiliser un module d'extension, importez l'un des modules suivants :

"github.com/aws/aws-xray-sdk-go/awsplugins/ec2"
"github.com/aws/aws-xray-sdk-go/awsplugins/ecs"
"github.com/aws/aws-xray-sdk-go/awsplugins/beanstalk"

Chaque plug-in a un appel de fonction Init() explicite qui charge le plug-in.

import (
	"os"

	"github.com/aws/aws-xray-sdk-go/awsplugins/ec2"
	"github.com/aws/aws-xray-sdk-go/xray"
)

func init() {
  // conditionally load plugin
  if os.Getenv("ENVIRONMENT") == "production" {
    ec2.Init()
  }

  xray.Configure(xray.Config{
    ServiceVersion: "1.2.3",
  })
}

Le SDK utilise également les paramètres du plugin pour définir le origin champ du segment. Cela indique le type de AWS ressource qui exécute votre application. Lorsque vous utilisez plusieurs plug-ins, le SDK utilise l'ordre de résolution suivant pour déterminer l'origine : ElasticBeanstalk > EKS > ECS > EC2.

Règles d'échantillonnage

Le SDK utilise les règles d'échantillonnage que vous définissez dans la X-Ray console pour déterminer les demandes à enregistrer. La règle par défaut suit la première demande chaque seconde, et 5 % de toutes les demandes supplémentaires provenant de tous les services auxquels des traces sont envoyées X-Ray. Créez des règles supplémentaires dans la X-Ray console afin de personnaliser la quantité de données enregistrées pour chacune de vos applications.

Le SDK applique les règles personnalisées dans l'ordre dans lequel elles sont définies. Si une demande correspond à plusieurs règles personnalisées, le SDK applique uniquement la première règle.

Vous pouvez également configurer le SDK pour charger des règles d'échantillonnage à partir d'un document JSON. Le SDK peut utiliser des règles locales comme solution de sauvegarde dans les cas où l' X-Ray échantillonnage n'est pas disponible, ou utiliser exclusivement des règles locales.

{
  "version": 2,
  "rules": [
    {
      "description": "Player moves.",
      "host": "*",
      "http_method": "*",
      "url_path": "/api/move/*",
      "fixed_target": 0,
      "rate": 0.05
    }
  ],
  "default": {
    "fixed_target": 1,
    "rate": 0.1
  }
}

Cet exemple définit une règle personnalisée et une règle par défaut. La règle personnalisée applique un taux d'échantillonnage de 5 % sans nombre minimum de demandes à suivre pour les chemins sous-jacents. /api/move/ La règle par défaut suit la première demande chaque seconde et 10 % des demandes supplémentaires.

L'inconvénient de définir des règles localement est que la cible fixe est appliquée par chaque instance de l'enregistreur indépendamment, au lieu d'être gérée par le X-Ray service. Au fur et à mesure que vous déployez de nouveaux hôtes, le taux fixe est multiplié, ce qui complique le contrôle de la quantité de données enregistrées.

Activé AWS Lambda, vous ne pouvez pas modifier le taux d'échantillonnage. Si votre fonction est appelée par un service instrumenté, les appels ayant généré des demandes échantillonnées par ce service seront enregistrés par Lambda. Si le suivi actif est activé et qu'aucun en-tête de suivi n'est présent, Lambda prend la décision d'échantillonnage.

Pour fournir les règles de sauvegarde, pointez sur le fichier JSON d'échantillonnage local en utilisant NewCentralizedStrategyWithFilePath.

s, _ := sampling.NewCentralizedStrategyWithFilePath("sampling.json") // path to local sampling json
xray.Configure(xray.Config{SamplingStrategy: s})

Pour utiliser uniquement les règles locales, pointez sur le fichier JSON d'échantillonnage local en utilisant NewLocalizedStrategyFromFilePath.

s, _ := sampling.NewLocalizedStrategyFromFilePath("sampling.json") // path to local sampling json
xray.Configure(xray.Config{SamplingStrategy: s})

Logging

X-Ray utilise l'interface suivante pour la journalisation. L'enregistreur d’événements par défaut écrit sur stdout pour LogLevelInfo et au-dessus.

type Logger interface {
	Log(level LogLevel, msg fmt.Stringer)
}

const (
	LogLevelDebug LogLevel = iota + 1
	LogLevelInfo
	LogLevelWarn
	LogLevelError
)

xray.SetLogger(xraylog.NewDefaultLogger(os.Stderr, xraylog.LogLevelError))

Variables d’environnement

Vous pouvez utiliser des variables d'environnement pour configurer le X-Ray SDK for Go. Le kit SDK prend en charge les variables suivantes.

Les variables d'environnement remplacent les valeurs équivalentes définies dans le code.

Utilisation de Configure

Vous pouvez également configurer le X-Ray SDK pour Go à l'aide Configure de cette méthode. Configureprend un argument, un Config objet, avec les champs facultatifs suivants.