Application Real-Time Monitoring Service:Konfigurasi kustom untuk aplikasi Go

Prasyarat

Probe harus telah diinstal pada aplikasi Anda. Untuk informasi selengkapnya, lihat Application Monitoring Integration Overview.

Prosedur

1. Masuk ke ARMS console. Di panel navigasi sebelah kiri, pilih Application Monitoring > Application List.

2. Pada halaman Application List, pilih wilayah di bilah navigasi atas, lalu klik nama aplikasi.

   Catatan

   Ikon pada kolom Language memiliki arti sebagai berikut:

   • : aplikasi Java yang terhubung ke Application Monitoring.

   • : aplikasi Golang yang terhubung ke Application Monitoring.

   • : aplikasi Python yang terhubung ke Application Monitoring.

   • -: aplikasi yang terhubung ke Managed Service for OpenTelemetry.

3. Di bilah navigasi atas, pilih Application Configuration > Custom Configurations.

4. Konfigurasikan parameter, lalu klik Save.

Pengaturan sampling

Pada bagian Sampling settings, Anda dapat mengatur kebijakan sampling untuk jejak (traces). Aplikasi Go saat ini hanya mendukung fixed-rate sampling. Anda juga dapat mengonfigurasi full sampling berdasarkan nama API, awalan (prefix), atau akhiran (suffix).

Sampling rate percentage default adalah 10. Meningkatkan laju sampling akan mengonsumsi sumber daya sistem tambahan, sehingga kami menyarankan Anda mempertahankan nilai default. Full sampling by API name hanya didukung oleh probe versi 1.5.2 ke atas. Setelah menyelesaikan konfigurasi, klik Save atau Save and Bulk Copy to Other Applications.

Toggle probe

Pada bagian Probe toggle settings, Anda dapat mengaktifkan atau menonaktifkan Application Monitoring serta mengaktifkan/menonaktifkan plugin individual.

Saat Anda mengaktifkan toggle Pause application monitoring, penagihan juga dijeda. Bagian Plugin toggles mencakup beberapa plugin seperti dubbo-plugin, mysql-plugin, redis-plugin, grpc-plugin, dan kafka-client-plugin. Untuk hertz-plugin, opentelemetry-plugin, dan opentracing-plugin, perubahan hanya berlaku setelah Anda melakukan restart aplikasi. Setelah melakukan perubahan, klik Save, atau klik Bulk Copy to Other Applications untuk menyinkronkan konfigurasi ke aplikasi lain.

Toggle runtime

Pada bagian Runtime toggle settings, Anda dapat mengaktifkan atau menonaktifkan fitur pemantauan Runtime. Untuk informasi selengkapnya, lihat Runtime monitoring.

Setelah mengonfigurasi pengaturan, klik Save, atau klik Save and Bulk Copy to Other Applications untuk menerapkan konfigurasi ke aplikasi lain.

Asosiasi log aplikasi

Pada bagian Application log association, Anda dapat mengonfigurasi sumber log aplikasi untuk menyisipkan SpanId dan TraceId ke dalam log yang sesuai. Untuk informasi selengkapnya, lihat Associate TraceId with business logs of Go applications.

Aktifkan toggle Automatically associate business logs with TraceId, lalu pada bagian Log Service binding, pilih wilayah, nama Project, tipe asosiasi (Logstore atau StoreView), nama Logstore, dan indeks terkait. Kemudian, klik Save. Untuk menerapkan konfigurasi ke aplikasi lain, klik Bulk Copy to Other Applications.

Konvergensi URL

Pada bagian URL convergence settings, Anda dapat mengaktifkan atau menonaktifkan fitur konvergensi URL serta mengonfigurasi ambang batas dan aturannya. Konvergensi URL mengelompokkan URL yang mirip dan menampilkannya sebagai satu item. Misalnya, serangkaian URL yang dimulai dengan /service/demo/ dapat ditampilkan sebagai satu entri agregat. Ambang batas konvergensi adalah jumlah minimum URL yang harus sesuai dengan suatu aturan sebelum dikonvergensikan. Misalnya, jika ambang batasnya 100, URL yang cocok dengan ekspresi reguler suatu aturan hanya akan dikonvergensikan setelah jumlah URL yang cocok mencapai 100. Untuk informasi selengkapnya, lihat ARMS convergence mechanism.

Aturan konvergensi harus dalam format ekspresi reguler. Contoh: /service/(.*?)/demo. Pisahkan beberapa aturan dengan koma (,). Setelah mengonfigurasi pengaturan, klik Save atau Save and Bulk Copy to Other Applications.

Profil kontinu

Pada bagian Continuous profiling settings, Anda dapat mengaktifkan atau menonaktifkan toggle global, hotspot CPU, hotspot memori, dan hotspot kode. Untuk informasi selengkapnya, lihat Continuous profiling for Go applications.

Anda juga dapat mengaktifkan/menonaktifkan goroutine hotspots (memerlukan probe versi 1.6.0 ke atas), blocking analysis, dan mutex analysis (memerlukan probe versi 1.6.1 ke atas). Setelah mengonfigurasi pengaturan, klik Save atau Bulk Copy to Other Applications.

