Halaman ini berlaku untuk Apigee dan Apigee hybrid.
Lihat dokumentasi Apigee Edge.
Topik ini adalah referensi untuk metrik, dimensi, dan filter analisis. Untuk konteks selengkapnya tentang penggunaannya, lihat Ringkasan Analytics API.
Topik ini menampilkan nama metrik dan dimensi seperti yang muncul di UI dan seperti yang Anda perlukan untuk menggunakannya dalam panggilan API.
- Anda akan melihat nama UI saat membuat dan mengelola laporan kustom.
- Gunakan nama khusus API saat mendapatkan metrik, membuat definisi laporan, atau memperbarui definisi laporan.
Metrik
Berikut adalah metrik API yang dapat Anda ambil dalam laporan kustom dan panggilan Apigee API.
Metrik | Nama yang akan digunakan di Apigee API | Functions | Deskripsi |
---|---|---|---|
Transaksi rata-rata per detik | tps |
Tidak ada |
Jumlah rata-rata transaksi, yang berarti permintaan proxy API, per detik. Perhatikan bahwa jika Anda memiliki jumlah transaksi yang relatif rendah selama jangka waktu tertentu, jumlah rata-rata transaksi per detik dapat tampak nol dalam laporan kustom UI jika jumlahnya lebih kecil dari dua tempat desimal. Sintaksis API: |
Cache hit | cache_hit |
jumlah |
Jumlah permintaan API yang berhasil yang menggunakan Sintaksis API: |
Jumlah elemen Cache L1 | ax_cache_l1_count |
rata-rata, minimum, maksimum |
Jumlah elemen dalam cache L1 (dalam memori) per transaksi selama jangka waktu
tertentu. Misalnya, jika Anda memilih Sintaksis API: |
Error kebijakan | policy_error |
jumlah |
Jumlah total error kebijakan selama jangka waktu yang ditentukan. Error kebijakan biasanya terjadi karena desain. Misalnya, kebijakan Error kebijakan dicatat dalam analisis hanya jika error tersebut menyebabkan kegagalan proxy API.
Misalnya, jika atribut Dimensi Nama Kebijakan saat Error ( Kegagalan target (seperti Sintaksis API: |
Error proxy | is_error |
jumlah |
Jumlah total kegagalan proxy API selama jangka waktu yang ditentukan. Kegagalan proxy dapat terjadi saat kebijakan gagal atau saat terjadi kegagalan runtime, seperti Dimensi Proxy ( Sintaksis API: |
Latensi pemrosesan permintaan | request_processing_latency |
rata-rata, minimum, maksimum |
Jumlah waktu (rata-rata, minimum, atau maksimum), dalam milidetik, yang diperlukan Apigee untuk memproses permintaan masuk. Waktu dimulai saat permintaan mencapai Apigee dan berakhir saat Apigee 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: |
Ukuran permintaan | request_size |
sum, avg, min, max |
Ukuran payload permintaan yang diterima oleh Apigee, dalam byte. Sintaksis API: |
Cache respons dieksekusi | ax_cache_executed |
jumlah |
Total frekuensi kebijakan Karena kebijakan Namun, eksekusi cache respons adalah 0 jika elemen Di Alat debug,
Anda dapat mengklik ikon Sintaksis API: |
Latensi pemrosesan respons | response_processing_latency |
rata-rata, minimum, maksimum |
Jumlah waktu (rata-rata, minimum, atau maksimum), dalam milidetik, yang diperlukan Apigee 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: |
Ukuran respons | response_size |
sum, avg, min, max |
Ukuran payload respons yang ditampilkan ke klien, dalam byte. Sintaksis API: |
Error target | target_error |
jumlah |
Jumlah total respons Sintaksis API: |
Target waktu respons | target_response_time |
sum, avg, min, max |
Jumlah waktu (jumlah, rata-rata, minimum, atau maksimum), dalam milidetik, yang diperlukan server target untuk merespons panggilan. Metrik ini memberi tahu Anda performa server target. Waktu dimulai saat Apigee meneruskan permintaan ke layanan target dan berakhir saat Apigee menerima respons. Perhatikan bahwa jika panggilan API menampilkan respons dari cache (misalnya, menggunakan kebijakan Sintaksis API: |
Total waktu respons | total_response_time |
sum, avg, min, max |
Jumlah waktu (jumlah, rata-rata, minimum, atau maksimum), dalam milidetik, dari saat Apigee menerima permintaan dari klien hingga saat Apigee mengirim respons kembali ke klien. Waktu ini mencakup overhead jaringan (seperti waktu yang diperlukan load balancer dan router untuk melakukan tugasnya), latensi pemrosesan permintaan, latensi pemrosesan respons, dan waktu respons target (jika respons ditayangkan dari layanan target, bukan cache). Dengan menggunakan dimensi yang berbeda, Anda dapat memeriksa latensi pemrosesan menurut proxy API, aplikasi developer, region, dan sebagainya. Sintaksis API: |
Traffic | message_count |
jumlah |
Jumlah total panggilan API yang diproses oleh Apigee dalam jangka waktu yang ditentukan. Gunakan dimensi untuk mengelompokkan jumlah traffic dengan cara yang paling bermakna bagi Anda. Sintaksis API: |
Monetisasi | |||
Biaya | fees |
sum, avg, min, max |
Jumlah yang mewakili biaya penyiapan, biaya berulang, atau penambahan saldo prabayar. Sintaksis API: |
Bagi hasil developer | x_apigee_mintng_dev_share |
sum, avg, min, max |
Bagian developer dalam pendapatan transaksi. Apigee menghitung bagian developer hanya jika Anda telah mengaktifkan pembagian keuntungan dalam paket tarif. Bagian developer dihitung menggunakan formula berikut: x_apigee_mintng_dev_share = revShareGrossPrice * (share percentage)
Nilai persentase pembagian diambil dari paket tarif Anda. Sintaksis API: |
Harga monetisasi | x_apigee_mintng_price |
sum, avg, min, max |
Total pendapatan transaksi.
Pendapatan transaksi ditetapkan ke nilai variabel monetisasi Sintaksis API: |
Pengganda harga API | x_apigee_mintng_price_multiplier |
sum, avg, min, max |
Faktor (pengganda) yang digunakan untuk mengalikan biaya per transaksi. Biaya per transaksi ditentukan dalam harga Biaya berbasis konsumsi paket tarif. Sintaksis API: |
Rasio monetisasi | x_apigee_mintng_rate |
sum, avg, min, max |
Tarif yang ditagih untuk transaksi. Tarif yang dikenakan untuk transaksi dihitung menggunakan formula berikut: x_apigee_mintng_rate = (consumption-based pricing rate) * perUnitPriceMultiplier value
Nilai tarif harga berbasis penggunaan diambil dari paket tarif Anda dan nilai Sintaksis API: |
Dimensi
Dimensi memungkinkan Anda melihat metrik dalam pengelompokan yang bermakna. Misalnya, melihat jumlah traffic total menjadi jauh lebih efektif jika Anda melihatnya untuk setiap aplikasi developer atau proxy API.
Berikut adalah dimensi yang disediakan Apigee secara otomatis.
Dimensi | Nama yang akan digunakan di Apigee API | Deskripsi |
---|---|---|
Token Akses | access_token |
Token akses OAuth pengguna akhir aplikasi. |
Produk API | api_product |
|
Kunci Cache | ax_cache_key |
Kunci yang berisi nilai Di Alat debug, saat memilih kebijakan |
Nama Cache | ax_cache_name |
Nama cache yang berisi kunci/nilai yang digunakan oleh kebijakan Di Alat debug,
saat memilih kebijakan |
Sumber Cache | ax_cache_source |
Level cache (database L1 dalam memori atau L2) tempat Di Alat debug,
saat memilih kebijakan Untuk mengetahui informasi selengkapnya tentang tingkat cache, lihat Internal cache. |
ID Klien | client_id |
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 terdaftar di Apigee. Untuk mengetahui informasi selengkapnya, lihat Bagaimana cara membuat data analisis lengkap?. Jika kriteria di atas tidak terpenuhi, Anda akan melihat nilai |
Aplikasi Developer | developer_app |
Aplikasi developer terdaftar di Apigee 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 mengetahui informasi selengkapnya, lihat Bagaimana cara membuat data analisis lengkap?. Jika kriteria di atas tidak terpenuhi, Anda akan melihat nilai |
Email Developer | developer_email |
|
ID Developer | developer |
ID developer unik yang dibuat Apigee dalam bentuk
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 Bagaimana cara membuat data analisis lengkap?. Jika kriteria di atas tidak terpenuhi, Anda akan melihat nilai |
Lingkungan | environment |
Lingkungan Apigee tempat proxy API di-deploy. Misalnya test atau prod . |
Kode Error saat Terjadi Error | ax_edge_execution_fault_code |
Kode error dari error. Contoh: |
Nama Alur saat Terjadi Error | ax_execution_fault |
Alur bernama di
proxy API yang menimbulkan error. Misalnya, Perhatikan bahwa nama lengkap yang akan digunakan di Apigee API adalah
Jika tidak ada error yang terjadi, Anda akan melihat nilai |
Resource Flow | flow_resource |
Khusus penggunaan Apigee. Lihat Cara menggunakan Dimensi "Aliran Resource" di Analytics jika Anda ingin tahu. |
Status Alur saat Terjadi Error | ax_execution_fault |
Nama status alur proxy API yang memunculkan error, seperti Perhatikan bahwa nama lengkap yang akan digunakan di Apigee API adalah |
ID Alur Gateway | gateway_flow_id |
Saat panggilan API berpindah melalui Apigee, setiap panggilan akan mendapatkan ID alur gateway-nya sendiri. Contoh: rrt329ea-12575-114653952-1. ID Alur Gateway berguna untuk membedakan metrik dalam situasi TPS tinggi saat dimensi lain seperti organisasi, lingkungan, dan stempel waktu identik di seluruh panggilan. |
Organisasi | organization |
Organisasi Apigee tempat proxy API di-deploy. |
Nama Kebijakan saat Terjadi Error | ax_execution_fault |
Nama kebijakan yang menampilkan error dan menyebabkan panggilan API gagal. Perhatikan bahwa nama lengkap yang akan digunakan di Apigee API adalah Jika kebijakan menampilkan error, tetapi atribut root kebijakan |
Proxy | apiproxy |
Nama mesin (bukan nama tampilan) proxy API. |
Jalur Dasar Proxy | proxy_basepath |
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
Nilai ini juga disimpan di variabel alur |
Jenis Deployment Proxy | proxy_deployment_type |
Jenis proxy API untuk proxy yang di-deploy. Menentukan jenis proxy akan membatasi hasil untuk jenis proxy tersebut. Nilai potensialnya adalah |
Akhiran Jalur Proxy | proxy_pathsuffix |
Jalur resource ditambahkan ke jalur dasar proxy API. Misalnya, jika URL dasar proxy API adalah Jika tidak ada Nilai ini juga disimpan di variabel alur |
Revisi proxy | apiproxy_revision |
Nomor revisi proxy API yang menangani panggilan API. Hal ini tidak selalu berarti revisi terbaru proxy API. Jika proxy API memiliki 10 revisi, revisi ke-8 mungkin saat ini di-deploy. Selain itu, API dapat memiliki beberapa revisi yang di-deploy selama revisi tersebut memiliki Jalur Dasar yang berbeda, seperti yang dijelaskan dalam Men-deploy proxy. |
IP Klien yang Diselesaikan | ax_resolved_client_ip |
Alamat IP klien asal. Nilai dimensi Perhatikan bahwa saat menggunakan produk pemilihan rute seperti Akamai untuk mengambil alamat IP sebenarnya klien,
alamat IP klien diteruskan ke Apigee di header HTTP Nilai dimensi
|
Kode Status Respons | response_status_code |
Kode status respons HTTP yang diteruskan dari Apigee ke klien, seperti 200 , 404 ,
503 , dan sebagainya. Di Apigee, kode status respons dari target dapat ditimpa dengan kebijakan seperti kebijakan AssignMessage dan kebijakan RaiseFault, itulah sebabnya dimensi ini dapat berbeda dari Kode Respons Target (target_response_code). |
Host Virtual | virtual_host |
Nama host virtual tempat panggilan API dilakukan. Untuk mengetahui informasi selengkapnya, lihat Tentang lingkungan dan grup lingkungan. |
Inbound/Klien | ||
Alamat IP Klien | client_ip |
Alamat IP sistem yang mengakses router, seperti klien asli
(proxy_client_ip) atau load balancer. Jika ada beberapa IP di header X-Forwarded-For , ini adalah IP terakhir yang tercantum. |
Kategori Perangkat | ax_ua_device_category |
Jenis perangkat tempat panggilan API dibuat, seperti Tablet atau Smartphone . |
Grup OS | ax_ua_os_family |
Kelompok sistem operasi perangkat yang melakukan panggilan, seperti Android atau
iOS . |
Versi OS | ax_ua_os_version |
Versi sistem operasi perangkat yang melakukan panggilan. Sebaiknya gunakan dimensi ini sebagai dimensi perincian kedua dengan Grup OS (ax_ua_os_family) untuk melihat versi sistem operasi. |
IP Klien Proxy | proxy_client_ip |
Alamat IP klien yang memanggil, disimpan dalam variabel alur |
IP Klien yang Dirujuk | ax_true_client_ip |
Saat menggunakan produk pemilihan rute seperti Akamai untuk mengambil alamat IP sebenarnya klien,
IP klien akan diteruskan ke Apigee di header HTTP Untuk menentukan Alamat IP klien asli, yang diakses melalui dimensi |
Jalur Permintaan | request_path |
Jalur resource (tidak termasuk domain) ke layanan target, tidak termasuk parameter kueri. Misalnya, contoh target |
URI Permintaan | request_uri |
Jalur resource (tidak termasuk domain) ke layanan target, termasuk parameter kueri. Misalnya, contoh target |
Kata Kerja Permintaan | request_verb |
Kata kerja permintaan HTTP dalam permintaan API, seperti GET, POST, PUT, DELETE. |
Agen Pengguna | useragent |
Nama agen pengguna, atau agen software, yang digunakan untuk melakukan panggilan API. Contoh:
|
Kelompok Agen Pengguna | ax_ua_agent_family |
Keluarga agen pengguna, seperti Chrome Mobile atau curl . |
Jenis Agen Pengguna | ax_ua_agent_type |
Jenis user-agent, seperti Browser , Mobile Browser , Library , dan sebagainya. |
Versi Agen Pengguna | ax_ua_agent_version |
Versi user-agent. Sebaiknya gunakan ini sebagai dimensi perincian kedua dengan Agen Keluarga Pengguna (ax_ua_agent_family) untuk mendapatkan versi keluarga agen. |
Outbound/Target | ||
Target | target |
Endpoint target yang menangani permintaan. Misalnya, default . |
Jalur Dasar Target | target_basepath |
Jalur resource (tidak termasuk domain) ke layanan target, tidak termasuk parameter kueri, yang ditentukan dalam 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 Jika targetnya adalah: <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net</URL> </HTTPTargetConnection> target_basepath akan menjadi null. Di Alat debug, saat Anda
memilih ikon AX di akhir diagram alur, |
Nama Layanan gRPC | x_apigee_grpc_service_name |
Hanya berlaku jika layanan target adalah gRPC. Nama layanan gRPC. Untuk informasi tentang proxy gRPC, lihat Membuat proxy gRPC API. |
Status gRPC | x_apigee_grpc_status |
Hanya berlaku jika layanan target adalah gRPC. Status permintaan gRPC. Untuk informasi tentang proxy gRPC, lihat Membuat proxy gRPC API. |
Host Target | target_host |
Host layanan target. Misalnya, jika proxy API memanggil
http://mocktarget.apigee.net/help , target_host adalah
mocktarget.apigee.net . |
Alamat IP Target | target_ip |
Alamat IP layanan target yang menampilkan respons ke proxy API. |
Kode Respons Target | target_response_code |
Kode status respons HTTP yang ditampilkan oleh layanan target ke proxy API, seperti
Nilai Dimensi ini berbeda dengan dimensi Kode Status Respons (response_status_code). |
Nama RPC gRPC | x_apigee_grpc_rpc_name |
Hanya berlaku jika layanan target adalah gRPC. Nama RPC. Untuk informasi tentang proxy gRPC, lihat Membuat proxy gRPC API. |
URL Target | target_url |
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
Perhatikan bahwa URL juga dapat diganti selama pemrosesan proxy API dengan
variabel alur Dalam rantai proxy, target_url di proxy panggilan bernilai null. |
IP X-Forwarded-For | x_forwarded_for_ip |
Daftar alamat IP di header Untuk menentukan Alamat IP klien asli, yang diakses melalui dimensi |
Proto X-Forwarded-For | x_forwarded_proto |
Protokol yang digunakan klien untuk terhubung ke router. Nilai yang valid mencakup |
Waktu | ||
Hari | ax_day_of_week |
Singkatan hari dalam seminggu yang terdiri dari tiga huruf tempat panggilan API dilakukan. Misalnya, Sen, Sel, Rab. |
Bulan | ax_month_of_year |
Bulan numerik saat panggilan API dilakukan. Misalnya, 03 untuk bulan Maret. |
Waktu | ax_hour_of_day |
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 akan menjadi 22. Nilai waktu dalam UTC. |
Zona Waktu | ax_geo_timezone |
Nama umum zona waktu tempat panggilan API dibuat, seperti
America/New_York dan Europe/Dublin . |
Minggu | ax_week_of_month |
Minggu numerik dalam sebulan. Misalnya, untuk panggilan API yang dilakukan pada minggu ke-3
dalam sebulan, ax_week_of_month adalah 3. |
Location | ||
Kota | ax_geo_city |
Kota tempat panggilan API dilakukan. |
Benua | ax_geo_continent |
Kode dua huruf dari benua tempat panggilan API dilakukan. Misalnya,
NA untuk Amerika Utara. |
Negara | ax_geo_country |
Kode dua huruf negara tempat panggilan API dilakukan. Misalnya, US
untuk Amerika Serikat. |
Wilayah Geografis | ax_geo_region |
Kode dengan tanda hubung untuk wilayah geografis, seperti STATE-COUNTRY . Misalnya,
WA-US untuk Washington-Amerika Serikat. |
Wilayah | ax_dn_region |
Nama pusat data Apigee tempat proxy API di-deploy, seperti
us-east-1 . |
Monetisasi | ||
Dibuat | created |
Saat ini tersedia di organisasi Apigee, bukan organisasi Apigee hybrid. Stempel Waktu Unix saat jadwal biaya ditambahkan untuk developer aplikasi dan produk API. |
Jenis biaya | fees_type |
Jenis biaya. Biaya ini dapat berupa biaya penyiapan, biaya berulang, atau penambahan saldo prabayar. Nilai ini
hanya diisi jika Anda telah memilih metrik Fees . |
Mata uang pendapatan | x_apigee_mintng_currency |
|
ID paket tarif | x_apigee_mintng_rate_plan_id |
Saat ini tersedia di organisasi Apigee, bukan organisasi Apigee hybrid. Paket tarif monetisasi untuk developer aplikasi. |
Transaksi berhasil | x_apigee_mintng_tx_success |
Status monetisasi transaksi ditetapkan ke nilai variabel monetisasi transactionSuccess yang diambil dalam kebijakan DataCapture Anda. |
Filter
Filter memungkinkan Anda membatasi hasil ke metrik dengan karakteristik tertentu. Berikut adalah beberapa contoh filter. Gunakan nama bergaya API metrik dan dimensi saat menentukan filter.
Menampilkan metrik untuk proxy API dengan nama buku atau musik:
filter=(apiproxy in 'books','music')
Menampilkan metrik untuk proxy API dengan nama yang diawali dengan m
:
filter=(apiproxy like 'm%')
Menampilkan metrik untuk proxy API dengan nama yang tidak diawali dengan m
:
filter=(apiproxy not like 'm%')
Menampilkan metrik untuk panggilan API dengan kode status respons antara 400
dan 599
:
filter=(response_status_code ge 400 and response_status_code le 599)
Menampilkan metrik untuk panggilan API dengan kode status respons 200
dan kode respons target
404
:
filter=(response_status_code eq 200 and target_response_code eq 404)
Menampilkan metrik untuk panggilan API dengan kode status respons 500
:
filter=(response_status_code eq 500)
Menampilkan metrik untuk panggilan API yang tidak menghasilkan error:
filter=(is_error eq 0)
Menampilkan metrik untuk panggilan API yang tidak menghasilkan respons null
:
filter=(response_status_code isnot null)
Berikut adalah operator yang dapat Anda gunakan untuk membuat filter laporan.
Operator | Deskripsi |
---|---|
in |
Sertakan dalam daftar |
notin |
Kecualikan dari daftar |
is |
Gunakan response_status_code is null untuk memfilter respons yang kode statusnya
adalah null . |
isnot |
Gunakan response_status_code isnot null untuk memfilter respons yang kode statusnya bukan null . |
eq |
Sama dengan, == |
ne |
Tidak sama dengan, != |
gt |
Lebih dari, > |
lt |
Kurang dari, < |
ge |
Lebih dari atau sama dengan, >= |
le |
Kurang dari atau sama dengan, <= |
like |
Menampilkan true jika pola string cocok dengan pola yang diberikan. |
not like |
Menampilkan nilai salah jika pola string cocok dengan pola yang disediakan. |
similar to |
Menampilkan nilai benar atau salah, bergantung pada apakah polanya cocok dengan string yang diberikan. Fungsi ini mirip dengan like , kecuali bahwa fungsi ini menafsirkan pola menggunakan definisi ekspresi reguler standar SQL. |
not similar to |
Menampilkan nilai salah atau benar, bergantung pada apakah polanya cocok dengan string yang diberikan. Ini mirip dengan not like , kecuali bahwa ekspresi ini menafsirkan pola menggunakan definisi ekspresi reguler standar SQL. |
and |
Memungkinkan Anda menggunakan logika AND untuk menyertakan lebih dari satu ekspresi filter. Filter
menyertakan data yang memenuhi semua kondisi. |
or |
Memungkinkan Anda menggunakan logika OR untuk mengevaluasi berbagai kemungkinan ekspresi filter. Filter ini
menyertakan data yang memenuhi minimal salah satu kondisi. |