Menambahkan anotasi dan metadata ke segmen dengan X-Ray SDK for Go

Anda dapat menggunakan anotasi dan metadata untuk merekam informasi tambahan tentang permintaan, lingkungan, atau aplikasi Anda. Anda dapat menambahkan anotasi dan metadata ke segmen yang dibuat oleh SDK X-Ray, atau subsegmen kustom yang Anda buat.

Anotasi adalah pasangan kunci-nilai dengan string, nomor, atau nilai-nilai Boolean. Anotasi diindekskan untuk digunakan dengan Ekspresi filter. Gunakan anotasi untuk mencatat data yang ingin Anda gunakan untuk mengelompokkan pelacakan di konsol tersebut, atau saat memanggil API GetTraceSummaries.

Metadata adalah pasangan kunci-nilai yang dapat memiliki nilai dari setiap tipe, termasuk objek dan daftar, tetapi tidak diindekskan untuk digunakan dengan ekspresi filter. Gunakan metadata untuk mencatat data tambahan yang ingin disimpan dalam pelacakan tetapi tidak perlu digunakan dengan pencarian.

Selain anotasi dan metadata, Anda juga dapat mencatat string ID pengguna pada segmen. ID Pengguna dicatat dalam bidang terpisah pada segmen dan diindeks untuk digunakan dengan penelusuran.

Mencatat anotasi dengan X-Ray SDK for Go

Gunakan anotasi untuk mencatat informasi tentang segmen yang ingin Anda indeks untuk pencarian.

Persyaratan Anotasi

• Tombol — Kunci untuk anotasi X-Ray dapat memiliki hingga 500 karakter alfanumerik. Anda tidak dapat menggunakan spasi atau simbol selain simbol garis bawah (_).

• Nilai — Nilai untuk anotasi X-Ray dapat memiliki hingga 1.000 karakter Unicode.

• Jumlah Anotasi — Anda dapat menggunakan hingga 50 anotasi per jejak.

Untuk mencatat anotasi, hubungi AddAnnotation dengan string yang berisi metadata yang ingin Anda kaitkan dengan segmen.

xray.AddAnnotation(key string, value interface{})

SDK mencatat anotasi sebagai pasangan nilai kunci dalam objek annotations di dokumen segmen. Memanggil AddAnnotation dua kali dengan tombol yang sama menimpa nilai yang tercatat sebelumnya pada segmen yang sama.

Untuk menemukan pelacakan yang memiliki anotasi dengan nilai-nilai tertentu, gunakan annotations.key kata kunci dalam Ekspresi filter.

Mencatat metadata dengan X-Ray SDK for Go

Gunakan metadata untuk mencatat informasi di segmen yang tidak perlu diindekskan untuk pencarian.

Untuk mencatat metadata, panggil AddMetadata Dengan string yang berisi metadata yang ingin Anda kaitkan dengan segmen.

xray.AddMetadata(key string, value interface{})

Mencatat ID pengguna dengan X-Ray SDK for Go

Catat ID pengguna pada segmen permintaan untuk mengidentifikasi pengguna yang mengirim permintaan.

Untuk mencatat ID pengguna

1. Dapatkan referensi ke segmen saat ini dari AWSXRay.

   import (
     "context"
     "github.com/aws/aws-xray-sdk-go/xray"
   )
   
   mySegment := xray.GetSegment(context)

2. Panggil setUser dengan ID String dari pengguna yang mengirim permintaan.

   mySegment.User = "U12345"

Untuk menemukan pelacakan untuk ID pengguna, gunakan kata kunci user dalam Ekspresi filter.