Menambahkan rekaman aktivitas dan metrik kustom ke aplikasi Anda dengan OpenTelemetry

Dokumen ini menjelaskan cara menambahkan kode kemampuan observasi ke aplikasi Anda dengan menggunakan OpenTelemetry. OpenTelemetry menyediakan library instrumentasi yang menghasilkan telemetri untuk framework populer. Anda dapat menambah telemetri yang dihasilkan library dengan menambahkan instrumentasi kustom yang mengukur perilaku khusus aplikasi Anda.

Prinsip dan konsep yang dijelaskan dalam dokumen ini dapat diterapkan ke aplikasi yang ditulis dalam semua bahasa yang didukung oleh OpenTelemetry. Untuk mempelajari instrumentasi lebih lanjut, lihat dokumen berikut:

Kode contoh, yang merupakan aplikasi Go yang sama yang dijelaskan dalam contoh instrumentasi Go, tersedia di GitHub. Untuk melihat contoh lengkap, di toolbar contoh, pilih logo GitHub.

Sebelum memulai

Aktifkan Cloud Logging, Cloud Monitoring, dan Cloud Trace API.

Peran yang diperlukan untuk mengaktifkan API

Untuk mengaktifkan API, Anda memerlukan peran IAM Service Usage Admin (roles/serviceusage.serviceUsageAdmin), yang berisi izin serviceusage.services.enable. Pelajari cara memberikan peran.

Aktifkan API

Membuat trace kustom

Untuk membuat trace kustom dari aplikasi Anda, tambahkan kode instrumentasi yang membuat rentang OpenTelemetry. Di OpenTelemetry, rentang adalah elemen dasar untuk trace.

Untuk membuat rentang, lakukan hal berikut:

  1. Ubah aplikasi Anda untuk mendapatkan OpenTelemetry Tracer. Di OpenTelemetry, tracer adalah pembuat rentang. Anda dapat memperoleh tracer seperti yang ditunjukkan dalam kode berikut:

    const scopeName = "github.com/GoogleCloudPlatform/golang-samples/opentelemetry/instrumentation/app/work"

var (
	meter                = otel.Meter(scopeName)
	tracer               = otel.Tracer(scopeName)
	sleepHistogram       metric.Float64Histogram
	subRequestsHistogram metric.Int64Histogram
)

    Nama tracer, yang diwakili oleh scopeName, mengidentifikasi cakupan instrumentasi dari trace yang dihasilkan.

  2. Gunakan instance tracer untuk membuat rentang. Dalam contoh kode berikut, fungsi computeSubrequests menghasilkan rentang setiap kali dipanggil:

    func computeSubrequests(r *http.Request, subRequests int) error {
	// Add custom span representing the work done for the subrequests
	ctx, span := tracer.Start(r.Context(), "subrequests")
	defer span.End()

	// Make specified number of http requests to the /single endpoint.
	for i := 0; i < subRequests; i++ {
		if err := callSingle(ctx); err != nil {
			return err
		}
	}
	// record number of sub-requests made
	subRequestsHistogram.Record(ctx, int64(subRequests))
	return nil
}

    Dalam contoh kode sebelumnya, rentang yang dihasilkan dari fungsi computeSubrequests mewakili pekerjaan yang dilakukan oleh seluruh fungsi. Hal ini karena langkah pertama fungsi adalah memulai rentang baru menggunakan tracer.Start dan kata kunci defer sebelum span.End() memastikan bahwa rentang diakhiri tepat sebelum fungsi keluar.

Membuat metrik kustom

Untuk membuat metrik dari aplikasi Anda, tambahkan kode instrumentasi yang mencatat pengukuran yang dilakukan selama eksekusi aplikasi.

Untuk membuat metrik, lakukan hal berikut:

  1. Ubah aplikasi Anda untuk mendapatkan OpenTelemetry Meter. Di OpenTelemetry, a meter menyediakan akses ke instrumen metrik untuk mencatat metrik. Anda dapat memperoleh meter seperti yang ditunjukkan dalam kode berikut:

    const scopeName = "github.com/GoogleCloudPlatform/golang-samples/opentelemetry/instrumentation/app/work"

var (
	meter                = otel.Meter(scopeName)
	tracer               = otel.Tracer(scopeName)
	sleepHistogram       metric.Float64Histogram
	subRequestsHistogram metric.Int64Histogram
)

    Nama meter, yang diwakili oleh scopeName, mengidentifikasi cakupan instrumentasi dari metrik yang dihasilkan.

  2. Gunakan instance meter untuk membuat instrumen yang dapat mencatat metrik. Misalnya, dalam kode berikut, kita menggunakan meter untuk membuat OpenTelemetry Histogram:

    sleepHistogram, err = meter.Float64Histogram("example.sleep.duration",
	metric.WithDescription("Sample histogram to measure time spent in sleeping"),
	metric.WithExplicitBucketBoundaries(0.05, 0.075, 0.1, 0.125, 0.150, 0.2),
	metric.WithUnit("s"))
if err != nil {
	panic(err)
}

    Kode sebelumnya menghasilkan histogram bernama sleepHistogram.

  3. Gunakan instance sleepHistogram untuk mencatat waktu tidur, yang ditentukan saat fungsi randomSleep dipanggil:

    func randomSleep(r *http.Request) time.Duration {
	// simulate the work by sleeping 100 to 200 ms
	sleepTime := time.Duration(100+rand.Intn(100)) * time.Millisecond
	time.Sleep(sleepTime)

	hostValue := attribute.String("host.value", r.Host)
	// custom histogram metric to record time slept in seconds
	sleepHistogram.Record(r.Context(), sleepTime.Seconds(), metric.WithAttributes(hostValue))
	return sleepTime
}

    Metrik yang dicatat dari instrumen ini diekspor dari aplikasi Anda berdasarkan konfigurasi pengekspor OpenTelemetry.

Langkah berikutnya