Topik ini menjelaskan cara mengonfigurasi analisis tracing di konsol API Gateway untuk mengunggah log tracing ke Alibaba Cloud Managed Service for OpenTelemetry. Managed Service for OpenTelemetry menyediakan alat yang membantu memetakan jejak panggilan layanan, menghitung jumlah permintaan, mendapatkan topologi jejak, dan menganalisis dependensi aplikasi. Alat ini mendukung pengembangan layanan secara efisien serta penyelesaian masalah. Fitur analisis tracing hanya tersedia untuk instance khusus.
Prasyarat
Gunakan instance khusus dari API Gateway.
1. Berikan izin kepada Managed Service for OpenTelemetry
1.1 Masuk ke konsol Managed Service for OpenTelemetry.
1.2 Di halaman Overview, klik Authorize Now untuk memberikan otorisasi kepada Managed Service for OpenTelemetry agar dapat membaca dan menulis data Simple Log Service Anda.
1.3 Di halaman Cloud Resource Access Authorization, pilih izin yang diperlukan dan klik Confirm Authorization Policy.
1.4 Setelah izin diberikan, lakukan langkah berikut untuk melihat titik akhir: Di halaman Overview, klik tab Access process. Pada tab tersebut, klik View access point information. Aktifkan opsi Show Token dan pilih Jaeger untuk parameter Client. Simpan titik akhir yang ditampilkan di bagian Reporting through HTTP.
2. Konfigurasikan analisis tracing di konsol API Gateway
2.1 Masuk ke konsol API Gateway.
2.2 Di panel navigasi sisi kiri, pilih Manage APIs > API Groups. Klik nama grup API yang ingin Anda kelola untuk pergi ke halaman Group Details. Di bagian Custom Log Tracing, konfigurasikan parameter yang relevan.
Posisi Field Tracing: Tentukan lokasi field yang dilacak. Nilai valid: Header dan Query.
Nama Field Tracing: Tentukan nama field yang dilacak.
Field yang dilacak dibuat oleh klien. API Gateway meneruskan field tersebut ke layanan backend dan mencatatnya di bidang CustomTraceId. API Gateway menggunakan nilai dari field tersebut sebagai ID jejak untuk melaporkan log ke Analisis Tracing. Nilai field harus dalam format TraceId standar, yaitu angka heksadesimal 16-bit atau 32-bit.
Jika klien tidak membuat field yang dilacak atau nilainya tidak valid, API Gateway akan menghasilkan ID jejak acak untuk melaporkan log ke Analisis Tracing.
Teruskan atau Hasilkan Header Terkait EagleEye (Eagleeye-Rpcid, Eagleeye-Traceid, atau Eagleeye-Sampled): Jika kotak centang dipilih, API Gateway meneruskan header terkait EagleEye yang dikirim oleh klien ke layanan backend. Jika tidak ada header seperti itu yang dikirim, API Gateway menghasilkan header dan meneruskannya ke layanan backend. Parameter ini berlaku untuk instance bersama, serverless, dan khusus.
Teruskan atau Hasilkan Header Propagasi B3 (X-B3-traceid, X-B3-Parentspanid, X-B3-Spanid, atau X-B3-Sampled): Jika kotak centang dipilih, API Gateway meneruskan parameter header terkait B3 yang dikirim oleh klien ke layanan backend. Jika tidak ada parameter header seperti itu yang dikirim, API Gateway menghasilkan parameter dan meneruskannya ke layanan backend. Parameter ini berlaku untuk instance bersama, serverless, dan khusus.
Unggah Log Jejak ke Alibaba Cloud Tracing Analysis (Hanya untuk instance khusus):
Nama Aplikasi: Tentukan nama aplikasi yang ingin dikonfigurasi untuk analisis tracing.
Arms Endpoint: Masukkan titik akhir yang diperoleh di "Bagian 1.4". Jika layanan diterapkan di wilayah yang sama, gunakan titik akhir privat untuk efisiensi lebih tinggi.
Strategi Sampling Log: Pilih opsi sesuai kebutuhan. Nilai valid: Unggah semua, Unggah persentase, dan Unggah jumlah tetap per detik.
Setelah analisis tracing dikonfigurasi di konsol API Gateway, Anda dapat melihat jejak permintaan di konsol Analisis Tracing.
Untuk informasi lebih lanjut tentang cara menggunakan Analisis Tracing, lihat Panggilan API.