Trace
BERLAKU UNTUK: Semua tingkatAN API Management
Kebijakan menambahkan trace
jejak kustom ke dalam output pelacakan permintaan di konsol pengujian, telemetri Application Insights, dan/atau log sumber daya.
- Kebijakan menambahkan jejak kustom ke output pelacakan permintaan di konsol pengujian saat pelacakan dipicu, yaitu,
Ocp-Apim-Trace
header permintaan ada dan diatur ketrue
danOcp-Apim-Subscription-Key
header permintaan ada dan menyimpan kunci valid yang memungkinkan pelacakan. - Kebijakan ini membuat telemetri Pelacakan di Application Insights, ketika integrasi Application Insights diaktifkan dan
severity
yang ditentukan dalam kebijakan sama dengan atau lebih besar dariverbosity
yang ditentukan dalam pengaturan diagnostik. - Kebijakan menambahkan properti dalam entri log saat log sumber daya diaktifkan dan tingkat keparahan yang ditentukan dalam kebijakan berada pada atau lebih tinggi dari tingkat verbositas yang ditentukan dalam pengaturan diagnostik.
- Kebijakan ini tidak terpengaruh oleh pengambilan sampel Application Insights. Semua pemanggilan kebijakan akan dicatat.
Peringatan
- Hanya izinkan pelacakan pada langganan yang ditujukan untuk tujuan penelusuran kesalahan. Berbagi kunci langganan, dengan pelacakan yang diizinkan, dengan pengguna yang tidak sah dapat menyebabkan pengungkapan informasi sensitif yang terdapat dalam log pelacakan seperti kunci, token akses, kata sandi, nama host internal, dan alamat IP.
- Di konsol pengujian, API Management secara otomatis menonaktifkan pelacakan 1 jam setelah diaktifkan pada langganan.
Catatan
Saat ini, pelacakan permintaan API tidak didukung di tingkat Dasar v2 dan Standar v2.
Catatan
Tetapkan elemen kebijakan dan elemen turunan dalam urutan yang disediakan dalam pernyataan kebijakan. Pelajari lebih lanjut cara mengatur atau mengedit kebijakan API Management.
Pernyataan kebijakan
<trace source="arbitrary string literal" severity="verbose | information | error">
<message>String literal or expressions</message>
<metadata name="string literal or expressions" value="string literal or expressions"/>
</trace>
Atribut
Atribut | Deskripsi | Wajib diisi | Default |
---|---|---|---|
sumber | String literal yang bermakna bagi penampil lacak dan menentukan sumber pesan. Ekspresi kebijakan tidak diizinkan. | Ya | T/A |
keparahan | Menentukan tingkat keparahan pelacakan. Nilai yang diperbolehkan adalah verbose , information , error (dari terendah hingga tertinggi). Ekspresi kebijakan tidak diizinkan. |
No | verbose |
Elemen
Nama | Deskripsi | Wajib diisi |
---|---|---|
pesan | Sebuah string atau ungkapan yang akan dicatat. Ekspresi kebijakan diizinkan. | Ya |
metadata | Menambahkan properti khusus ke telemetri Lacak Application Insights. | No |
atribut metadata
Atribut | Deskripsi | Wajib diisi | Default |
---|---|---|---|
nama | Nama properti. | Ya | T/A |
value | Nilai properti. | Ya | T/A |
Penggunaan
- Bagian kebijakan: masuk, keluar, backend
- Cakupan kebijakan: global, ruang kerja, produk, API, operasi
- Gateway: klasik, v2, konsumsi, dihost sendiri
Contoh
<trace source="PetStore API" severity="verbose">
<message>@((string)context.Variables["clientConnectionID"])</message>
<metadata name="Operation Name" value="New-Order"/>
</trace>
Kebijakan terkait
Konten terkait
Untuk informasi selengkapnya tentang bekerja dengan kebijakan, lihat:
- Tutorial: Mengubah dan melindungi API Anda
- Referensi Kebijakan untuk daftar lengkap pernyataan kebijakan dan pengaturannya
- Ekspresi kebijakan
- Mengatur atau mengedit kebijakan
- Menggunakan kembali konfigurasi kebijakan
- Repositori cuplikan kebijakan
- Kebijakan penulis menggunakan Microsoft Copilot untuk Azure