Konfigurasi panggilan API

Pada bagian API call configuration, Anda dapat mengonfigurasi ambang batas panggilan lambat, daftar putih kode status HTTP, dan penyaringan panggilan API tidak valid.

Anda juga dapat mengonfigurasi pengaturan berikut: toggle untuk Enable printing HTTP request body dan Enable printing HTTP request header (memerlukan probe versi 1.5.0 ke atas), HTTP request body length (default 1024, memerlukan probe versi 1.4.0 ke atas), toggle Include TraceId in HTTP response (menambahkan kunci Eagleeye-TraceId ke header respons), toggle untuk Enable printing HTTP response body dan Enable printing HTTP response header (memerlukan probe versi 1.5.1 ke atas), HTTP response body length (default 1024), serta bidang teks untuk Write HTTP request header keys to Span dan Write HTTP response header keys to Span.

• Slow call threshold: Nilai default adalah 500 ms. Panggilan antarmuka ditandai sebagai lambat jika waktu responsnya melebihi ambang batas ini.

• HTTP status code whitelist:

  Secara default, kode status HTTP yang lebih besar dari 400 diklasifikasikan sebagai error. Untuk mencegah kode status tertentu diklasifikasikan sebagai error, tambahkan ke daftar putih.

  Pengaturan ini hanya berlaku untuk HTTP framework yang didukung oleh Application Monitoring.

  Data yang terpengaruh: Metrik jumlah error untuk server dan client HTTP (arms_http_requests_error_count, arms_http_client_requests_error_count, dan arms_app_requests_error_count), serta status Span.

  Fitur yang terpengaruh: Jumlah error pada tab Application Overview, Provided Services, dan Dependent Services. Status Span dan alert jumlah error pada halaman Trace Analysis.

  Format: Masukkan kode status individual yang dipisahkan dengan koma (,). Pencocokan fuzzy tidak didukung.

  Contoh: 403,502

  Default: Kosong

• Invalid API call filtering:

  Untuk menyembunyikan panggilan tertentu pada tab Provided Services, masukkan nama API yang ingin dikecualikan. Probe kemudian akan berhenti melaporkan data observasi untuk API tersebut, sehingga API tersebut tidak muncul di halaman panggilan API.

  Data yang terpengaruh: Semua metrik dan Span untuk API yang ditentukan diabaikan.

  Fitur yang terpengaruh: Semua metrik untuk API terkait pada tab Application Overview, Provided Services, dan Dependent Services. Jumlah Span, volume panggilan, jumlah error, dan alert panggilan lambat pada halaman Trace Analysis.

  Format: Gunakan string atau ekspresi AntPath untuk mencocokkan nama API lengkap. Pisahkan beberapa aturan dengan koma (,). (Ekspresi AntPath default disertakan untuk kompatibilitas mundur dengan data historis. Jangan hapus ekspresi tersebut. Tambahkan aturan baru setelah yang sudah ada.)

  Contoh: /api/test/*,/api/playground/create

  Default: /**/*.jpg,/**/*.png,/**/*.js,/**/*.jpeg,/**/*.pdf,/**/*.xlsx,/**/*.txt,/**/*.docs,/**/*.gif,/**/*.csv

• Enable printing HTTP request body: Saat diaktifkan, probe menambahkan field http.request.body ke Span client HTTP untuk merekam badan permintaan. Panjang tangkapan default adalah 1024.

• Enable printing HTTP request header: Saat diaktifkan, field http.request.header ditambahkan ke Span client HTTP untuk merekam header permintaan.

• HTTP body length: Panjang maksimum badan permintaan HTTP yang ditangkap. Panjang default adalah 1024.

• Include TraceId in HTTP response: Saat diaktifkan, probe menambahkan TraceId ke header respons dengan kunci Eagleeye-TraceId.

• Enable printing HTTP response body: Saat diaktifkan, probe menambahkan field http.response.body ke Span server HTTP untuk merekam badan respons.

• Enable printing HTTP response header: Saat diaktifkan, field http.response.header ditambahkan ke Span server HTTP untuk merekam header respons.

• HTTP response body length: Panjang maksimum badan respons HTTP yang ditangkap. Panjang default adalah 1024.

• Write HTTP request header keys to Span: Masukkan kunci header, dipisahkan dengan koma. Probe menambahkan field http.request.header.key ke Span client HTTP untuk setiap kunci yang ditentukan.

• Write HTTP response header keys to Span: Masukkan kunci header, dipisahkan dengan koma. Probe menambahkan field http.response.header.key ke Span server HTTP untuk setiap kunci yang ditentukan.

Penyaringan exception lanjutan

• Collect Plugin Exceptions: Menentukan apakah exception plugin dikumpulkan atau tidak.

• Exception Filter Whitelist: Jika Anda tidak ingin melihat exception tertentu pada tab Exception Analysis, masukkan nama exception yang ingin disembunyikan dari halaman tersebut.

