Konfigurasi analisis log untuk mengasosiasikan log SLS dengan ID trace - Application Real-Time Monitoring Service

Saat sebuah aplikasi melemparkan exception atau berperilaku tidak sesuai harapan, log merupakan jalur tercepat menuju akar permasalahan. Application Real-Time Monitoring Service (ARMS) menghubungkan log aplikasi yang disimpan di Simple Log Service (SLS) dengan ID jejak terdistribusi. Setelah dikonfigurasi, Anda dapat langsung melompat dari jejak ke entri log yang direkam selama permintaan tersebut atau mencari log berdasarkan ID jejak untuk menemukan jalur eksekusi yang tepat.

Penting

Pemantauan Aplikasi menyediakan halaman detail aplikasi baru bagi pengguna yang telah mengaktifkan mode penagihan baru. Untuk informasi selengkapnya, lihat Penagihan (baru). Jika Anda belum mengaktifkan mode penagihan baru, klik Switch to New Version pada halaman Application List untuk mengakses antarmuka baru.

Cara kerja

Setelah Anda mengaitkan Logstore SLS ke aplikasi ARMS, ARMS menyisipkan ID jejak ke dalam log aplikasi melalui framework logging. Setiap entri log diberi tag dengan ID jejak dari permintaan yang menghasilkannya. Hal ini memungkinkan dua alur kerja:

Jejak ke log: Buka jejak di Trace Explorer dan lihat semua entri log yang dihasilkan selama permintaan tersebut.
Log ke jejak: Cari log berdasarkan ID jejak untuk menemukan jejak terdistribusi dari entri log tertentu.

Catatan

ARMS tidak mengumpulkan log ke dalam Logstore. Konfigurasikan pengumpulan log secara terpisah di SLS. Untuk informasi selengkapnya, lihat Ikhtisar pengumpulan data.

Framework logging yang didukung

Penyisipan ID jejak otomatis berfungsi dengan framework logging Java berikut:

log4j
log4j2
Logback

Jika aplikasi Anda menggunakan framework logging lain, penyisipan otomatis tidak didukung. Lihat Mengambil ID jejak secara manual untuk pendekatan alternatif.

Kapan ID jejak tersedia

Konteks jejak hanya ada pada titik masuk permintaan. Log yang dicetak di luar konteks ini tidak dapat dikaitkan dengan ID jejak.

Skenario	ID jejak tersedia?	Alasan
Aplikasi menerima permintaan HTTP, menjalankan kueri database, dan mencetak log	Ya	Titik masuk HTTP membuat konteks jejak
Permintaan HTTP memicu tugas asinkron melalui kolam thread untuk menjalankan kueri database dan mencetak log (agen v4.x)	Ya	v4.x menyebarkan konteks jejak di antara thread asinkron
Permintaan HTTP memicu tugas asinkron melalui kolam thread untuk menjalankan kueri database dan mencetak log (agen v3.x)	Tidak	v3.x tidak menyebarkan konteks jejak di antara thread asinkron
Aplikasi menggunakan kolam thread JDK untuk menjalankan kueri database berkala saat startup	Tidak	Tidak ada titik masuk permintaan

Catatan

Periksa nama thread dalam entri log untuk menentukan skenario yang berlaku. Thread Tomcat diawali dengan http-nio- dan thread Dubbo diawali dengan DubboServerHandler-. Log dari thread-thread ini seharusnya memiliki ID jejak.

Prasyarat

Sebelum memulai, pastikan Anda telah memiliki:

Aplikasi yang dipantau oleh ARMS. Untuk informasi selengkapnya, lihat Ikhtisar Pemantauan Aplikasi.
Simple Log Service diaktifkan. Masuk ke Konsol Simple Log Service dan ikuti petunjuk di layar.
Proyek SLS.
Logstore.
Data jejak dikumpulkan dan diimpor ke SLS. Untuk informasi selengkapnya, lihat Ikhtisar pengumpulan data.

Langkah 1: Mengaitkan log bisnis dengan ID jejak

Masuk ke Konsol ARMS. Di panel navigasi kiri, pilih Application Monitoring > Application List.
Pada halaman Application List, pilih wilayah di bilah navigasi atas, lalu klik nama aplikasi.
Catatan
Kolom Language menampilkan bahasa yang digunakan setiap aplikasi:
- : Java
- : Go
- : Python
- Tanda hubung (-): Aplikasi yang dipantau di Managed Service for OpenTelemetry
Di bilah navigasi atas, pilih Configuration > Custom Configurations.
Pada bagian Application log Association configuration, konfigurasikan pengaturan berikut:
- Atur Log Source ke Log service SLS.
- Aktifkan Automatically associate business logs with TraceId.
- Pilih wilayah, proyek, dan Logstore tempat log aplikasi Anda disimpan.
Klik Save.

Langkah 2: Mencari dan menganalisis log

Di bilah navigasi atas, pilih Scenario-based Analysis > Log Analysis.
Masukkan pernyataan kueri di kotak pencarian. Pernyataan kueri terdiri dari pernyataan pencarian dan pernyataan analitik dalam format Pernyataan pencarian|Pernyataan analitik. Untuk detail sintaksis, lihat Sintaksis pencarian dan Fungsi agregat.
Tentukan rentang waktu. Tetapkan waktu mulai dan waktu akhir dalam satuan jam atau hingga detik. Anda juga dapat menetapkan rentang waktu relatif tanpa menentukan waktu mulai atau waktu akhir.
Catatan
Hasil kueri mungkin mencakup log yang dihasilkan hingga 1 menit sebelum atau sesudah rentang waktu yang ditentukan.
Klik Search & Analyze untuk melihat hasilnya.

Mengambil ID jejak secara manual

Jika penyisipan ID jejak otomatis tidak berfungsi dengan framework logging Anda, ambil ID jejak secara pemrograman menggunakan ARMS SDK untuk Java dan sertakan dalam pesan log Anda:

Span span = Tracer.builder().getSpan();   // Tidak ada span baru yang dibuat.
String traceId = span.getTraceId();

logger.warn("traceId={} this is your log message", traceId);

FAQ

Mengapa ID jejak tidak muncul di log saya setelah saya memperbarui konfigurasi XML?

Pertama, verifikasi bahwa log telah sampai ke Logstore SLS Anda dan bahwa proyek serta Logstore yang benar dipilih di bawah Application log Association configuration di Konsol ARMS.

Jika log ada di SLS tetapi ID jejak tidak muncul, akar permasalahannya bergantung pada cakupan masalah tersebut.

Semua log tidak memiliki ID jejak

Periksa penyebab berikut secara berurutan (yang paling umum terlebih dahulu):

Agen ARMS tidak dipasang. Pastikan metrik aplikasi ditampilkan secara normal di Konsol ARMS.
Agen atau plug-in dinonaktifkan. Buka halaman detail aplikasi dan periksa bagian Probe switch settings pada tab Custom Configurations. Pastikan sakelar utama dan plug-in terkait (misalnya, plug-in Tomcat) diaktifkan.
Framework server Anda tidak didukung. Kontainer web, framework RPC, framework tugas terjadwal, atau framework pesan yang tidak didukung mencegah penyisipan ID jejak. Lihat Komponen dan framework Java yang didukung ARMS untuk daftar kompatibilitas lengkap.
Framework logging Anda tidak didukung. Hanya log4j, log4j2, dan Logback yang didukung. Modifikasi mendalam terhadap framework ini juga dapat mengganggu penyisipan.
Konfigurasi XML log mengandung kesalahan. Untuk mengisolasi masalah ini:
- Pada agen v4.1.6 atau yang lebih baru, aktifkan pengisian ID jejak otomatis. Jika ID jejak muncul, masalahnya ada pada konfigurasi XML Anda.
- Gunakan ARMS SDK untuk mengambil ID jejak secara manual (lihat Mengambil ID jejak secara manual). Jika ID jejak dikembalikan, konfigurasi XML adalah penyebabnya.
- Jika kedua pendekatan tersebut tidak berhasil, kirim tiket.

Beberapa log tidak memiliki ID jejak

Konteks jejak hanya ada pada titik masuk permintaan—antarmuka HTTP, antarmuka RPC, tugas terjadwal, dan konsumsi pesan. Log yang dicetak di luar konteks ini (misalnya, selama operasi latar belakang umum) tidak dapat dikaitkan dengan ID jejak. Lihat Kapan ID jejak tersedia untuk penjelasan rinci.

Jika skenario tersebut tidak menjelaskan masalah Anda, kirim tiket.

Mengapa log kosong saat saya melihatnya dari Trace Explorer?

Periksa apakah semua log untuk aplikasi tidak memiliki ID jejak. Jika ya, lihat FAQ sebelumnya.
Jika hanya antarmuka tertentu yang tidak memiliki log, kemungkinan antarmuka tersebut tidak menghasilkan output log secara internal.
Jika kedua penjelasan tersebut tidak berlaku, kirim tiket.

Mengapa Logstore tidak memiliki log setelah saya mengaitkannya ke proyek?

ARMS tidak mengumpulkan log ke dalam Logstore untuk Anda. Konfigurasikan pengumpulan log aplikasi secara terpisah di SLS dengan mengikuti dokumentasi SLS.

Mengapa log aplikasi gagal dikaitkan dengan ID jejak sedangkan log bisnis berhasil?

Agen v3.x memiliki masalah yang diketahui dalam instrumentasi Spring Cloud Gateway. Tingkatkan ke agen v4.x untuk mengatasi masalah ini.

Mengapa log dalam tugas asinkron gagal dikaitkan dengan ID jejak setelah saya membungkusnya dengan TraceCallable.wrap()?

Tingkatkan ke agen v4.x. Agen v4.x menyebarkan konteks jejak di antara thread asinkron secara otomatis, tanpa perubahan kode yang diperlukan.

Mengapa pengaitan ID jejak gagal setelah saya mengaktifkan pengisian ID jejak otomatis?

Semua log terpengaruh: Konfigurasi gagal mencapai agen. Periksa konektivitas server Application Configuration Management (ACM). Untuk informasi selengkapnya, lihat Konfigurasi jaringan yang diperlukan oleh agen ARMS untuk Java.
Beberapa log terpengaruh: Lihat Mengapa ID jejak tidak muncul di log saya setelah saya memperbarui konfigurasi XML?.