Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info
Apa itu alat Trace?
Trace adalah alat untuk memecahkan masalah dan memantau proxy API yang berjalan di Apigee Edge. Trace memungkinkan Anda memeriksa detail setiap langkah melalui alur proxy API.
Tonton video ini untuk pengantar alat Trace.
Cara menggunakan Trace
Trace mudah digunakan. Anda memulai sesi rekaman aktivitas, lalu melakukan panggilan API ke platform Edge, dan membaca hasilnya.
- Akses halaman proxy API, seperti yang dijelaskan di bawah.
Edge
Untuk mengakses halaman proxy API menggunakan UI Edge:
- Login ke apigee.com/edge.
- Pilih Develop > Proxy API di menu navigasi sebelah kiri.
UI Edge Baru (Cloud Pribadi)
Untuk mengakses halaman proxy API menggunakan UI Edge Baru:
- Login ke UI Edge Baru di
http://host:3001/edge, dengan host adalah alamat IP atau nama DNS host yang menjalankan UI Edge Baru. - Pilih Develop > Proxy API di menu navigasi sebelah kiri.
- Pilih proxy API dari halaman API Proxies.
- Pastikan API yang ingin Anda lacak telah di-deploy.
- Klik Trace untuk membuka tampilan alat Trace.
- Gunakan menu dropdown Deployment to Trace untuk memilih lingkungan deployment dan revisi proxy yang ingin Anda lacak.
- Klik Start Trace Session. Saat sesi Trace aktif, proxy API
mencatat detail setiap langkah dalam pipeline pemrosesan. Saat sesi Trace berjalan,
pesan dan data kontekstual diambil dari traffic langsung.

- Jika Anda tidak memiliki traffic aktif yang mengalir melalui proxy, cukup kirim permintaan ke API. Anda dapat menggunakan alat apa pun yang Anda inginkan untuk mengirim permintaan, seperti curl, Postman, atau
alat yang sudah dikenal. Atau, Anda dapat mengirim permintaan langsung dari alat Trace itu sendiri. Cukup masukkan
URL, lalu klik Kirim. Catatan: Anda hanya dapat mengirim permintaan GET dari
alat Trace, tetapi tidak dapat mengirim permintaan POST.
Catatan: Satu sesi Trace dapat mendukung 10 transaksi permintaan/respons per pemroses pesan melalui proxy API yang dipilih. Di Edge cloud, dengan 2 Message Processor yang menangani traffic, 20 transaksi permintaan/respons didukung. Sesi rekaman aktivitas akan otomatis berhenti setelah 10 menit jika Anda tidak menghentikannya secara manual.
- Setelah Anda menangkap jumlah permintaan yang memadai, klik Stop Trace Session.
- Daftar transaksi permintaan/respons yang diambil akan ditampilkan di menu kiri. Klik salah satu transaksi untuk melihat hasil mendetail.
Cara membaca rekaman aktivitas
Alat pelacakan memiliki dua bagian utama, yaitu peta transaksi dan detail fase:
- Peta transaksi menggunakan ikon untuk menandai setiap langkah penting yang terjadi selama transaksi proxy API, termasuk eksekusi kebijakan, langkah kondisional, dan transisi. Arahkan kursor ke ikon mana pun untuk melihat informasi ringkasan. Langkah-langkah alur permintaan muncul di sepanjang bagian atas peta transaksi dan langkah-langkah alur respons di sepanjang bagian bawah.
- Bagian detail fase alat ini mencantumkan informasi tentang pemrosesan internal proxy, termasuk variabel yang ditetapkan atau dibaca, header permintaan dan respons, dan banyak lagi. Klik ikon mana pun untuk melihat detail fase untuk langkah tersebut.
Berikut adalah contoh peta alat rekaman aktivitas dengan segmen pemrosesan proxy utama yang diberi label:
Peta transaksi alat Trace

