Membuat profil aplikasi Go

Halaman ini menjelaskan cara mengubah aplikasi Go untuk mengambil data pembuatan profil dan mengirimkan data tersebut ke project Google Cloud Anda. Untuk mengetahui informasi umum tentang pembuatan profil, lihat Konsep pembuatan profil.

Jenis profil untuk Go:

  • Waktu CPU
  • Heap
  • Heap yang dialokasikan
  • Pertentangan (Go mutex)
  • Thread (Gunakan goroutine)

Versi bahasa Go yang didukung:

  • Semua rilis Go yang dikelola secara resmi, kecuali jika dinyatakan lain. Untuk mengetahui informasi selengkapnya, lihat kebijakan rilis bahasa Go.

Versi agen pembuatan profil yang didukung:

  • Rilis agen terbaru didukung. Secara umum, rilis yang lebih lama dari satu tahun tidak didukung. Sebaiknya gunakan versi agen yang terakhir dirilis.

Sistem operasi yang didukung:

  • Linux. Pembuatan profil aplikasi Go didukung untuk kernel Linux yang library C standarnya diimplementasikan dengan glibc atau dengan musl. Untuk informasi konfigurasi khusus kernel Linux Alpine, lihat Berjalan di Linux Alpine.

Lingkungan yang didukung:

  • Compute Engine
  • Google Kubernetes Engine (GKE)
  • Lingkungan fleksibel App Engine
  • Lingkungan standar App Engine (memerlukan Go 1.11 atau yang lebih tinggi)
  • Di luar Google Cloud (Untuk mengetahui informasi tentang persyaratan konfigurasi tambahan, lihat Membuat profil aplikasi yang berjalan di luar Google Cloud.)

Mengaktifkan Profiler API

Sebelum Anda menggunakan agen pembuatan profil, pastikan bahwa Profiler API yang mendasarinya telah diaktifkan. Anda dapat memeriksa status API dan mengaktifkannya jika perlu menggunakan Google Cloud CLI atau Konsol Google Cloud:

gcloud CLI

  1. Jika belum menginstal Google Cloud CLI di workstation, lihat dokumentasi Google Cloud CLI.

  2. Jalankan perintah berikut:

    gcloud services enable cloudprofiler.googleapis.com

Untuk informasi selengkapnya, lihat gcloud services.

Konsol Google Cloud

  1. Di panel navigasi Konsol Google Cloud, pilih APIs & Services, klik Enable APIs and Services, lalu aktifkan Cloud Profiler API:

    Buka setelan Profiler API

  2. Jika API enabled ditampilkan, berarti API sudah diaktifkan. Jika belum, klik tombol Enable.

Menggunakan Cloud Profiler

Di semua lingkungan yang didukung, Anda menggunakan Profiler dengan mengimpor paket di aplikasi, lalu menginisialisasi Profiler sedini mungkin di aplikasi Anda.

Anda dapat mengaktifkan pembuatan profil Mutex-contention (“Contention” di antarmuka) dengan menyetel opsi konfigurasi MutexProfiling ke true.

Untuk mengetahui informasi selengkapnya tentang Profiler API, termasuk semua opsi konfigurasi, lihat dokumen API publik.

Compute Engine

Untuk Compute Engine, dalam profiler.Config, tetapkan Service dengan nama untuk layanan yang sedang dibuat profilnya dan tetapkan ServiceVersion dengan versi layanan secara opsional:


// snippets is an example of starting cloud.google.com/go/profiler.
package main

import (
	"cloud.google.com/go/profiler"
)

func main() {
	cfg := profiler.Config{
		Service:        "myservice",
		ServiceVersion: "1.0.0",
		// ProjectID must be set if not running on GCP.
		// ProjectID: "my-project",

		// For OpenCensus users:
		// To see Profiler agent spans in APM backend,
		// set EnableOCTelemetry to true
		// EnableOCTelemetry: true,
	}

	// Profiler initialization, best done as early as possible.
	if err := profiler.Start(cfg); err != nil {
		// TODO: Handle error.
	}
}

