Ausgabe benutzerdefinierter Metriken
GILT FÜR: Alle API Management-Ebenen
Die Richtlinie emit-metric
sendet benutzerdefinierte Metriken im angegebenen Format an Application Insights.
Hinweis
- Benutzerdefinierte Metriken sind ein Vorschaufeature von Azure Monitor und unterliegen Einschränkungen.
- Weitere Informationen zu den API Management-Daten, die Application Insights hinzugefügt wurden, finden Sie unter Vorgehensweise beim Integrieren von Azure API Management in Azure Application Insights.
Hinweis
Legen Sie die Elemente und untergeordneten Elemente einer Richtlinie in der Reihenfolge fest, die in der Richtlinienanweisung angegeben ist. Erfahren Sie mehr darüber, wie Sie API Management-Richtlinien festlegen oder bearbeiten.
Richtlinienanweisung
<emit-metric name="name of custom metric" value="value of custom metric" namespace="metric namespace">
<dimension name="dimension name" value="dimension value" />
</emit-metric>
Attribute
Attribut | BESCHREIBUNG | Erforderlich | Standardwert |
---|---|---|---|
name | Eine Zeichenfolge. Der Name der benutzerdefinierten Metrik. Richtlinienausdrücke sind nicht zulässig. | Ja | – |
Namespace | Eine Zeichenfolge. Der Namespace der benutzerdefinierten Metrik. Richtlinienausdrücke sind nicht zulässig. | Nein | API Management |
value | Wert der benutzerdefinierten Metrik, ausgedrückt als Double. Richtlinienausdrücke sind zulässig. | Nein | 1 |
Elemente
Element | BESCHREIBUNG | Erforderlich |
---|---|---|
dimension | Fügen Sie mindestens eines dieser Elemente für jede Dimension hinzu, die in der benutzerdefinierten Metrik enthalten ist. | Ja |
Dimensionsattribute
attribute | BESCHREIBUNG | Erforderlich | Standardwert |
---|---|---|---|
name | Eine Zeichenfolge oder ein Richtlinienausdruck. Der Name der Dimension. | Ja | – |
value | Eine Zeichenfolge oder ein Richtlinienausdruck. Der Wert der Dimension. Kann nur ausgelassen werden, wenn name mit einer der Standarddimensionen übereinstimmt. In diesem Fall wird der Wert gemäß Dimensionsname bereitgestellt. |
Nein | – |
Namen von Standarddimensionen, die ohne Wert verwendet werden können
- API-ID
- Vorgangs-ID
- Product ID
- Benutzer-ID
- Abonnement-ID
- Standort-ID
- Gateway-ID
Verwendung
- Richtlinienabschnitte: inbound, outbound, backend, on-error
- Richtlinienbereiche: global, Arbeitsbereich, Produkt, API, Vorgang
- Gateways: classic, v2, consumption, self-hosted
Hinweise zur Verwendung
Sie können maximal 10 benutzerdefinierte Dimensionen für diese Richtlinie konfigurieren.
Das Aufrufen der
emit-metric
-Richtlinie zählt zu den Nutzungsgrenzwerten für benutzerdefinierte Metriken pro Region in einem Abonnement. Weitere Informationen
Beispiel
Im folgenden Beispiel wird eine benutzerdefinierte Metrik gesendet, um die Anzahl von API-Anforderungen gemeinsam mit Benutzer-ID, Client-IP und API-ID als benutzerdefinierte Dimensionen zu bestimmen.
<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>
Verwandte Richtlinien
Zugehöriger Inhalt
Weitere Informationen zum Arbeiten mit Richtlinien finden Sie hier:
- Tutorial: Transformieren und Schützen Ihrer API
- Unter Richtlinien für die API-Verwaltung finden Sie eine komplette Liste der Richtlinienanweisungen und der zugehörigen Einstellungen.
- Richtlinienausdrücke
- Festlegen oder Bearbeiten von Richtlinien
- Wiederverwenden von Richtlinienkonfigurationen
- Repository für Richtliniencodeausschnitte
- Erstellen von Richtlinien mit Microsoft Copilot für Azure