Legenda peta transaksi
Tabel berikut menjelaskan maksud ikon yang akan Anda lihat di peta transaksi. Ikon ini menandai setiap langkah pemrosesan penting di seluruh alur proxy.
Ikon peta transaksi
![]() |
Aplikasi klien yang mengirimkan permintaan ke ProxyEndpoint proxy API. |
| Lingkaran menandai endpoint transisi dalam alur proxy. Kebijakan tersebut ada saat permintaan masuk dari klien, saat permintaan dikirim ke target, saat respons kembali dari target, dan saat respons dikirim kembali ke klien. | |
|
Batang tinggi menunjukkan awal segmen alur dalam alur proxy API. Segmen alur adalah: permintaan ProxyEndpoint, permintaan TargetEndpoint, respons TargetEndpoint, dan respons ProxyEndpoint. Segmen mencakup PreFlow, Alur Bersyarat, dan PostFlow. Lihat Mengonfigurasi alur untuk mengetahui informasi selengkapnya. |
|
|
Menunjukkan bahwa tindakan Analytics telah terjadi di latar belakang. |
|
|
Alur bersyarat yang bernilai benar. Untuk pengantar alur bersyarat, lihat Mengonfigurasi alur. Perhatikan bahwa beberapa kondisi dibuat oleh Edge. Misalnya, berikut adalah ekspresi yang digunakan Edge untuk memeriksa apakah terjadi error di ProxyEndpoint: ((error.state equals PROXY_REQ_FLOW) or (error.state equals
PROXY_RESP_FLOW))
|
|
|
Alur bersyarat yang bernilai salah. Untuk pengantar alur bersyarat, lihat Mengonfigurasi alur. Perhatikan bahwa beberapa kondisi dibuat oleh Edge. Misalnya, berikut adalah ekspresi yang digunakan Edge untuk memeriksa apakah terjadi error di TargetEndpoint: (((error.state equals TARGET_REQ_FLOW) or (error.state equals
TARGET_RESP_FLOW)) or ((error.state equals REQ_SENT) or (error.state equals
RESP_START)))
|
|
|
|
Kebijakan. Setiap jenis kebijakan memiliki ikon yang unik. Yang ini untuk kebijakan AssignMessage. Ikon ini memungkinkan Anda melihat tempat kebijakan dijalankan dalam urutan yang tepat dan apakah kebijakan tersebut berhasil atau tidak. Anda dapat mengklik ikon kebijakan untuk melihat hasil eksekusinya dan apakah hasil tersebut sesuai harapan atau tidak. Misalnya, Anda dapat melihat apakah pesan telah diubah dengan benar atau apakah pesan tersebut di-cache. Kebijakan yang dijalankan dengan benar ditunjukkan dengan jelas oleh tanda centang. Jika terjadi error, tanda seru berwarna merah akan ditampilkan pada ikon. Tips: Perhatikan tooltip atau linimasa untuk melihat apakah ada kebijakan yang memerlukan waktu lebih lama dari yang diperkirakan. |
![]() |
Muncul saat target backend adalah aplikasi Node.js. Lihat Ringkasan Node.js di Apigee Edge. |
![]() |
Target backend yang dipanggil oleh proxy API. |
![]() |
Garis waktu menunjukkan berapa lama (dalam milidetik) waktu pemrosesan yang diperlukan untuk menyelesaikan. Membandingkan segmen waktu berlalu membantu Anda mengisolasi kebijakan yang memerlukan waktu eksekusi paling lama dan memperlambat panggilan API Anda. |
| Epsilon menunjukkan rentang waktu yang lebih kecil dari milidetik. | |
|
Nonaktif. Muncul di ikon kebijakan saat kebijakan dinonaktifkan. Kebijakan dapat dinonaktifkan dengan API publik. Lihat Referensi konfigurasi proxy API. |
|
| Error. Muncul di ikon kebijakan saat kondisi Langkah Kebijakan bernilai salah (lihat Variabel dan kondisi alur), atau di ikon kebijakan RaiseFault setiap kali kebijakan RaiseFault dijalankan. | |
| Dilewati. Muncul di ikon kebijakan saat kebijakan tidak dijalankan karena kondisi langkah bernilai salah (false). Lihat Variabel dan kondisi alur untuk mengetahui informasi selengkapnya. |
Memahami detail fase
Bagian Phase Details pada alat ini memberi tahu Anda banyak hal tentang status proxy Anda di setiap langkah pemrosesan. Berikut beberapa detail yang diberikan di Detail Fase. Klik ikon apa pun di alat pelacakan untuk melihat detail langkah yang dipilih, atau gunakan tombol Next/Back untuk berpindah dari satu langkah ke langkah lainnya.
| Detail Fase | Deskripsi |
| Endpoint Proxy | Menunjukkan alur ProxyEndpoint yang dipilih untuk dieksekusi. Proxy API dapat memiliki beberapa endpoint proxy bernama. |
| Variabel |
Mencantumkan flow variable yang dibaca dan diberi nilai oleh kebijakan, Lihat juga Mengelola status proxy dengan flow variable. Catatan:
|
| Header Permintaan | Mencantumkan header permintaan HTTP. |
| Konten Permintaan | Menampilkan isi permintaan HTTP. |
| Properti | Properti mewakili status internal proxy API. Opsi ini tidak ditampilkan secara default. |
| Endpoint Target | Menunjukkan TargetEndpoint yang dipilih untuk dieksekusi. |
| Header Respons | Mencantumkan header respons HTTP. |
| Konten Respons | Menampilkan isi respons HTTP. |
| PostClientFlow | Menampilkan informasi tentang PostClientFlow, yang dijalankan setelah permintaan dikembalikan ke aplikasi klien yang meminta. Hanya kebijakan MessageLogging yang dapat dilampirkan ke PostClientFlow. PostClientFlow saat ini digunakan terutama untuk mengukur interval waktu antara stempel waktu mulai dan akhir untuk pesan respons. |
Menyaring pengambilan pesan menggunakan filter
Anda dapat memfilter permintaan yang muncul di alat Trace dengan menentukan nilai parameter header dan/atau kueri. Filter memungkinkan Anda menargetkan panggilan tertentu yang mungkin menyebabkan masalah. Misalnya, Anda mungkin perlu berfokus pada permintaan yang memiliki konten tertentu atau permintaan yang berasal dari partner atau aplikasi tertentu. Anda dapat memfilter:
- Header HTTP - Membatasi trace hanya untuk panggilan yang berisi header tertentu. Ini adalah cara yang baik untuk membantu Anda memecahkan masalah. Anda dapat mengirim header ke developer aplikasi dan memintanya untuk menyertakan header tersebut dalam panggilan yang menyebabkan masalah. Kemudian, Apigee Edge hanya akan merekam panggilan dengan header tertentu tersebut sehingga Anda dapat memeriksa hasilnya.
- Parameter kueri - Hanya panggilan dengan nilai parameter tertentu yang akan direkam.
Hal yang perlu Anda ketahui tentang fitur Filter
- Anda harus memulai ulang sesi Trace setelah menentukan parameter filter di kolom filter.
- Parameter filter digabungkan bersama menggunakan AND. Semua pasangan nama/nilai kueri dan/atau header yang ditentukan harus ada dalam permintaan agar pencocokan berhasil.
- Pencocokan pola tidak didukung di alat Filter.
- Parameter dan nilai filter peka huruf besar/kecil.
Cara membuat filter trace
- Jika sesi rekaman aktivitas sedang berjalan, hentikan dengan mengklik Stop Trace Session.
- Klik Filters di sudut kiri atas alat Trace untuk meluaskan
kolom Filters.

