Halaman ini akan memandu Anda melakukan langkah-langkah berikut:
- Instal paket OpenTelemetry.
- Konfigurasi aplikasi Anda untuk mengekspor span ke Cloud Trace.
- Konfigurasi platform Anda.
Untuk informasi rilis, lihat referensi berikut:
Untuk konten referensi OpenTelemetry, lihat hal berikut:
Untuk detail terbaru tentang OpenTelemetry for Go, beserta dokumentasi dan contoh tambahan, lihat OpenTelemetry.
Sebelum memulai
-
Di panel navigasi Konsol Google Cloud, pilih APIs & Services, klik Enable APIs and Services, lalu aktifkan Cloud Trace API:
Jika API enabled ditampilkan, berarti API sudah diaktifkan. Jika belum, klik tombol Enable.
Menginstal, menginisialisasi, dan menggunakan klien
Lihat petunjuk berikut untuk melengkapi aplikasi Go Anda di Compute Engine dan Google Kubernetes Engine. Untuk contoh umum penggunaan OpenTelemetry, lihat repositori GitHub OpenTelemetry untuk Go.
Compute Engine
Instal paket OpenTelemetry:
go get go.opentelemetry.io/otel
go get github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/trace
Impor paket ekspor OpenTelemetry dan Cloud Trace:
Buat pengekspor dan penyedia rekaman aktivitas:
Saat membuat pengekspor, Anda memberikan informasi tentang ID project Google Cloud Anda. Dalam contoh ini, ID disimpan dalam variabel lingkungan GOOGLE_CLOUD_PROJECT
.
Aplikasi contoh memanggil fungsi WithBatcher
untuk mengonfigurasi penyedia perekaman aktivitas agar mengirim span ke Cloud Monitoring dengan menggunakan proses latar belakang.
Contoh ini juga dikonfigurasi untuk memanggil fungsi Shutdown
pengekspor saat keluar dari aplikasi. Saat dijalankan, Shutdown
akan mengirimkan semua span yang tertunda ke Cloud Monitoring. Konfigurasi yang ditampilkan dalam contoh adalah penerapan yang direkomendasikan untuk semua lingkungan operasi, termasuk untuk Cloud Run tempat container dapat dimatikan kapan saja.
Saat membuat instance Tracer
, Anda memberinya nama.
Dalam contoh, namanya adalah example.com/trace
. Sebaiknya
beri nama instance ini setelah komponen dilacak karena strategi ini
memungkinkan Anda memiliki beberapa instance.
Saat contoh dijalankan, satu rekaman aktivitas bernama foo
akan dibuat.
GKE
Tambahkan kode berikut ke Dockerfile
Anda:
RUN go get go.opentelemetry.io/otel
RUN go get github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/trace
Impor paket ekspor OpenTelemetry dan Cloud Trace:
Buat pengekspor dan penyedia rekaman aktivitas:
Saat membuat pengekspor, Anda memberikan informasi tentang ID project Google Cloud Anda. Dalam contoh ini, ID disimpan dalam variabel lingkungan GOOGLE_CLOUD_PROJECT
.
Aplikasi contoh memanggil fungsi WithBatcher
untuk mengonfigurasi penyedia perekaman aktivitas agar mengirim span ke Cloud Monitoring dengan menggunakan proses latar belakang.
Contoh ini juga dikonfigurasi untuk memanggil fungsi Shutdown
pengekspor saat keluar dari aplikasi. Saat dijalankan, Shutdown
akan mengirimkan semua span yang tertunda ke Cloud Monitoring. Konfigurasi yang ditampilkan dalam contoh adalah penerapan yang direkomendasikan untuk semua lingkungan operasi, termasuk untuk Cloud Run tempat container dapat dimatikan kapan saja.
Saat membuat instance Tracer
, Anda memberinya nama.
Dalam contoh, namanya adalah example.com/trace
. Sebaiknya
beri nama instance ini setelah komponen dilacak karena strategi ini
memungkinkan Anda memiliki beberapa instance.
Saat contoh dijalankan, satu rekaman aktivitas bernama foo
akan dibuat.
Cara membuat span kustom
Anda dapat menambahkan informasi tambahan ke pelacakan yang dibuat sistem dengan membuat span kustom.
Untuk membuat span kustom dengan nama foo
, tambahkan kode berikut ke kode
sumber:
Di sini, example.com/trace
mengacu pada nama instance tracer.
Konfigurasi platform Anda
Anda dapat menggunakan Cloud Trace di Google Cloud dan platform lainnya.
Berjalan di Google Cloud
Saat aplikasi Anda berjalan di Google Cloud, Anda tidak perlu memberikan kredensial autentikasi dalam bentuk akun layanan ke library klien. Namun, Anda harus memastikan bahwa platform Google Cloud Anda telah mengaktifkan cakupan akses Cloud Trace API.
Untuk mengetahui daftar lingkungan Google Cloud yang didukung, lihat Dukungan lingkungan.
Untuk konfigurasi berikut, setelan cakupan akses default akan mengaktifkan Cloud Trace API:
- Lingkungan fleksibel App Engine
Lingkungan standar App Engine
Google Kubernetes Engine (GKE)
Compute Engine
Cloud Run
Jika menggunakan cakupan akses kustom, Anda harus memastikan cakupan akses API Cloud Trace diaktifkan:
Untuk mengetahui informasi cara mengonfigurasi cakupan akses untuk lingkungan Anda menggunakan Konsol Google Cloud, lihat Mengonfigurasi project Google Cloud.
Untuk pengguna
gcloud
, tentukan cakupan akses menggunakan flag--scopes
dan sertakan cakupan akses Cloud Trace APItrace.append
. Misalnya, untuk membuat cluster GKE dengan hanya Cloud Trace API yang diaktifkan, lakukan hal berikut:gcloud container clusters create example-cluster-name --scopes=https://www.googleapis.com/auth/trace.append
Berjalan secara lokal dan di tempat lain
Jika aplikasi Anda berjalan di luar Google Cloud, Anda harus memberikan kredensial autentikasi dalam bentuk akun layanan ke library klien. Akun layanan harus berisi peran agen Cloud Trace. Untuk mengetahui petunjuknya, lihat Membuat akun layanan.
Library klien Google Cloud menggunakan Kredensial Default Aplikasi (ADC) untuk menemukan kredensial aplikasi Anda.
Anda dapat memberikan kredensial ini dengan salah satu dari tiga cara:
Jalankan
gcloud auth application-default login
Tempatkan akun layanan di jalur default untuk sistem operasi Anda. Berikut ini daftar jalur default untuk Windows dan Linux:
Windows:
%APPDATA%/gcloud/application_default_credentials.json
Linux:
$HOME/.config/gcloud/application_default_credentials.json
Tetapkan variabel lingkungan
GOOGLE_APPLICATION_CREDENTIALS
ke jalur ke akun layanan Anda:
Linux/macOS
export GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key
Windows
set GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key
PowerShell:
$env:GOOGLE_APPLICATION_CREDENTIALS="path-to-your-service-accounts-private-key"
Lihat pelacakan
Di panel navigasi konsol Google Cloud, pilih Trace, lalu pilih Trace explorer:
Pemecahan masalah
Untuk mengetahui informasi tentang cara memecahkan masalah terkait Cloud Trace, buka halaman Pemecahan masalah.