Jika memiliki dependensi dalam kode sumber yang diambil secara manual, Anda mungkin perlu menambahkan kode berikut ke skrip build atau Dockerfile: 

go get cloud.google.com/go/profiler

GKE

Untuk GKE, dalam profiler.Config, tetapkan Service dengan nama untuk layanan yang sedang dibuat profilnya, dan secara opsional tetapkan ServiceVersion dengan versi layanan:


// snippets is an example of starting cloud.google.com/go/profiler.
package main

import (
	"cloud.google.com/go/profiler"
)

func main() {
	cfg := profiler.Config{
		Service:        "myservice",
		ServiceVersion: "1.0.0",
		// ProjectID must be set if not running on GCP.
		// ProjectID: "my-project",

		// For OpenCensus users:
		// To see Profiler agent spans in APM backend,
		// set EnableOCTelemetry to true
		// EnableOCTelemetry: true,
	}

	// Profiler initialization, best done as early as possible.
	if err := profiler.Start(cfg); err != nil {
		// TODO: Handle error.
	}
}

Jika memiliki dependensi dalam kode sumber yang diambil secara manual, Anda mungkin perlu menambahkan kode berikut ke skrip build atau Dockerfile: 

go get cloud.google.com/go/profiler

App Engine

Untuk lingkungan fleksibel App Engine dan lingkungan standar App Engine, penambahan kode hampir sama dengan penambahan kode untuk Compute Engine dan GKE. Ada satu pengecualian. Di kedua lingkungan App Engine, parameter Service dan ServiceVersion berasal dari lingkungan, sehingga Anda tidak perlu menentukannya.


// appengine is an example of starting cloud.google.com/go/profiler on
// App Engine.
package main

import (
	"cloud.google.com/go/profiler"
)

func main() {
	// Profiler initialization, best done as early as possible.
	if err := profiler.Start(profiler.Config{
		// Service and ServiceVersion can be automatically inferred when running
		// on App Engine.
		// ProjectID must be set if not running on GCP.
		// ProjectID: "my-project",
	}); err != nil {
		// TODO: Handle error.
	}
}

Saat Anda menjalankan aplikasi secara lokal, tetapkan parameter ProjectID (ID project Google Cloud) dan Service di profiler.Config, karena keduanya tidak dapat berasal dari lingkungan lokal. Anda tidak perlu menetapkan ServiceVersion.

Jika Anda menggunakan lingkungan standar App Engine, lihat Memigrasikan aplikasi ke Go 1.11 untuk mengetahui informasi mendetail tentang perubahan yang mungkin perlu dilakukan pada aplikasi Anda. Selain itu, Anda harus menggunakan Google Cloud CLI versi 226.0.0 atau yang lebih baru. Untuk mengupdate Google Cloud CLI, jalankan perintah berikut:

    gcloud components update

Untuk menjalankan aplikasi Anda:

  1. Perbarui dependensi:

    go get cloud.google.com/go/profiler

  2. Deploy aplikasi ke lingkungan fleksibel App Engine atau ke lingkungan standar App Engine Anda:

    gcloud app deploy [DEPLOYMENT]

    dengan DEPLOYMENT adalah jalur ke file konfigurasi Anda. Misalnya, DEPLOYMENT mungkin main/app.yaml.

Menganalisis data

Setelah Profiler mengumpulkan data, Anda dapat melihat dan menganalisis data ini menggunakan antarmuka Profiler.

Pada panel navigasi konsol Google Cloud, pilih Profiler:

Buka Profiler

Argumen nama dan versi layanan

Saat memuat agen Profiler, Anda menentukan argumen nama layanan dan argumen versi layanan opsional untuk mengonfigurasinya.

Nama layanan memungkinkan Profiler mengumpulkan data pembuatan profil untuk semua replika layanan tersebut. Layanan profiler memastikan kecepatan pengumpulan rata-rata satu profil per menit untuk setiap nama layanan di setiap kombinasi zona dan versi layanan.

