Referensi metrik, dimensi, dan filter Analytics

Jumlah rata-rata transaksi, yang berarti permintaan proxy API, per detik. Perhatikan bahwa jika Anda memiliki jumlah transaksi yang relatif rendah selama jangka waktu tersebut, jumlah transaksi rata-rata per detik dapat tampak nol dalam laporan kustom UI jika jumlahnya lebih kecil dari dua tempat 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 jangka waktu tertentu. Misalnya, jika Anda memilih max untuk jangka waktu satu hari, dan dalam hari tersebut, jumlah elemen tertinggi dalam cache adalah 12 untuk transaksi tertentu, maka jumlahnya adalah 12. Untuk avg, jika ada tiga transaksi dalam jangka waktu yang Anda kueri, dan jumlah cache-nya adalah 5, 6, dan 7, rata-ratanya adalah 6. Cache L1 adalah cache dalam memori, bukan cache database L2, seperti yang dijelaskan dalam Internal cache.

Sintaksis API: avg(ax_cache_l1_count)

Jumlah total kesalahan kebijakan selama jangka waktu yang ditentukan.

Error kebijakan biasanya terjadi karena desain. Misalnya, kebijakan Verify API Key akan menampilkan error saat kunci API yang tidak valid diteruskan dalam permintaan, dan kebijakan Spike Arrest akan menampilkan error jika jumlah panggilan API melebihi batas yang ditentukan dalam kebijakan. Jadi, metrik ini berguna untuk menemukan potensi masalah di API Anda. Misalnya, metrik policy_error, yang dikelompokkan menurut dimensi developer_app, dapat membantu Anda menemukan bahwa kunci API atau token OAuth telah habis masa berlakunya untuk aplikasi tertentu; atau Anda mungkin menemukan bahwa proxy API tertentu memunculkan banyak error Spike Arrest, sehingga Anda menemukan bahwa batas spike arrest proxy tidak memperhitungkan peningkatan traffic selama musim liburan.

Error kebijakan dicatat dalam analisis hanya jika error mengakibatkan kegagalan proxy API. Misalnya, jika atribut continueOnError kebijakan ditetapkan ke true, proxy API akan terus memproses permintaan meskipun kebijakan gagal. Dalam hal ini, error kebijakan tidak dicatat ke dalam log di Analytics.

Dimensi Nama Kebijakan saat Terjadi Error (ax_execution_fault_policy_name) berguna untuk mengelompokkan error kebijakan menurut nama kebijakan.

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

Sintaksis API: sum(policy_error)

Jumlah total kegagalan proxy API selama jangka waktu yang ditentukan. Kegagalan proxy dapat terjadi saat kebijakan gagal atau saat terjadi kegagalan runtime, seperti 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 masuk. Waktu dimulai saat permintaan mencapai Edge dan berakhir saat Edge meneruskan permintaan ke layanan target.

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

Sintaksis API: max(request_processing_latency)

Ukuran payload permintaan yang diterima oleh Edge, dalam byte.

Sintaksis API: avg(request_size)

Jumlah total kebijakan Response Cache yang dieksekusi selama periode waktu tertentu.

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

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

