Referensi metrik, dimensi, dan filter Analytics

Jumlah rata-rata transaksi, yang berarti permintaan proxy API, per detik. Perhatikan bahwa jika Anda memiliki jumlah transaksi selama periode waktu, jumlah rata-rata transaksi per detik dapat terlihat seperti nol di laporan kustom UI jika angkanya lebih kecil dari dua angka desimal.

Sintaksis API: tps

Jumlah permintaan API yang berhasil yang menggunakan Cache Respons, bukan respons dari layanan target.

Sintaksis API: sum(cache_hit)

Menampilkan jumlah elemen dalam cache L1 (dalam memori) per transaksi selama periode tertentu periode waktu tertentu. Misalnya, jika Anda memilih max untuk periode satu hari, dan di hari itu, jumlah elemen tertinggi dalam {i> cache<i} adalah 12 untuk transaksi tertentu, maka jumlahnya adalah 12. Untuk avg, jika ada tiga transaksi di kolom jangka waktu Anda membuat kueri, dan jumlah {i>cache<i} mereka adalah 5, 6, dan 7, rata-ratanya adalah 6. L1 cache ada dalam cache dalam memori, bukan cache database L2, seperti yang dijelaskan di Internal cache.

Sintaksis API: avg(ax_cache_l1_count)

Jumlah total error kebijakan selama jangka waktu yang ditentukan.

Error kebijakan biasanya terjadi secara sengaja. Misalnya, kebijakan Verify API Key menampilkan error saat kunci API yang tidak valid diteruskan dalam permintaan, dan kebijakan Spike Arrest menampilkan error jika jumlah panggilan API melebihi batas yang ditentukan dalam kebijakan. Namun metrik ini berguna untuk menemukan titik masalah potensial dalam API Anda. Misalnya, metrik policy_error, yang dikelompokkan menurut dimensi developer_app, dapat membantu Anda menemukan bahwa kunci API atau token OAuth telah kedaluwarsa untuk aplikasi tertentu; atau Anda mungkin menemukan bahwa tertentu menghasilkan banyak {i>error<i} Spike Arrest, sehingga Anda menemukan bahwa batas penghentian lonjakan proxy tidak memperhitungkan peningkatan traffic musim liburan.

Error kebijakan akan dicatat di Analytics hanya jika error tersebut menyebabkan kegagalan proxy API. Misalnya, jika atribut continueOnError kebijakan disetel ke true, proxy API akan terus memproses permintaan meskipun kebijakan gagal. Dalam hal ini, error kebijakan tidak dicatat di Analytics.

Dimensi Nama Kebijakan tentang Kesalahan (ax_execution_fault_policy_name) berguna untuk mengelompokkan kesalahan kebijakan berdasarkan nama kebijakan.

Kegagalan target (seperti 404 atau 503) tidak dihitung sebagai kegagalan kebijakan. Mereka dihitung sebagai kegagalan proxy API (is_error).

Sintaksis API: sum(policy_error)

Total berapa kali proxy API gagal selama jangka waktu yang ditentukan. {i>proxy<i} kegagalan dapat terjadi jika kebijakan gagal atau saat terjadi kegagalan runtime, seperti error 404 atau 503 dari layanan target.

Dimensi Proxy (apiproxy) berguna untuk mengelompokkan kegagalan proxy API menurut proxy.

Sintaksis API: sum(is_error)

Jumlah waktu (rata-rata, minimum, atau maksimum), dalam milidetik, yang diperlukan Edge untuk memproses permintaan yang masuk. Waktu dimulai saat permintaan mencapai Edge dan berakhir saat Edge meneruskan permintaan ke layanan target.

Dengan dimensi berbeda, Anda bisa memeriksa latensi pemrosesan permintaan menurut proxy API, aplikasi developer, region, dan sebagainya.

Sintaksis API: max(request_processing_latency)

Ukuran payload permintaan yang diterima Edge, dalam byte.

Sintaksis API: avg(request_size)

Total berapa kali kebijakan Cache Respons dijalankan selama jangka waktu tertentu titik.

