Mengeluarkan metrik kustom
BERLAKU UNTUK: Semua tingkatAN API Management
emit-metric
Kebijakan mengirimkan metrik kustom dalam format yang ditentukan ke Application Insights.
Catatan
Tetapkan elemen kebijakan dan elemen turunan dalam urutan yang disediakan dalam pernyataan kebijakan. Pelajari lebih lanjut cara mengatur atau mengedit kebijakan API Management.
Batas metrik kustom
Azure Monitor memberlakukan batas penggunaan untuk metrik kustom yang dapat memengaruhi kemampuan Anda untuk memancarkan metrik dari API Management. Misalnya, Azure Monitor saat ini menetapkan batas 10 kunci dimensi per metrik, dan batas 50.000 total rangkaian waktu aktif per wilayah dalam langganan (dalam periode 12 jam).
Batas ini memiliki implikasi berikut untuk mengonfigurasi metrik kustom dalam kebijakan API Management seperti emit-metric
atau azure-openai-emit-token-metric
:
Anda dapat mengonfigurasi maksimum 10 dimensi kustom per kebijakan.
Jumlah rangkaian waktu aktif yang dihasilkan oleh kebijakan dalam periode 12 jam adalah produk dari jumlah nilai unik dari setiap dimensi yang dikonfigurasi selama periode tersebut. Misalnya, jika tiga dimensi kustom dikonfigurasi dalam kebijakan, dan setiap dimensi memiliki 10 nilai yang mungkin dalam periode tersebut, kebijakan akan berkontribusi 1.000 (10 x 10 x 10) rangkaian waktu aktif.
Jika Anda mengonfigurasi kebijakan dalam beberapa instans API Management yang berada di wilayah yang sama dalam langganan, semua instans dapat berkontribusi pada batas rangkaian waktu aktif regional.
Pelajari selengkapnya tentang batasan dan pertimbangan desain untuk metrik kustom di Azure Monitor.
Prasyarat
- Instans API Management Anda harus terintegrasi dengan Application insights. Untuk informasi selengkapnya, lihat Cara mengintegrasikan Azure API Management dengan Azure Application Insights.
- Aktifkan pengelogan Application Insights untuk API Anda.
- Aktifkan metrik kustom dengan dimensi di Application Insights. Untuk informasi selengkapnya, lihat Memancarkan metrik kustom.
Pernyataan kebijakan
<emit-metric name="name of custom metric" value="value of custom metric" namespace="metric namespace">
<dimension name="dimension name" value="dimension value" />
</emit-metric>
Atribut
Atribut | Deskripsi | Wajib diisi | Nilai default |
---|---|---|---|
nama | String . Nama metrik kustom. Ekspresi kebijakan tidak diizinkan. | Ya | T/A |
namespace | String . Namespace metrik kustom. Ekspresi kebijakan tidak diizinkan. | No | API Management |
value | Nilai metrik kustom yang dinyatakan sebagai ganda. Ekspresi kebijakan diizinkan. | No | 1 |
Elemen
Elemen | Deskripsi | Wajib diisi |
---|---|---|
dimensi | Tambahkan satu atau beberapa elemen ini untuk setiap dimensi yang disertakan dalam metrik kustom. | Ya |
atribut dimensi
Atribut | Deskripsi | Wajib diisi | Nilai default |
---|---|---|---|
nama | String atau ekspresi kebijakan. Nama dimensi. | Ya | T/A |
value | String atau ekspresi kebijakan. Nilai dimensi. Hanya dapat dihilangkan jika name cocok dengan salah satu dimensi default. Jika demikian, nilai disediakan berdasarkan nama dimensi. |
No | T/A |
Nama dimensi default yang dapat digunakan tanpa nilai
- ID API
- ID Operasi
- ID Produk
- Id Pengguna
- ID Langganan
- Lokasi
- ID Gateway
Penggunaan
- Bagian kebijakan: masuk, keluar, backend, saat terjadi kesalahan
- Cakupan kebijakan: global, ruang kerja, produk, API, operasi
- Gateway: klasik, v2, konsumsi, dihost sendiri, ruang kerja
Catatan penggunaan
- Anda dapat mengonfigurasi paling banyak 10 dimensi kustom untuk kebijakan ini.
Contoh
Contoh berikut mengirimkan metrik kustom untuk menghitung jumlah permintaan API bersama dengan ID API sebagai dimensi kustom.
<policies>
<inbound>
<emit-metric name="Request" value="1" namespace="my-metrics">
<dimension name="API ID" />
</emit-metric>
</inbound>
<outbound>
</outbound>
</policies>
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 di Azure