Nonaktifkan switch Collect plugin exceptions untuk mencegah exception yang sama dicatat berulang kali. Pada bidang Exception filter whitelist, Anda dapat memasukkan beberapa nama exception yang dipisahkan dengan koma (,), misalnya *mysql.MySQLError. Exception yang sesuai dengan daftar putih tetap dicatat dalam Span. Fitur ini tersedia pada probe versi 2.3.1 ke atas.

Konfigurasi panggilan database

Pada bagian Database call configuration, Anda dapat mengonfigurasi ambang batas SQL lambat dan panjang maksimum pernyataan SQL yang dikumpulkan, serta menentukan apakah nilai variabel terikat dan nilai konstan ditampilkan dalam pernyataan SQL.

• Display bound variable values in SQL: Menangkap nilai variabel yang terikat ke parameter PreparedStatement. Perubahan berlaku tanpa perlu restart aplikasi.

• Display constant values in SQL: Hanya memotong pernyataan SQL tanpa pemrosesan tambahan. Perubahan berlaku tanpa perlu restart aplikasi.

Slow SQL threshold default adalah 500 ms. Kueri yang melebihi ambang batas ini ditandai sebagai kueri SQL lambat. Maximum SQL length default adalah 1024. Bagian pernyataan SQL yang melebihi batas ini akan dipotong. Fitur Display bound variable values in SQL hanya didukung untuk MySQL. Setelah mengonfigurasi pengaturan, klik Save atau Save and Bulk Copy to Other Applications.

Protokol propagasi jejak

Pada bagian Trace propagation protocol settings, Anda dapat memilih protokol propagasi jejak sesuai kebutuhan. Secara default, probe menggunakan protokol W3C. Anda juga dapat memilih Zipkin, Jaeger, atau EagleEye.

Versi probe 1.4.0 ke atas mendukung penggantian protokol. propagation mode mendukung mode Priority dan Forced. Dalam mode Priority, probe pertama-tama mencoba membaca header protokol yang dipilih. Jika header tidak ada, probe akan melanjutkan mendeteksi header protokol lainnya. Dalam mode Forced, jika header protokol yang dipilih tidak ada, probe akan menghasilkan konteks jejak baru sesuai spesifikasi protokol tersebut.

Pengumpulan probe

Pada bagian Probe collection configuration, Anda dapat mengatur jumlah maksimum jejak yang dikumpulkan per detik dan tingkat log probe.

Nilai default untuk Maximum traces per second adalah 100. Custom metric collection memerlukan probe versi 2.0.0 ke atas. Enable Span reporting memerlukan probe versi 1.8.3 ke atas. Span reporting name memerlukan probe versi 1.7.0 ke atas. Pisahkan beberapa kunci dengan koma (,). Default metric collection filtering memerlukan probe versi 2.3.0 ke atas.

Daftar berikut menjelaskan beberapa parameter:

• Custom Metric Collection: Mengontrol apakah agen mengumpulkan metrik yang didefinisikan dalam kode Anda dengan OTel SDK.

• Enable Span Reporting: Fitur ini diaktifkan secara default. Jika Anda menonaktifkan fitur ini, tidak ada Span yang dilaporkan.

• Span Reporting Name: Menentukan daftar putih nama Span yang akan dilaporkan. Jika bidang ini dikonfigurasi, hanya Span dengan nama yang sesuai yang dilaporkan.

• Custom metric collection configuration: Konfigurasikan nama cakupan metrik. Jika Anda tidak mengonfigurasi parameter ini, semua metrik kustom dikumpulkan secara default.

Default Metric Collection Filtering: Menyaring pelaporan jenis metrik tertentu. Anda dapat memilih satu atau beberapa jenis berikut:

• custom_entry: Metrik kustom untuk pemantauan metode.

• http: Metrik server HTTP.

• http_client: Metrik client HTTP.

• rpc: Metrik panggilan server RPC.

• rpc_client: Metrik panggilan client RPC.

• sql: Metrik akses database.

• nosql: Metrik akses layanan NoSQL.

• cache: Metrik akses layanan cache.

• producer: Metrik penerbitan pesan.

• consumer: Metrik konsumsi pesan.

• schedule: Metrik layanan penjadwalan.

Pengaturan lanjutan

Pada bagian Advanced settings, Anda dapat mengonfigurasi perhitungan persentil, sampling panggilan lambat dan error, serta panjang maksimum stack trace yang dikumpulkan.

Nilai default untuk Stack trace collection length adalah 4096. Setelah mengonfigurasi pengaturan, klik Save atau Save and Bulk Copy to Other Applications.

Salin konfigurasi ke aplikasi lain

Jika Anda perlu menerapkan konfigurasi yang sama ke aplikasi lain, Anda dapat menyalin pengaturan tersebut.

Konfigurasi default global

Anda dapat menyimpan konfigurasi saat ini sebagai konfigurasi default global. Konfigurasi ini kemudian akan diterapkan secara default saat Anda membuat aplikasi baru.

1. Di bagian bawah halaman, klik Save Current App Settings as Global Default Configuration.

2. Jika muncul kotak dialog Current settings not saved, klik OK untuk menyimpan konfigurasi untuk aplikasi saat ini, lalu klik Save Current App Settings as Global Default Configuration lagi.

3. Pada kotak dialog yang muncul, klik Confirm.