Karena kebijakan Cache Respons dilampirkan di dua tempat dalam proxy API (sekali di dan sekali dalam respons), biasanya dijalankan dua kali dalam panggilan API. Cache 'dapatkan' dan 'put' cache masing-masing dihitung sebagai satu eksekusi.

Akan tetapi, eksekusi cache respons adalah 0 jika <SkipCacheLookup> dalam kebijakan bernilai benar (true) (dalam permintaan), dan 0 jika <SkipCachePopulation> dalam kebijakan bernilai true (benar) (dalam respons).

Di alat Trace, Anda bisa mengklik ikon Response Cache pada panggilan API yang dijalankan dan melihat responsecache.executed variabel flow ke mengetahui ada tidaknya eksekusi cache (bernilai 1).

Sintaksis API: sum(ax_cache_executed)

Jumlah waktu (rata-rata, minimum, atau maksimum), dalam milidetik, yang diperlukan Edge untuk memproses respons API. Waktu dimulai saat proxy API menerima respons layanan target dan berakhir saat Apigee meneruskan respons ke respons asli penelepon.

Dengan menggunakan dimensi yang berbeda, Anda dapat memeriksa latensi pemrosesan respons berdasarkan API {i>proxy<i}, {i>region<i}, dan sebagainya.

Sintaksis API: min(response_processing_latency)

Ukuran {i>payload<i} respons yang dikembalikan ke klien, yaitu byte.

Sintaksis API: max(response_size)

Jumlah total respons 5xx dari layanan target. Ini adalah layanan target error yang tidak disebabkan oleh Apigee.

Sintaksis API: sum(target_error)

Jumlah waktu (jumlah, rata-rata, minimum, atau maksimum), dalam milidetik, agar server target dapat merespons panggilan. Metrik ini memberi tahu Anda bagaimana kinerja server target. Waktu dimulai saat Edge meneruskan permintaan ke layanan target dan berakhir saat Edge menerima respons.

Perhatikan, jika panggilan API menampilkan respons dari cache (menggunakan Cache Respons kebijakan, misalnya), panggilan tidak akan pernah menjangkau layanan target, dan tidak ada target metrik waktu respons dicatat.

Sintaksis API: avg(target_response_time)

Jumlah waktu (jumlah, rata-rata, minimum, atau maksimum), dalam milidetik, sejak Edge menerima permintaan dari klien hingga Edge mengirimkan respons kembali ke klien. Waktu mencakup {i>overhead<i} jaringan (seperti waktu yang dibutuhkan load balancer dan router untuk melakukan pekerjaannya), meminta pemrosesan latensi pemrosesan respons, latensi pemrosesan respons, dan waktu respons target (jika respons diberikan dari layanan target, bukan dari cache).

Dengan dimensi berbeda, Anda dapat memeriksa latensi pemrosesan berdasarkan proxy API, aplikasi developer, region, dan sebagainya.

Sintaksis API: avg(total_response_time)

Jumlah total panggilan API yang diproses oleh Edge dalam jangka waktu yang ditentukan.

Gunakan dimensi untuk mengelompokkan jumlah traffic dengan cara yang paling berarti bagi Anda.

Sintaksis API: sum(message_count)

Nama produk API berisi proxy API yang dipanggil. Untuk mendapatkan dimensi ini, aplikasi developer yang melakukan panggilan harus dikaitkan dengan satu atau beberapa API produk yang berisi proxy API, dan proxy yang dipanggil harus memeriksa keberadaan API atau token OAuth yang dikirimkan bersama panggilan API. Kunci atau token dikaitkan dengan API Google. Untuk informasi selengkapnya, lihat Hal pertama: Cara membuat data analisis lengkap.

Jika kriteria di atas tidak terpenuhi, Anda akan melihat nilai "(not set)". Lihat juga Apa yang dimaksud dengan nilai entitas analisis "(not set)" ?.

Kunci yang berisi nilai Cache Respons yang diakses. Untuk mengetahui informasi selengkapnya tentang untuk mengetahui cara kunci dibuat untuk cache respons, baca kebijakan Cache Respons.

