發出自訂計量
適用於:所有 APIM 層
emit-metric
原則會將自訂計量以指定的格式傳送至 Application Insights。
注意
請依照原則陳述式中提供的順序,來設定原則的元素和子元素。 深入了解如何設定或編輯 APIM 原則。
自訂計量的限制
Azure 監視器會針對自訂計量施加使用量限制,其可能會對您從 APIM 發出計量的能力產生影響。 例如,Azure 監視器目前會為每個計量設定 10 個維度索引鍵的限制,以及為訂用帳戶中的每個區域設定總計 50,000 個使用中時間序列的限制 (在 12 小時內)。
這些限制對於在 API 管理 原則中設定自訂計量有下列影響,例如 emit-metric
或 azure-openai-emit-token-metric
:
您可以在每個 原則中最多設定 10 個自訂維度。
原則在 12 小時內所產生的使用中時間序列數目,是在該期間內每個已設定維度之唯一值數目的乘積。 例如,如果在原則中設定了三個自訂維度,而且每個維度在該期間內都有 10 個可能的值,則 原則會提供 1,000 (10 x 10 x 10) 個使用中時間序列。
如果您在位於訂用帳戶相同區域內的多個 APIM 執行個體中設定 原則,則所有執行個體可能都會影響區域使用中時間序列限制。
深入瞭解 Azure 監視器中自定義計量的設計限制和考慮 。
必要條件
- 您的 APIM 執行個體必須與 Application Insights 整合。 如需詳細資訊,請參閱如何整合 Azure APIM 與 Azure Application Insights。
- 為您的 API 啟用 Application Insights 記錄。
- 在 Application Insights 中啟用維度的自訂計量。 如需詳細資訊,請參閱發出自訂計量。
原則陳述式
<emit-metric name="name of custom metric" value="value of custom metric" namespace="metric namespace">
<dimension name="dimension name" value="dimension value" />
</emit-metric>
屬性
屬性 | 描述 | 必要 | 預設值 |
---|---|---|---|
NAME | 字串。 自訂計量的名稱。 不允許使用原則運算式。 | Yes | N/A |
命名空間 | 字串。 自訂計量的命名空間。 不允許使用原則運算式。 | No | API 管理 |
value | 以雙精度浮點數表示的自訂計量值。 允許使用原則運算式。 | No | 1 |
元素
元素 | 描述 | 必要 |
---|---|---|
維度 | 為自訂計量中包含的每個維度新增一或多個這些元素。 | Yes |
維度屬性
屬性 | 描述 | 必要 | 預設值 |
---|---|---|---|
NAME | 字串或原則運算式。 維度的名稱。 | Yes | N/A |
value | 字串或原則運算式。 維度的值。 只有在 name 符合其中一個預設維度時,才能省略。 若是如此,則會根據維度名稱提供值。 |
No | N/A |
無需值即可使用的預設維度名稱
- API 識別碼
- 作業識別碼
- 產品識別碼
- 使用者識別碼
- 訂用帳戶識別碼
- Location
- 閘道識別碼
使用方式
使用注意事項
- 您最多可以為此原則設定10 個自訂維度。
範例
下列範例會傳送自定義計量,以將 API 要求數目以及 API 識別碼計算為自定義維度。
<policies>
<inbound>
<emit-metric name="Request" value="1" namespace="my-metrics">
<dimension name="API ID" />
</emit-metric>
</inbound>
<outbound>
</outbound>
</policies>
相關原則
相關內容
如需使用原則的詳細資訊,請參閱:
- 教學課程:轉換及保護 API
- 原則參考,取得原則陳述式及其設定的完整清單
- 原則運算式
- 設定或編輯原則
- 重複使用原則設定
- 原則程式碼片段存放庫 (英文)
- Azure API 管理 原則工具組
- 使用 Microsoft Azure Copilot 撰寫原則