カスタム メトリックを出力する
適用対象: すべての API Management レベル
emit-metric
ポリシーにより、指定された形式のカスタム メトリックが Application Insights に送信されます。
Note
- カスタム メトリックは、Azure Monitor のプレビュー機能であり、制限が適用されます。
- Application Insights に追加された API Management データの詳細については、「Azure API Management と Azure Application Insights を統合する方法」を参照してください。
Note
ポリシーの要素と子要素を、ポリシー ステートメントで指定された順序で設定します。 API Management ポリシーを設定または編集する方法について説明します。
ポリシー ステートメント
<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 | 文字列。 カスタム メトリックの名前。 ポリシー式は使用できません。 | はい | 該当なし |
namespace | 文字列。 カスタム メトリックの名前空間。 ポリシー式は使用できません。 | いいえ | API Management |
値 | Double で表されるカスタム メトリックの値。 ポリシー式を使用できます。 | いいえ | 1 |
要素
要素 | 説明 | 必須 |
---|---|---|
ディメンション | カスタム メトリックに含まれるディメンションごとに、これらの要素を 1 つ以上追加します。 | はい |
dimension の属性
属性 | 説明 | 必須 | 既定値 |
---|---|---|---|
name | 文字列またはポリシー式。 ディメンションの名前。 | はい | 該当なし |
value | 文字列またはポリシー式。 ディメンションの値。 省略できるのは、name が既定のディメンションのいずれかと一致する場合のみです。 その場合、ディメンション名に従って値が指定されます。 |
いいえ | 該当なし |
値なしで使用できる既定のディメンション名
- API ID
- 操作 ID
- Product ID
- User ID
- サブスクリプション ID
- 場所 ID
- ゲートウェイ ID
使用法
- ポリシー セクション: inbound、outbound、backend、on-error
- ポリシー スコープ: グローバル、ワークスペース、製品、API、操作
- ゲートウェイ: クラシック、v2、従量課金、セルフホステッド
使用上の注意
このポリシーには、最大 10 個のカスタム ディメンションを構成できます。
emit-metric
ポリシーの呼び出しは、サブスクリプションのリージョンあたりのカスタム メトリックの使用制限にカウントされます。 詳細情報
例
次の例では、ユーザー ID、クライアント IP、API ID をカスタム ディメンションとして、API 要求数をカウントするカスタム メトリックを送信します。
<policies>
<inbound>
<emit-metric name="Request" value="1" namespace="my-metrics">
<dimension name="User ID" />
<dimension name="Client IP" value="@(context.Request.IpAddress)" />
<dimension name="API ID" />
</emit-metric>
</inbound>
<outbound>
</outbound>
</policies>
関連ポリシー
関連するコンテンツ
ポリシーに対する処理の詳細については、次のトピックを参照してください。
- チュートリアル:API を変換および保護する
- ポリシー ステートメントとその設定の一覧に関するポリシー リファレンス
- ポリシー式
- ポリシーの設定または編集
- ポリシー構成を再利用する
- ポリシー スニペットのリポジトリ
- Microsoft Copilot for Azure を使用してポリシーを作成する