Misalnya, jika Anda memiliki layanan dengan dua versi yang berjalan di replika dalam tiga zona, profiler akan membuat rata-rata 6 profil per menit untuk layanan tersebut.

Jika Anda menggunakan nama layanan yang berbeda untuk replika, layanan Anda akan diprofilkan lebih sering daripada yang diperlukan, dengan overhead yang sebetulnya lebih tinggi.

Saat memilih nama layanan:

  • Pilih nama yang secara jelas menggambarkan layanan dalam arsitektur aplikasi Anda. Pilihan nama layanan tidak begitu penting jika Anda hanya menjalankan satu layanan atau aplikasi. Akan lebih penting lagi jika aplikasi Anda berjalan sebagai sekumpulan layanan mikro.

  • Pastikan untuk tidak menggunakan nilai khusus proses apa pun, seperti ID proses, dalam string nama layanan.

  • String nama layanan harus cocok dengan ekspresi reguler ini:

    ^[a-z0-9]([-a-z0-9_.]{0,253}[a-z0-9])?$

Panduan yang baik adalah menggunakan string statis seperti imageproc-service sebagai nama layanan.

Versi layanan bersifat opsional. Jika Anda menentukan versi layanan, Profiler dapat menggabungkan informasi pembuatan profil dari beberapa instance dan menampilkannya dengan benar. Layanan ini dapat digunakan untuk menandai versi layanan Anda yang berbeda saat di-deploy. UI Profiler memungkinkan Anda memfilter data berdasarkan versi layanan; dengan cara ini, Anda dapat membandingkan performa kode versi lama dan baru.

Nilai argumen versi layanan adalah string bentuk bebas, tetapi nilai untuk argumen ini biasanya terlihat seperti nomor versi, misalnya 1.0.0 atau 2.1.2.

Logging agen

Agen pembuatan profil dapat melaporkan informasi debug dalam log-nya. Secara default, logging agen dinonaktifkan.

Untuk mengaktifkan logging agen, tetapkan opsi DebugLogging ke true saat memulai agen:

profiler.Start(profiler.Config{..., DebugLogging: true});

Pemecahan masalah

Bagian ini mencantumkan masalah yang spesifik untuk pembuatan profil aplikasi Go. Lihat Pemecahan masalah untuk mendapatkan bantuan terkait masalah umum.

Perilaku Penyebab Solusi
Profil waktu CPU tidak dikumpulkan untuk aplikasi yang di-build dengan -buildmode=c-archive. Profil heap, pertentangan, dan thread dikumpulkan. Masalah GitHub Secara default, pembuatan profil CPU tidak diaktifkan untuk aplikasi Go jika flag -buildmode adalah c-archive atau c-shared. Tambahkan panggilan ke
signal.Notify(make(
chan os.Signal), syscall.SIGPROF) sebelum memanggil profiler.Start.
Respons terhadap masalah GitHub.

Berjalan dengan Linux Alpine

Agen pembuatan profil Go untuk Linux Alpine hanya didukung untuk konfigurasi Google Kubernetes Engine.

Error autentikasi

Jika Anda menggunakan image Docker yang berjalan dengan Linux Alpine (seperti golang:alpine atau hanya alpine), Anda mungkin melihat error autentikasi berikut:

connection error: desc = "transport: authentication handshake failed: x509: failed to load system roots and no roots provided"

Perhatikan bahwa untuk melihat error, Anda harus mengaktifkan logging agen. Secara default, agen untuk Go tidak menampilkan pesan log apa pun.

Error ini menunjukkan bahwa image Docker dengan Linux Alpine tidak memiliki sertifikat SSL root yang diinstal secara default. Sertifikat tersebut diperlukan agar agen pembuatan profil dapat berkomunikasi dengan API profiler. Untuk mengatasi error ini, tambahkan perintah apk berikut ke Dockerfile Anda:

FROM alpine
...
RUN apk add --no-cache ca-certificates

Kemudian, Anda harus membangun ulang dan men-deploy ulang aplikasi Anda.

Langkah selanjutnya