- Di kolom Filters, tentukan parameter kueri dan/atau nilai header yang ingin Anda filter. Dalam contoh ini, kita menentukan dua parameter kueri untuk difilter. Kedua parameter harus ada dalam permintaan agar pencocokan berhasil.

- Mulai sesi rekaman aktivitas.
- Memanggil API Anda. Hanya permintaan yang menyertakan semua header dan/atau parameter kueri yang ditentukan yang akan menghasilkan kecocokan yang berhasil.

Dalam contoh di atas, panggilan API ini akan muncul di Trace:
http://docs-test.apigee.net/cats?name=Penny&breed=Calico
Namun, ini tidak akan:
http://docs-test.apigee.net/cats?name=Penny
Proses debug dengan Trace
Trace memungkinkan Anda melihat banyak detail internal tentang proxy API. Contoh:
- Anda dapat melihat sekilas kebijakan mana yang dijalankan dengan benar atau gagal.
- Misalnya, Anda melihat melalui salah satu dasbor Analytics bahwa salah satu API Anda mengalami penurunan performa yang tidak biasa. Sekarang, Anda dapat menggunakan Trace untuk membantu mengidentifikasi tempat terjadinya bottleneck. Trace memberikan waktu, dalam milidetik, yang diperlukan untuk menyelesaikan setiap langkah pemrosesan. Jika Anda mendapati satu langkah memerlukan waktu terlalu lama, Anda dapat melakukan tindakan korektif.
- Dengan melihat detail fase, Anda dapat memeriksa header yang dikirim ke backend, melihat variabel yang ditetapkan oleh kebijakan, dan sebagainya.
- Dengan memverifikasi jalur dasar, Anda dapat memastikan bahwa kebijakan merutekan pesan ke server yang benar.
Memilih Opsi Tampilan
Pilih opsi tampilan untuk sesi rekaman aktivitas.

