設定適用於 Go 的 X-Ray 的開發套件

您可以指定 X-Ray SDK 的配置，通過Configure使用Config對象調用或假設默認值。環境變數優先於 Config 值，而後者則優先於任何預設值。

服務外掛程式

用plugins於記錄託管應用程式之服務的相關資訊。

若要使用外掛程式，請匯入以下其中一個套件。

"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"

每個外掛程式都有一個明確載入該外掛程式的 Init() 函數呼叫。

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",
  })
}

SDK 也會使用外掛程式設定來設定區origin段上的欄位。這表示運行您的應用程序的 AWS 資源的類型。當您使用多個外掛程式時，SDK 會使用下列解析順序來判斷來源： ElasticBeanstalk > EKS > ECS > EC2。

抽樣規則

SDK 會使用您在 X-Ray 主控台中定義的取樣規則來決定要記錄的要求。預設規則會每秒追蹤第一個要求，而所有服務的任何其他要求的百分之五會傳送追蹤至 X-Ray。在 X-Ray 主控台中建立其他規則，以自訂為每個應用程式記錄的資料量。

SDK 會依定義規則的順序套用自訂規則。如果要求符合多個自訂規則，SDK 只會套用第一個規則。

您也可以將 SDK 設定為從 JSON 文件載入取樣規則。SDK 可以使用本機規則做為無法使用 X-Ray 取樣的情況的備份，或僅使用本機規則。

{
  "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
  }
}

此範例定義了一個自訂規則和一個預設規則。自訂規則會套用百分之五的取樣率，而且沒有追蹤下限路徑的要求數目下/api/move/限。預設規則會每秒追蹤第一個要求，以及 10% 的額外要求。

在本機定義規則的缺點是，固定目標會由記錄器的每個執行個體獨立套用，而不是由 X-Ray 服務管理。當您部署更多主機時，固定費率會倍增，因此更難以控制記錄的資料量。

開啟時 AWS Lambda，您無法修改取樣率。如果您的函數是由已檢測的服務呼叫，則 Lambda 會記錄產生由該服務取樣之請求的呼叫。如果啟用主動追蹤且沒有追蹤標頭，Lambda 會做出取樣決策。

若要提供備份規則，請使用 NewCentralizedStrategyWithFilePath 指向本機抽樣 JSON 檔案。

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

若僅要使用本機規則，請使用 NewLocalizedStrategyFromFilePath 指向本機抽樣 JSON 檔案。

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

日誌

X-Ray 使用下列介面進行記錄。在 LogLevelInfo 和以上時，預設記錄器會寫入 stdout。

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))

環境變數

您可以使用環境變數來設定 Go 的 X-Ray SDK。軟體開發套件支援以下變數。

環境變數會覆寫程式碼中所設的同等值。

使用設定

您還可以使用該Configure方法為 Go 配置 X-Ray SDK。 Configure需要一個引數，一個Config物件，包含下列選擇性欄位。