Freigeben über

Ausgabe benutzerdefinierter Metriken

GILT FÜR: Alle API Management-Ebenen

Die Richtlinie emit-metric sendet benutzerdefinierte Metriken im angegebenen Format an Application Insights.

Note

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.

Grenzwerte für benutzerdefinierte Metriken

Azure Monitor legt Nutzungsgrenzwerte für benutzerdefinierte Metriken fest, die sich auf ihre Fähigkeit auswirken können, Metriken aus API Management auszugeben. Beispielsweise legt Azure Monitor derzeit einen Grenzwert von 10 Dimensionsschlüsseln pro Metrik und einen Grenzwert von insgesamt 50.000 aktiven Zeitreihen pro Region in einem Abonnement fest (innerhalb eines Zeitraums von 12 Stunden). In der API-Verwaltung werden 5 dieser Elemente für Standardabmessungen verwendet, einschließlich der folgenden:

  • Region
  • Service ID
  • Service Name
  • Service Type

Diese Grenzwerte haben die folgenden Auswirkungen auf die Konfiguration benutzerdefinierter Metriken in API Management wie emit-metric und azure-openai-emit-token-metric:

  • Sie können maximal 5 benutzerdefinierte Dimensionen pro Richtlinie konfigurieren.

  • Die Anzahl der aktiven Zeitreihen, die von der -Richtlinie innerhalb eines Zeitraums von 12 Stunden generiert werden, ist das Produkt der Anzahl eindeutiger Werte jeder konfigurierten Dimension während des Zeitraums. Wenn beispielsweise drei benutzerdefinierte Dimensionen in der Richtlinie konfiguriert wurden und jede Dimension innerhalb des Zeitraums 10 mögliche Werte aufweist, würde die  Richtlinie 1.000 (10 x 10 x 10) aktive Zeitreihen beitragen.

  • Wenn Sie die -Richtlinie in mehreren API Management-Instanzen konfigurieren, die sich in derselben Region in einem Abonnement befinden, können alle Instanzen zum regionalen aktiven Zeitreihengrenzwert beitragen.

Erfahren Sie mehr über Entwurfsbeschränkungen und -überlegungen für benutzerdefinierte Metriken in Azure Monitor.

Prerequisites

Policy statement

<emit-metric name="name of custom metric" value="value of custom metric" namespace="metric namespace"> 
    <dimension name="dimension name" value="dimension value" /> 
</emit-metric>

Attributes

Attribute Description Required Default value
name A string. Der Name der benutzerdefinierten Metrik. Richtlinienausdrücke sind nicht zulässig. Yes N/A
namespace A string. Der Namespace der benutzerdefinierten Metrik. Richtlinienausdrücke sind nicht zulässig. No API Management
value Wert der benutzerdefinierten Metrik, ausgedrückt als Double. Richtlinienausdrücke sind zulässig. No 1

Elements

Element Description Required
dimension Fügen Sie mindestens eines dieser Elemente für jede Dimension hinzu, die in der benutzerdefinierten Metrik enthalten ist. Yes

Dimension attributes

Attribute Description Required Default value
name Eine Zeichenfolge oder ein Richtlinienausdruck. Der Name der Dimension. Yes N/A
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. No N/A

Namen von Standarddimensionen, die ohne Wert verwendet werden können

  • API ID
  • Operation ID
  • Product ID
  • User ID
  • Subscription ID
  • Location
  • Gateway ID
  • Back-End-ID (nur im Abschnitt "Ausgehende Richtlinie verwenden")

Usage

Usage notes

  • Sie können maximal fünf benutzerdefinierte Dimensionen für diese Richtlinie konfigurieren.

Example

Im folgenden Beispiel wird eine benutzerdefinierte Metrik gesendet, um die Anzahl der API-Anforderungen zusammen mit der API-ID als Standarddimension zu zählen.

<policies>
  <inbound>
    <emit-metric name="Request" value="1" namespace="my-metrics"> 
        <dimension name="API ID" /> 
    </emit-metric> 
  </inbound>
  <outbound>
  </outbound>
</policies>

Related content

Weitere Informationen zum Arbeiten mit Richtlinien finden Sie hier: