SaveTraceAppConfig - Application Real-Time Monitoring Service

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
Pid	string	Yes	ID aplikasi. Pada halaman Pemantauan Aplikasi (Application Monitoring) > Daftar Aplikasi (Application List) dari konsol ARMS, klik nama aplikasi target. URL di bilah alamat browser berisi pid aplikasi dalam format pid=xxx. Karena browser melakukan pengkodean URL, Anda harus sedikit memodifikasi pid. Misalnya, jika pid yang terdapat dalam URL adalah xxx%4074xxx, Anda harus mengganti %40 dengan @. Hasilnya adalah xxx@74xxx.	a2n80plglh@745eddxxx
Settings	array<object>	No	Daftar pengaturan kustom.
	object	No	Daftar pengaturan kustom.
Key	string	No	Pengaturan kustom. Untuk detail tentang setiap pengaturan, lihat deskripsi tambahan di bawah.	sampling.enable
Value	string	No	Pengaturan kustom. Untuk detail tentang setiap pengaturan, lihat deskripsi tambahan di bawah.	true

Pengaturan sampling

Key	Deskripsi bidang	Nilai
sampling.rate	Tingkat sampling rasio tetap	Nilai antara 0~100. Default: 10.
sampling.useSamplingStrategyV2	Apakah akan menggunakan sampling adaptif	Nilai valid: - true: Aktifkan sampling adaptif. - false (default): Nonaktifkan sampling adaptif.
sampling.v2config.spanNames4FullSampleStr	Nama antarmuka sampling penuh	Contoh: "/api/v1/user".
sampling.v2config.spanNamePrefixes4FullSampleStr	Awalan nama antarmuka sampling penuh	-
sampling.v2config.spanNameSuffixes4FullSampleStr	Akhiran nama antarmuka sampling penuh	-

Pengaturan sakelar agen

Key	Deskripsi bidang	Nilai
enable	Sakelar agen	Nilai valid: - true: Aktifkan pemantauan. - false (default): Nonaktifkan pemantauan.
akka.enable	Sakelar plug-in	Nilai valid: - true (default) - false
cassandra.enable	Sakelar plug-in	Nilai valid: - true (default) - false
dubbo.enable	Sakelar plug-in	Nilai valid: - true (default) - false
elasticsearch.enabled	Sakelar plug-in	Nilai valid: - true (default) - false
elasticjob.enable	Sakelar plug-in	Nilai valid: - true (default) - false
googlehttpclient.enable	Sakelar plug-in	Nilai valid: - true (default) - false
grpc.enable	Sakelar plug-in	Nilai valid: - true (default) - false
hsf.enable	Sakelar plug-in	Nilai valid: - true (default) - false
httpclient3.enable	Sakelar plug-in	Nilai valid: - true (default) - false
httpclient4.enable	Sakelar plug-in	Nilai valid:- true (default) - false
influxdb.enable	Sakelar plug-in	Nilai valid: - true (default) - false
jdbc.druid.enable	Sakelar plug-in	Nilai valid: - true (default) - false
jdbc.hikaricp.enable	Sakelar plug-in	Nilai valid: - true (default) - false
jdkhttp.enable	Sakelar plug-in	Nilai valid: - true (default) - false
jetty.enable	Sakelar plug-in	Nilai valid: - true (default) - false
liberty.enable	Sakelar plug-in	Nilai valid: - true (default) - false
mongodb.enable	Sakelar plug-in	Nilai valid: - true (default) - false
memcached.enable	Sakelar plug-in	Nilai valid: - true (default) - false
mysql.enable	Sakelar plug-in	Nilai valid: - true (default) - false
netty.enable	Sakelar plug-in	Nilai valid: - true (default) - false
okhttp.enable	Sakelar plug-in	Nilai valid: - true (default) - false
oracle.enable	Sakelar plug-in	Nilai valid: - true (default) - false
postgresql.enable	Sakelar plug-in	Nilai valid: - true (default) - false
play.enable	Sakelar plug-in	Nilai valid: - true (default) - false
quartz.enable	Sakelar plug-in	Nilai valid: - true (default) - false
redis.enable	Sakelar plug-in	Nilai valid: - true (default) - false
redis.redisson.enable	Sakelar plug-in	Nilai valid: - true (default) - false
lettuce.enable	Sakelar plug-in	Nilai valid: - true (default) - false
reactor.enable	Sakelar plug-in	Nilai valid: - true (default) - false
rabbitmq.client.enable	Sakelar plug-in	Nilai valid: - true (default) - false
kafka.enable	Sakelar plug-in	Nilai valid: - true (default) - false
onsclient.enable	Sakelar plug-in	Nilai valid: - true (default) - false
rxjava.enable	Sakelar plug-in	Nilai valid: - true (default) - false
schedulerx.enable	Sakelar plug-in	Nilai valid: - true (default) - false
servlet.enable	Sakelar plug-in	Nilai valid: - true (default) - false
spring.enable	Sakelar plug-in	Nilai valid: - true (default) - false
springBean.enable	Sakelar plug-in	Nilai valid: - true (default) - false
tomcat.enable	Sakelar plug-in	Nilai valid: - true (default) - false
vertx.enable	Sakelar plug-in	Nilai valid: - true (default) - false
weblogic.enable	Sakelar plug-in	Nilai valid: - true (default) - false
undertow.enable	Sakelar plug-in	Nilai valid: - true (default) - false
motan.enable	Sakelar plug-in	Nilai valid: - true (default) - false
ning.asynchttpclient.enable	Sakelar plug-in	Nilai valid: - true (default) - false
xxljob.enable	Sakelar plug-in	Nilai valid: - true (default) - false
mybatis.enable	Sakelar plug-in	Nilai valid: - true (default) - false