Di alat Pelacakan, Anda dapat mengklik ikon Cache Respons dalam panggilan API yang dieksekusi dan melihat responsecache.executed variabel alur untuk melihat apakah ada eksekusi cache atau tidak (nilai 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 pemanggil asli.

Dengan menggunakan dimensi yang berbeda, Anda dapat memeriksa latensi pemrosesan respons menurut proxy API, region, dan sebagainya.

Sintaksis API: min(response_processing_latency)

Ukuran payload respons yang ditampilkan ke klien, dalam byte.

Sintaksis API: max(response_size)

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

Sintaksis API: sum(target_error)

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

Perhatikan bahwa jika panggilan API menampilkan respons dari cache (menggunakan kebijakan Response Cache, misalnya), panggilan tidak akan pernah mencapai layanan target, dan tidak ada metrik waktu respons target yang 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 ini mencakup overhead jaringan (seperti waktu yang dibutuhkan load balancer dan router untuk melakukan tugasnya), latensi pemrosesan permintaan, latensi pemrosesan respons, dan waktu respons target (jika respons ditayangkan dari layanan target, bukan dari cache).

Dengan menggunakan dimensi yang berbeda, Anda dapat memeriksa latensi pemrosesan menurut 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 bermakna bagi Anda.

Sintaksis API: sum(message_count)

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

Jika kriteria di atas tidak terpenuhi, Anda akan melihat nilai "(not set)". Lihat juga Apa arti nilai entitas analytics "(not set)"?.

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

Di Trace tool, saat Anda memilih kebijakan Response Cache yang membaca dari atau menulis ke cache, Anda dapat melihat nilai ini dalam responsecache.cachekey flow variable.

Nama cache yang berisi kunci/nilai yang digunakan oleh kebijakan Response Cache, dengan awalan orgName__envName__. Misalnya, jika org adalah "foo", lingkungannya adalah "test", dan nama cache adalah "myCache", ax_cache_name adalah foo__test__myCache.

Di Trace tool, saat memilih kebijakan Response Cache, Anda dapat melihat nilai ini di responsecache.cachename flow variable.

Tingkat cache ("L1" dalam memori atau database "L2") tempat Cache Respons diambil. Dimensi ini juga menampilkan "CACHE_MISS" saat respons dikirim dari target, bukan cache (dan cache respons diperbarui dengan respons target); atau saat kunci cache dalam permintaan tidak valid. Kunci cache dibatasi hingga berukuran 2 KB.

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

Untuk mengetahui informasi selengkapnya tentang tingkat cache, lihat Internal cache.

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

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

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

Aplikasi developer yang terdaftar di Edge yang 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 kunci API atau token OAuth yang dikirim dengan panggilan API. Kunci atau token mengidentifikasi aplikasi developer. Untuk informasi selengkapnya, lihat Langkah pertama: Cara membuat data analisis yang lengkap.

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

Email developer terdaftar di Edge yang aplikasinya melakukan panggilan API.

Untuk mendapatkan dimensi ini, developer harus memiliki aplikasi yang terkait dengan satu atau beberapa produk API yang berisi proxy API yang dipanggil, dan proxy harus memeriksa kunci API atau token OAuth yang dikirim dengan panggilan API. Kunci atau token mengidentifikasi aplikasi developer. Untuk mengetahui informasi selengkapnya, lihat Hal-hal penting: Cara membuat data analisis yang lengkap.

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

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

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

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

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

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

Perhatikan bahwa nama lengkap yang akan digunakan di Management API adalah ax_execution_fault_flow_name, tanpa jeda baris.

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

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

Perhatikan bahwa nama lengkap yang akan digunakan di Management API adalah ax_execution_fault_flow_state, tanpa jeda baris.

Nama kebijakan yang memunculkan error dan menyebabkan panggilan API gagal.

Perhatikan bahwa nama lengkap yang akan digunakan di Management API adalah ax_execution_fault_policy_name, tanpa jeda baris.

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

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

Nilai juga disimpan dalam variabel alur proxy.basepath.

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

Jika tidak ada pathsuffix yang digunakan, nilainya kosong.

Nilai juga disimpan dalam variabel alur proxy.pathsuffix.

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

Perhatikan bahwa saat menggunakan produk perutean seperti Akamai untuk mengambil alamat IP sebenarnya dari klien, IP klien diteruskan ke Edge di header HTTP True-Client-IP, yang kemudian digunakan untuk menetapkan dimensi ax_true_client_ip.

Nilai dimensi ax_resolved_client_ip dihitung sebagai berikut:

1. Jika ax_true_client_ip tidak null dan tidak berisi alamat IP lokal, tetapkan ax_resolved_client_ip ke ax_true_client_ip.
2. Jika tidak, setel 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 hanya berisi alamat IP lokal, tetapkan 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, tetapkan 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.

Dimensi ini berguna sebagai dimensi "perincian" kedua dengan Grup OS (ax_ua_os_family) untuk melihat versi sistem operasi.

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

Saat menggunakan produk perutean seperti Akamai untuk mengambil alamat IP klien yang sebenarnya, IP klien diteruskan ke Edge di header HTTP True-Client-IP. Dimensi ini mengambil IP klien sebenarnya dari header tersebut.

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

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

Misalnya, target contoh Apigee http://mocktarget.apigee.net mencakup 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 parameter kueri.

Misalnya, target contoh Apigee http://mocktarget.apigee.net mencakup beberapa resource, termasuk resource /user?user={name} dan parameter kueri untuk menampilkan ucapan kustom ke nama yang diberikan. Terlepas dari cara proxy API Anda 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 yang 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 agen pengguna.

Sebaiknya gunakan ini sebagai dimensi "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 parameter 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 ini:

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

target_basepath akan berupa null.

Di Trace tool, saat Anda memilih ikon AX di akhir diagram alur, target.basepath variabel alur dipetakan ke dimensi target_basepath.

Kode status respons HTTP yang ditampilkan oleh layanan target ke proxy API, seperti 200, 404, 503, dan sebagainya.

Nilai "null" berarti permintaan tidak pernah mencapai layanan target. Hal ini terjadi saat respons ditayangkan oleh kebijakan Response Cache atau saat terjadi kegagalan dalam pemrosesan permintaan.

Hal ini berbeda dengan dimensi 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 alur.

Dalam proxy chaining dan saat menggunakan script targets (Node.js), target_url di proxy panggilan adalah null.

Daftar alamat IP di header X-Forwarded-For.

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

Berdasarkan jam 24 jam, jam 2 digit saat panggilan API dilakukan. Misalnya, panggilan API yang dilakukan dalam satu jam antara pukul 22.00 dan 23.00, ax_hour_of_day adalah 22.

Nilai waktu dalam UTC.