Di alat Trace, saat Anda memilih kebijakan {i>Respons<i} Cache yang membaca dari atau menulis ke {i>cache<i}, Anda dapat melihat nilai ini dalam variabel flow responsecache.cachekey.

Nama {i>cache<i} yang berisi kunci/nilai yang digunakan oleh kebijakan {i>Respons<i} Cache, diawali dengan orgName__envName__. Misalnya, jika organisasinya "foo", tindakan lingkungan adalah "uji coba", dan nama cache-nya adalah "myCache", ax_cache_name adalah foo__test__myCache.

Di alat Trace, saat memilih kebijakan Cache Respons, Anda dapat melihat nilai ini di variabel flow responsecache.cachename.

Level cache ("L1" dalam memori atau "L2" database) tempat Cache Respons berada diambil. Dimensi ini juga menampilkan "CACHE_MISS" ketika respons dikirimkan dari target, bukan cache (dan cache respons dimuat ulang dengan respons target); atau jika kunci cache dalam permintaan tidak valid. Kunci cache dibatasi hingga berukuran 2 KB.

Di alat Trace, saat memilih kebijakan Response Cache, Anda dapat melihat nilai ini di variabel flow responsecache.cachesource.

Untuk informasi selengkapnya tentang tingkat cache, lihat Internal cache.

Kunci konsumen (kunci API) dari aplikasi developer yang melakukan panggilan API, baik yang diteruskan dalam permintaan sebagai kunci API atau disertakan dalam token OAuth.

Untuk mendapatkan dimensi ini, proxy yang menerima panggilan harus dikonfigurasi untuk memeriksa untuk kunci API atau token OAuth yang valid. Aplikasi developer mendapatkan kunci API, yang dapat digunakan untuk membuat token OAuth, saat aplikasi terdaftar di Edge. Untuk informasi selengkapnya, lihat Hal pertama: Cara membuat data analisis lengkap.

Jika kriteria di atas tidak terpenuhi, Anda akan melihat nilai "(not set)". Lihat juga Apa yang dimaksud dengan nilai entitas analisis "(not set)" ?.

Aplikasi developer yang terdaftar di Edge melakukan panggilan API.

Untuk mendapatkan dimensi ini, aplikasi harus dikaitkan dengan satu atau beberapa produk API yang berisi proxy API yang dipanggil, dan proxy harus memeriksa keberadaan kunci API atau Token OAuth yang dikirim dengan panggilan API. Kunci atau token mengidentifikasi aplikasi developer. Sebagai informasi selengkapnya, lihat Hal pertama yang pertama: Cara menghasilkan data analisis yang lengkap.

Jika kriteria di atas tidak terpenuhi, Anda akan melihat nilai "(not set)". Lihat juga Apa yang dimaksud dengan nilai entitas analisis "(not set)" ?.

Email developer terdaftar Edge yang aplikasinya melakukan panggilan API.

Untuk mendapatkan dimensi ini, developer harus memiliki aplikasi yang dikaitkan dengan satu atau beberapa Produk API yang berisi proxy API yang dipanggil, dan proxy harus memeriksa apakah Kunci API atau token OAuth yang dikirim bersama panggilan API. Kunci atau token mengidentifikasi developer . Untuk mengetahui informasi selengkapnya, lihat Hal pertama yang pertama: Cara membuat data analisis yang lengkap.

Jika kriteria di atas tidak terpenuhi, Anda akan melihat nilai "(not set)". Lihat juga Apa yang dimaksud dengan nilai entitas analisis "(not set)" ?.

ID developer unik yang dibuat Edge dalam bentuk org_name@@org_name.

Untuk mendapatkan dimensi ini, developer harus memiliki aplikasi yang dikaitkan dengan satu atau beberapa Produk API yang berisi proxy API yang dipanggil, dan proxy harus memeriksa apakah Kunci API atau token OAuth yang dikirim dengan panggilan API. Kunci atau token mengidentifikasi developer. Untuk mengetahui informasi selengkapnya, lihat Hal pertama yang pertama: Cara membuat data analisis yang lengkap.

Jika kriteria di atas tidak terpenuhi, Anda akan melihat nilai "(not set)". Lihat juga Apa yang dimaksud dengan nilai entitas analisis "(not set)" ?.

Kode error error. Contoh: messaging.adaptors.http.flow.GatewayTimeout

flow yang bernama dalam proxy API yang memunculkan error. Misalnya, "PreFlow", "PostFlow", atau nama alur bersyarat yang Anda buat.

Perhatikan bahwa nama lengkap yang digunakan di API pengelolaan adalah ax_execution_fault_flow_name, tanpa baris baru.

Jika tidak ada error, Anda akan melihat nilai "(not set)".

Nama alur proxy API yang menyatakan error, seperti "PROXY_REQ_FLOW" atau "TARGET_RESP_FLOW."

Perhatikan bahwa nama lengkap yang digunakan di API pengelolaan adalah ax_execution_fault_flow_state, tanpa baris baru.

Nama kebijakan yang menampilkan error dan menyebabkan panggilan API gagal.

Perhatikan bahwa nama lengkap yang digunakan di API pengelolaan adalah ax_execution_fault_policy_name, tanpa baris baru.

Jika kebijakan menampilkan error, tetapi atribut root kebijakan continueOnError disetel ke true, alur proxy API akan berlanjut tanpa kegagalan, dan kebijakan kegagalan tidak dihitung dalam dimensi ini.

BasePath yang dikonfigurasi di ProxyEndpoint proxy API. Jalur dasar tidak termasuk domain dan port tertentu dari URL proxy API. Misalnya, jika URL dasar proxy API adalah https://apigeedocs-test.apigee.net/releasenotes/, jalur dasarnya adalah /releasenotes.

Nilai ini juga disimpan dalam variabel flow proxy.basepath.

Jalur resource ditambahkan ke jalur dasar proxy API. Misalnya, jika proxy API URL dasar adalah https://apigeedocs-test.apigee.net/hello/, dan panggilan dilakukan ke https://apigeedocs-test.apigee.net/hello/json, pathuffix-nya adalah /json.

Jika tidak ada pathuffix yang digunakan, nilainya kosong.

Nilai ini juga disimpan dalam variabel flow proxy.pathsuffix.

Berisi alamat IP klien asal. Nilai ax_resolved_client_ip dimensi dihitung dari nilai di ax_true_client_ip dan x_forwarded_for_ip dimensi.

Perhatikan bahwa saat menggunakan produk {i>routing<i} seperti Akamai untuk menangkap alamat IP klien yang sebenarnya, IP klien diteruskan ke Edge di header HTTP True-Client-IP, yang lalu digunakan untuk menetapkan dimensi ax_true_client_ip.

Nilai dimensi ax_resolved_client_ip dihitung sebagai berikut:

1. Jika ax_true_client_ip bukan null dan tidak berisi alamat IP lokal, lalu tetapkan ax_resolved_client_ip ke ax_true_client_ip.
2. Selain itu, tetapkan ax_resolved_client_ip ke alamat IP non-lokal pertama di x_forwarded_for_ip.
3. Jika ax_true_client_ip dan x_forwarded_for_ip berisi alamat IP lokal saja, lalu setel ax_resolved_client_ip ke alamat IP lokal pertama di x_forwarded_for_ip.
4. Jika ax_true_client_ip dan x_forwarded_for_ip bernilai null, setel ax_resolved_client_ip ke (not set).
5. Jika ax_true_client_ip adalah alamat IP lokal dan x_forwarded_for_ip adalah null, tetapkan ax_resolved_client_ip ke (not set).

Versi sistem operasi perangkat yang melakukan panggilan.

Hal ini berguna untuk menggunakan ini sebagai "lihat perincian" kedua dengan OS Family (ax_ua_os_family) untuk melihat versi sistem operasi.

Alamat IP klien yang melakukan panggilan, disimpan di proxy.client.ip variabel flow. Ini sering kali merupakan alamat X-Forwarded-For dari panggilan masuk, yang merupakan alamat IP yang diterima Edge dari handshake TCP eksternal terakhir. Hal ini dapat menjadi klien yang memanggil atau load balancer. Ketika ada beberapa IP di X-Forwarded-For, ini adalah IP terakhir yang tercantum.

