Mengkonfigurasi X-Ray SDK for Go

Anda dapat menentukan konfigurasi untuk X-Ray SDK for Go melalui variabel lingkungan, dengan Configure memanggil dengan objek, atau Config dengan mengasumsikan nilai default. Variabel lingkungan lebih diutamakan dibandingkan nilai Config, yang lebih diutamakan dibandingkan nilai default apa pun.

Plugin layanan

Gunakan plugins untuk mencatat informasi tentang layanan yang meng-hosting aplikasi Anda.

Untuk menggunakan plugin, impor salah satu paket berikut.

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

Setiap plugin memiliki panggilan fungsi Init() eksplisit yang memuat plugin.

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 juga menggunakan pengaturan plugin untuk mengatur bidang origin di segmen. Ini menunjukkan jenis AWS sumber daya yang menjalankan aplikasi Anda. Saat Anda menggunakan beberapa plugin, SDK menggunakan urutan resolusi berikut untuk menentukan asal: ElasticBeanstalk > EKS > ECS > EC2.

Aturan pengambilan sampel

SDK menggunakan aturan pengambilan sampel yang Anda tentukan di X-Ray konsol untuk menentukan permintaan mana yang akan direkam. Aturan default melacak permintaan pertama setiap detik, dan lima persen dari permintaan tambahan di semua layanan yang mengirim jejak ke X-Ray. Buat aturan tambahan di X-Ray konsol untuk menyesuaikan jumlah data yang direkam untuk setiap aplikasi Anda.

SDK menerapkan aturan kustom sesuai urutan penetapannya. Jika permintaan cocok dengan beberapa aturan kustom, SDK hanya menerapkan aturan pertama.

Anda juga dapat mengonfigurasi SDK untuk memuat aturan sampling dari dokumen JSON. SDK dapat menggunakan aturan lokal sebagai cadangan untuk kasus di mana X-Ray pengambilan sampel tidak tersedia, atau menggunakan aturan lokal secara eksklusif.

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

Contoh ini menentukan satu aturan kustom dan aturan default. Aturan kustom menerapkan tingkat pengambilan sampel lima persen tanpa jumlah minimum permintaan untuk melacak jalur di /api/move/. Aturan default menelusuri permintaan pertama setiap detik dan 10 persen dari permintaan tambahan.

Kerugian dari mendefinisikan aturan secara lokal adalah bahwa target tetap diterapkan oleh setiap instance perekam secara independen, alih-alih dikelola oleh layanan. X-Ray Ketika Anda men-deploy lebih banyak host, laju tetap akan dikalikan, sehingga sulit untuk mengontrol jumlah data yang dicatat.

AWS Lambda Aktif, Anda tidak dapat mengubah laju pengambilan sampel. Jika fungsi Anda dipanggil oleh layanan yang diinstrumentasikan, panggilan yang menghasilkan permintaan yang sampelnya diambil oleh layanan yang akan dicatat oleh Lambda. Jika pelacakan aktif diaktifkan dan tidak ada header pelacakan, Lambda membuat keputusan pengambilan sampel.

Untuk memberikan aturan pencadangan, arahkan ke file JSON pengambilan sampel lokal dengan menggunakan NewCentralizedStrategyWithFilePath.

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

Untuk hanya menggunakan aturan lokal, arahkan ke file JSON pengambilan sampel lokal dengan menggunakan NewLocalizedStrategyFromFilePath.

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

Pencatatan log

X-Ray menggunakan antarmuka berikut untuk logging. Pencatat default menulis ke stdout di LogLevelInfo dan di atasnya.

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

Variabel-variabel lingkungan

Anda dapat menggunakan variabel lingkungan untuk mengonfigurasi X-Ray SDK for Go. SDK mendukung variabel berikut.

Variabel lingkungan mengganti nilai yang setara yang diatur dalam kode.

Menggunakan konfigurasi

Anda juga dapat mengonfigurasi X-Ray SDK for Go menggunakan metode Configure ini. Configuremengambil satu argumen, sebuah Config objek, dengan bidang opsional berikut.