Konfigurasi asosiasi log aplikasi

Key	Deskripsi bidang	Nilai
logging.enable	Sakelar untuk mengaitkan log bisnis dengan TraceId	Nilai valid: - true (default): Aktifkan sakelar untuk mengaitkan log bisnis dengan TraceId. - false: Nonaktifkan sakelar untuk mengaitkan log bisnis dengan TraceId. Setelah diaktifkan, TraceId dari trace akan otomatis dihasilkan dalam log bisnis.
logging.injectTraceId2Log.enable	Apakah akan menyuntikkan TraceId secara otomatis ke dalam log pengguna	Nilai valid: - true - false (default)
logging.injectSpanId2Log.enable	Apakah akan menyuntikkan SpanId secara otomatis ke dalam log pengguna	Nilai valid: - true - false (default)
logging.inject2MDC.enable	Apakah akan menempatkan konteks trace ke dalam MDC pengguna	Nilai valid: - true - false (default)
SLS.bindType	Jenis asosiasi	Nilai valid: - logstore - storeview
SLS.project	Project log bisnis di region saat ini	Project log bisnis di region saat ini.
SLS.logStore	Logstore log bisnis di region saat ini	Logstore log bisnis di region saat ini.
SLS.index	Indeks terkait dari log bisnis di region saat ini	Nilai valid: - Ketika indeks teks lengkap ditentukan, jangan teruskan parameter ini. - Ketika indeks bidang ditentukan, nilainya adalah nama bidang yang sesuai. Misalnya: SLS.index: tag. Untuk perbedaan antara indeks bidang dan indeks teks lengkap, lihat Konfigurasi indeks.
SLS.storeView	Nama StoreView	StoreView dari log bisnis di region saat ini.

Pengaturan konvergensi URL

Key	Deskripsi bidang	Nilai
convergence.enable	Konvergensi URL	Nilai valid: - true (default): Aktifkan konvergensi URL. - false: Nonaktifkan konvergensi URL.
convergence.minServerSize	Ambang konvergensi	Default: 1000. Konvergensi dilakukan jika jumlah melebihi ambang ini.
convergence.pattern	Ekspresi reguler aturan konvergensi	Anda dapat menggunakan ekspresi reguler untuk mengatur aturan konvergensi. Beberapa ekspresi reguler dipisahkan dengan koma (,). Memasukkan URL asli secara langsung berarti URL ini tidak dikonvergensi. Contoh: /service/(.*?)/demo.

Pemantauan Arthas

Key	Deskripsi bidang	Nilai
arthas.enable	Sakelar Arthas	Nilai valid: - true (default): Aktifkan sakelar Arthas. - false: Nonaktifkan sakelar Arthas.
arthas.enableIps	IP yang berlaku secara real-time	Konfigurasikan IP untuk mengaktifkan diagnostik Arthas. Jika ditentukan, diagnostik Arthas hanya berlaku untuk IP tertentu. Jika dibiarkan kosong, secara default berlaku untuk semua IP. Pisahkan beberapa IP dengan koma (,).

Pengaturan profiling berkelanjutan

Key	Deskripsi bidang	Nilai
cp.enable	Sakelar profiling berkelanjutan	Nilai valid: - true: Aktifkan profiling berkelanjutan. - false: Nonaktifkan profiling berkelanjutan. Setelah sakelar ini diaktifkan, Anda perlu mengkonfigurasi IP atau segmen jaringan yang berlaku.
cp.cpuEnable	Apakah akan mengaktifkan hotspot CPU	Nilai valid: - true - false
cp.cpuInterval	Frekuensi sampling. Pengumpulan stack metode hotspot CPU dilakukan setiap kali waktu CPU yang dikonsumsi oleh eksekusi thread mencapai ambang. Berlaku dari agen versi 4.x.	Rentang nilai: 1~1000ms. Nilai default: 10ms.
cp.allocEnable	Apakah akan mengaktifkan hotspot memori	Nilai valid: - true - false
cp.allocInterval	Ambang sampling. Pengumpulan stack metode hotspot memori dilakukan setiap kali thread meminta ukuran heap memory yang sesuai. Berlaku dari agen versi 4.x.	Rentang nilai: 256~10240KB. Nilai default: 1024KB.
cp.wallClockEnable	Apakah akan mengaktifkan hotspot kode	Nilai valid: - true - false
cp.wallClockInterval	Frekuensi sampling. Pengumpulan stack metode hotspot kode dilakukan setiap kali thread berjalan selama durasi terkait. Berlaku dari agen versi 4.x.	Rentang nilai: 1~1000ms. Nilai default: 10ms.
cp.allowIPs	IP yang berlaku. Tentukan alamat IP yang berlaku. Pisahkan beberapa IP dengan koma.	Contoh: 10.10.1.1,10.10.1.2
cp.allowNetwork	Segmen jaringan yang berlaku. Agen versi 3.2.x+ mendukung alamat 0.0.0.0/0.	Contoh: 192.0.0.0/8

Pengaturan desensitisasi informasi

Key	Deskripsi bidang	Nilai
sanitizer.enable	Sakelar desensitisasi informasi	Nilai valid: - true (default): Aktifkan sakelar desensitisasi informasi. - false: Nonaktifkan sakelar desensitisasi informasi.
sanitizer.keys	Aturan desensitisasi	Secara default, aturan seperti contoh didukung. Kunci dicocokkan secara langsung. Mengambil password sebagai contoh, aturannya setara dengan ekspresi reguler .password., yang tidak peka terhadap huruf besar/kecil. Beberapa aturan dipisahkan dengan koma. Contoh: password,secret,key,token,credentials

Konfigurasi panggilan antarmuka

Key	Deskripsi bidang	Nilai
thresholds.interface	Ambang panggilan lambat	Default: 500, unit: ms. Ketika waktu respons antarmuka lebih besar dari ambang ini, antarmuka ditandai sebagai panggilan lambat.
error.skip	Penyaringan kode kesalahan. Kode status HTTP yang dikonfigurasi tidak akan dihitung sebagai panggilan kesalahan.	Contoh nilai: "404,403".
defined.excludeurl	Penyaringan panggilan antarmuka yang tidak valid	Mendukung pemisahan beberapa panggilan antarmuka dengan koma (,). Contoh: /service/taobao,/service/status.
metrics.prpc.enable	Apakah metrik panggilan antarmuka mencatat nama antarmuka hulu	Nilai valid: - true (default) - false
metrics.ppid.enable	Apakah metrik panggilan antarmuka mencatat nama aplikasi hulu	Nilai valid: - true (default) - false
http.metrics.recordHttpCode	Apakah metrik panggilan antarmuka mencatat kode status asli	Nilai valid: - true - false (default)

Konfigurasi panggilan database

Key	Deskripsi bidang	Nilai
thresholds.sql	Ambang SQL lambat. Ketika waktu yang dikonsumsi oleh kueri SQL lebih besar dari ambang ini, kueri ditandai sebagai SQL lambat.	Default: 500, unit: ms.
callsql.maxLength	Panjang maksimum yang dipertahankan dari SQL yang dikumpulkan. Ketika pernyataan SQL lebih besar dari ambang ini, akan dipotong.	Default: 1024 karakter. Panjang minimum: 256 karakter. Panjang maksimum: 4096 karakter.
jdbc.tracesqlbindvalue	Apakah akan menampilkan nilai pengikat variabel dalam SQL	Nilai valid: - true: Aktifkan sakelar untuk menangkap nilai variabel pengikat parameter PrepareStatement. - false (default): Nonaktifkan sakelar untuk menangkap nilai variabel pengikat parameter PrepareStatement.
jdbc.tracesqlraw	Apakah akan menampilkan nilai konstan dalam SQL	Nilai valid: - true - false (default)
preparestatement.response.size	Apakah akan mencatat ukuran nilai pengembalian kueri MySql	Nilai valid: - true - false (default)

Pengaturan protokol propagasi konteks trace

Key	Deskripsi bidang	Nilai
trace.protocol.name	Protokol propagasi yang disukai	Dapat dikonfigurasi sebagai EagleEye, W3C, Skywalking, Zipkin, atau Jager.
trace.protocol.strategy	Mode propagasi	Strategi propagasi dari protokol propagasi yang disukai. Default: Unset. Dapat diatur ke PriorityUse atau ForceUse.

Konfigurasi antrian pesan

Key	Deskripsi bidang	Nilai
rabbitmq.client.consumer.classes	Konsumen RabbitMQ kustom. Dengan mengatur nama kelas dari konsumen kustom atau nama kelas yang berisi konsumen inner anonim, Anda dapat melihat trace panggilan dari konsumen.	Pisahkan beberapa konsumen dengan koma (,). Contoh: com.xxx.xxx.RabbitMQConsumer
kafka.consumer.entryPoint	Metode konsumsi Kafka kustom. Dengan menyesuaikan metode konsumsi, Anda dapat melihat data trace dan metrik dalam skenario di mana pesan dikonsumsi melalui SDK Kafka asli.	Metode konsumsi kustom yang akan diatur harus berisi parameter dari tipe org.apache.kafka.clients.Consumer.ConsumerRecord atau org.apache.kafka.clients.consumer.ConsumerRecords.
kafka.enableInjectKafkaHeaders	Kafka secara otomatis memuat konteks saat mengirim pesan. Saat mengirim, beberapa header secara otomatis ditambahkan ke pesan Kafka untuk mengaitkan trace pengiriman dan trace konsumsi.	Nilai valid: - true - false (default)

Konfigurasi pengumpulan agen

Key	Deskripsi bidang	Nilai
sampling.enable	Apakah akan mengumpulkan trace	Nilai valid: - true (default) - false
thresholds.limit	Volume pengumpulan trace maksimum per detik oleh agen. Tindakan perlindungan untuk mencegah pengumpulan trace memengaruhi operasi bisnis normal dalam skenario lalu lintas tinggi. Nilai yang lebih tinggi dari default akan mengkonsumsi sumber daya sistem tambahan. Harap berhati-hati!	Nilai default: 100
control.flow.threshold	Ambang QPS maksimum yang dapat ditangani agen. Setelah permintaan per detik melebihi ambang ini, permintaan yang berlebih tidak akan lagi mencatat span dan menghasilkan metrik. Berlaku dari agen versi 4.1.10.	Nilai default: 10000
metricsAndSpan.entranceless.enable	Apakah akan mengumpulkan data panggilan internal tanpa entri	Nilai valid: - true (default) - false
log.report.level	Tingkat log agen	DEBUG, INFO, WARN (default), ERROR

Konfigurasi penyaringan pengecualian lanjutan

Key	Deskripsi bidang	Nilai
exception.fromInstrumentedMethod.enable	Apakah akan mengumpulkan pengecualian plug-in.	Nilai valid: - true (default) - false
exception.stacktrace	Kedalaman pembeda stack pengecualian serupa	Default: 2. Mengidentifikasi pengecualian dari tipe yang sama berdasarkan kedalaman stack ini. Memodifikasi konfigurasi ini akan menyebabkan perilaku statistik yang tidak diharapkan. Harap berhati-hati!
exception.whitelist	Whitelist penyaringan pengecualian	Nilai default: "". Contoh nilai: "java.lang.RuntimeException".
exception.filterByParentClass	Penyaringan pengecualian berdasarkan pewarisan kelas induk. Setelah diaktifkan, pengecualian kelas induk dapat dikonfigurasi dalam penyaringan pengecualian. Semua pengecualian yang diwarisi dari kelas induk ini akan disaring. Fitur ini hanya didukung oleh agen versi 4.1.6 dan di atasnya.	Nilai valid: - true - false (default)
exception.advancedWhitelist	Penyaringan pesan pengecualian.	Nilai default: "". Contoh: [{"exceptionName":"java.lang.RuntimeException","messageStartsWith":"prefixString"},{"exceptionName":"java.lang.NullPointerException","messageEndsWith":"suffixString"},{"exceptionName":"java.lang.IndexOutOfBoundsException","messageContains":"keyword"}] Untuk konfigurasi di atas, pengecualian yang sesuai akan disaring ketika kondisi berikut terpenuhi: Pengecualian adalah java.lang.RuntimeException dan pesan pengecualian dimulai dengan prefixString. Pengecualian adalah java.lang.NullPointerException dan pesan pengecualian berakhir dengan suffixString. Pengecualian adalah java.lang.IndexOutOfBoundsException dan pesan pengecualian berisi kata kunci.