| Opsi | Deskripsi |
| Tampilkan Kebijakan yang Dinonaktifkan | Tampilkan kebijakan yang dinonaktifkan. Kebijakan dapat dinonaktifkan dengan API publik. Lihat Referensi konfigurasi proxy API. |
| Tampilkan Fase yang Dilewati | Tampilkan fase yang dilewati. Fase yang dilewati terjadi saat kebijakan tidak dijalankan karena kondisi langkah dievaluasi sebagai salah. Lihat Variabel dan kondisi alur untuk mengetahui informasi selengkapnya. |
| Menampilkan semua FlowInfo | Merepresentasikan transisi dalam segmen alur. |
| Bandingkan Fase yang Dipilih Secara Otomatis | Membandingkan fase yang dipilih dengan fase sebelumnya. Nonaktifkan opsi ini untuk hanya melihat fase yang dipilih. |
| Tampilkan Variabel | Menampilkan atau menyembunyikan variabel yang dibaca dan/atau diberi nilai. |
| Tampilkan Properti | Properti mewakili status internal proxy API. (Disembunyikan secara default.) |
Mendownload hasil pelacakan
Anda dapat mendownload file XML hasil rekaman aktivitas mentah untuk dilihat dan ditelusuri secara offline di editor teks. File ini menampilkan detail lengkap sesi pemantauan, termasuk konten semua header, variabel, dan kebijakan.
Untuk mendownload, klik Download Trace Session.
Menampilkan permintaan sebagai curl
Setelah melacak panggilan API yang dilakukan ke server target, Anda dapat melihat permintaan sebagai perintah curl. Hal ini sangat berguna untuk proses debug karena beberapa alasan:
- Proxy API dapat mengubah permintaan, sehingga berguna untuk melihat perbedaan permintaan dari proxy ke server target dengan permintaan asli. Perintah curl mewakili permintaan yang diubah.
- Untuk payload pesan yang lebih besar, curl memungkinkan Anda melihat header HTTP dan konten pesan di satu tempat. (Saat ini ada batas sekitar 1.000 karakter. Untuk mendapatkan tips tentang cara melewati batas ini, lihat postingan komunitas ini.)
Untuk keamanan, fitur curl menyamarkan header HTTP Authorization.
Untuk melihat permintaan sebagai curl setelah panggilan API masuk di Trace, pilih tahap "Request sent to target server" di diagram Transaction Map, lalu klik tombol Show curl di kolom "Request sent to target server" di panel Phase Details.

Penggunaan Trace oleh Dukungan Apigee
Secara default, Apigee Edge memungkinkan Dukungan Apigee menggunakan alat Trace di proxy API Anda untuk memberikan dukungan. Anda dapat menonaktifkan opsi ini kapan saja. Namun, menonaktifkan opsi ini dapat membatasi kemampuan Dukungan Apigee untuk memberikan dukungan kepada Anda.
Untuk menonaktifkan Dukungan Apigee agar tidak menggunakan alat Trace:
- Login ke https://apigee.com/edge.
- Pilih Admin > Privasi & Keamanan di menu navigasi sebelah kiri.
- Klik tombol Enable Apigee Support to Trace untuk menonaktifkan penggunaan alat Trace oleh Dukungan Apigee.