Saat menggunakan produk {i>routing<i} seperti Akamai untuk menangkap alamat IP klien yang sebenarnya, IP klien diteruskan ke Edge di header HTTP True-Client-IP. Ini mengambil IP klien sebenarnya dari header tersebut.

Untuk menentukan Alamat IP klien asli, yang diakses melalui ax_resolved_client_ip dimensi, Edge menggunakan ax_true_client_ip dan x_forwarded_for_ip dimensi.

Jalur resource (tidak termasuk domain) ke layanan target, tidak termasuk kueri parameter.

Misalnya, contoh target Apigee http://mocktarget.apigee.net menyertakan beberapa resource, termasuk /user, yang menampilkan ucapan. Terlepas dari cara proxy API Anda memanggil http://mocktarget.apigee.net/user, request_path adalah /user.

Jalur resource (tidak termasuk domain) ke layanan target, termasuk kueri parameter.

Misalnya, contoh target Apigee http://mocktarget.apigee.net mencakup beberapa resource, termasuk resource dan kueri /user?user={name} untuk menampilkan ucapan kustom ke nama yang diberikan. Terlepas dari cara API Anda proxy memanggil http://mocktarget.apigee.net/user?user=Dude, request_uri adalah /user?user=Dude.

Nama agen pengguna, atau agen software, yang digunakan untuk melakukan panggilan API. Contoh:

• Pixel XL melakukan panggilan melalui Chrome: Mozilla/5.0 (Linux; Android 7.1.2; Pixel XL Build/NHG47N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.92 Mobile Safari/537.36
• iPad melakukan panggilan melalui Chrome: Mozilla/5.0 (iPad; CPU OS 10_2 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) CriOS/54.0.2840.91 Mobile/14C92 Safari/602.1
• cURL dari terminal: curl/7.51.0

Versi useragent.

Hal ini berguna untuk menggunakan ini sebagai "lihat perincian" kedua dengan Kelompok Agen Pengguna (ax_ua_agent_family) untuk mendapatkan versi kelompok agen.

Jalur resource (tidak termasuk domain) ke layanan target, tidak termasuk kueri , yang ditentukan dalam <TargetEndpoint> proxy.

Misalnya, proxy API memanggil target berikut:

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
</HTTPTargetConnection>

Dalam contoh ini, target_basepath adalah /user.

Jika targetnya adalah:

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net</URL>
</HTTPTargetConnection>

{i>target_basepath<i} akan menjadi {i>null<i}.

Di alat Trace, saat memilih ikon AX di akhir diagram alur, target.basepath variabel flow memetakan ke target_basepath.

Kode status respons HTTP yang dikembalikan oleh layanan target ke proxy API, misalnya 200, 404, 503, dan seterusnya.

Nilai "null" berarti permintaan tidak pernah mencapai layanan target. Hal ini terjadi ketika respons akan diberikan oleh kebijakan Response Cache atau jika ada kegagalan dalam permintaan diproses.

Ini berbeda dengan Kode Status Respons (response_status_code).

URL lengkap layanan target yang ditentukan di TargetEndpoint proxy API.

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
</HTTPTargetConnection>

Dalam contoh ini, target_url adalah http://mocktarget.apigee.net/user?user=Dude.

Perhatikan bahwa URL juga dapat diganti selama pemrosesan proxy API dengan target.url variabel flow.

Dalam proxy perantaian dan saat menggunakan skrip target (Node.js), target_url dalam proxy panggilan adalah null.

Daftar alamat IP di header X-Forwarded-For.

Untuk menentukan Alamat IP klien asli, yang diakses melalui ax_resolved_client_ip dimensi, Edge menggunakan ax_true_client_ip dan x_forwarded_for_ip dimensi.

Berdasarkan model waktu 24 jam, jam 2 digit saat panggilan API dilakukan. Misalnya, Panggilan API yang dilakukan dalam jam antara pukul 22.00 dan 23.00, ax_hour_of_day akan menjadi 22.

Nilai waktu menggunakan UTC.