Konfigurasi pemantauan pool

Key	Deskripsi bidang	Nilai
threadpoolmonitor.enable	Pemantauan thread pool dan connection pool	Nilai valid: - true (default) - false
threadpoolmonitor.threadNamePatternExtractStrategy	Strategi ekstraksi pola nama thread untuk thread pool	REPLACE_ALL_DIGITAL berarti mengganti semua digit dalam nama thread untuk mendapatkan pola nama thread. REPLACE_TAIL_DIGITAL berarti mengganti digit di akhir dalam nama thread untuk mendapatkan pola nama thread.
threadpoolmonitor.threadPoolUsage.blacklist	Penyaringan skenario penggunaan thread pool. Skenario penggunaan thread pool yang tidak dikumpulkan. Jika skenario penggunaan thread pool cocok, thread pool tidak dipantau.	Nilai default: "". Contoh nilai: "Tomcat,Vertx".
threadpoolmonitor.threadNamePattern.blacklist	Penyaringan pola nama thread untuk thread pool. Blacklist pola nama thread yang tidak dikumpulkan. Jika pola nama thread dari thread pool cocok, thread pool tidak dipantau.	Nilai default: "". Contoh nilai: "http-nio--, pool-1-thread-*".

Konfigurasi Atribut Span

Key	Deskripsi bidang	Nilai
otel.attribute.enable	Mencatat atribut konvensional dari OTel Spec	Nilai valid: - true - false (default)
tags.injection.strategy	Konfigurasi tag aplikasi terkait Span	ALL_SPAN berarti tag akan disuntikkan ke semua span. INCOMING_SPAN berarti tag hanya akan disuntikkan ke entry span.

Pengaturan lanjutan

Key	Deskripsi bidang	Nilai
quantile.enable	Apakah akan mencatat metrik kuantil	Nilai valid: - true (default) - false
callstack.maxLength	Panjang maksimum yang dipertahankan dari method stack	Default: 128. Method stack yang melebihi panjang akan dipotong selama pengumpulan. Nilai yang lebih tinggi dari default akan mengkonsumsi sumber daya sistem tambahan. Harap berhati-hati!
compress.enable	Kompresi trace. Apakah akan menyederhanakan panggilan berulang (seperti untuk loop).	Nilai valid: - true (default) - false
param.maxLength	Panjang tampilan maksimum parameter input permintaan	Default: 512. Nilai yang lebih tinggi dari default akan mengkonsumsi sumber daya sistem tambahan. Harap berhati-hati.
thread.match.package	Nama paket pemindaian propagasi asinkron. Agen versi 4.x dan di atasnya secara otomatis mendukung propagasi asinkron tanpa konfigurasi.	-
responseInject.enable	Sertakan TraceId dalam hasil pengembalian HTTP	Nilai valid: - true - false (default)
metrics.jvm.captureGcCause	Apakah akan mencatat informasi JVM GC Cause. Agen harus ditingkatkan ke versi 4.4.0.	Nilai valid: - true - false (default)

Elemen respons

Element	Type	Description	Example
	object
Data	string	Menunjukkan apakah operasi berhasil.	success
RequestId	string	ID permintaan.	78901766-3806-4E96-8E47-CFEF59E4****
Message	string	Pesan yang dikembalikan.	message
Code	integer	Kode status HTTP: 2XX: sukses 3XX: pengalihan 4XX: kesalahan permintaan 5XX: kesalahan server	200
Success	boolean	Menunjukkan apakah kueri berhasil: true: sukses. false: gagal.	true

Contoh

Respons sukses

JSONformat

{
  "Data": "success",
  "RequestId": "78901766-3806-4E96-8E47-CFEF59E4****",
  "Message": "message",
  "Code": 200,
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message
400	ParameterMissing	You must specify the parameter.
400	ParameterTraceAppSettingKeyIllegal	The application configuration key is invalid.
400	ParameterTraceAppSettingValueIllegal	The application configuration value is invalid.
400	InternalError	InterPlease try again. Contact the DingTalk service account if the issue persists after multiple retries.
404	AppNotExist	The application does not exist.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.