Emituj metryki niestandardowe

  • Artykuł

DOTYCZY: Wszystkie warstwy usługi API Management

Zasady emit-metric wysyła metryki niestandardowe w określonym formacie do aplikacji Szczegółowe informacje.

Uwaga

Uwaga

Ustaw elementy zasad i elementy podrzędne w kolejności podanej w instrukcji zasad. Dowiedz się więcej na temat ustawiania lub edytowania zasad usługi API Management.

Instrukcja zasad

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

Atrybuty

Atrybut opis Wymagania Domyślna wartość
name Ciąg. Nazwa metryki niestandardowej. Wyrażenia zasad nie są dozwolone. Tak Nie dotyczy
namespace Ciąg. Przestrzeń nazw metryki niestandardowej. Wyrażenia zasad nie są dozwolone. Nie. API Management
wartość Wartość metryki niestandardowej wyrażonej jako podwójna. Wyrażenia zasad są dozwolone. Nie. 1

Elementy

Element opis Wymagania
wymiar Dodaj co najmniej jeden z tych elementów dla każdego wymiaru uwzględnionego w metryce niestandardowej. Tak

atrybuty wymiaru

Atrybut opis Wymagania Domyślna wartość
name Ciąg lub wyrażenie zasad. Nazwa wymiaru. Tak Nie dotyczy
wartość Ciąg lub wyrażenie zasad. Wartość wymiaru. Można pominąć tylko wtedy, gdy name pasuje do jednego z wymiarów domyślnych. Jeśli tak, wartość jest podana jako nazwa wymiaru. Nie. Nie dotyczy

Domyślne nazwy wymiarów, które mogą być używane bez wartości

  • Identyfikator interfejsu API
  • Identyfikator operacji
  • Identyfikator produktu
  • Identyfikator użytkownika
  • Identyfikator subskrypcji
  • Identyfikator lokalizacji
  • Identyfikator bramy

Użycie

  • Sekcje zasad: ruch przychodzący, wychodzący, zaplecze, błąd
  • Zakresy zasad: globalny, obszar roboczy, produkt, interfejs API, operacja
  • Bramy: klasyczne, v2, zużycie, self-hosted

Uwagi dotyczące użycia

  • Dla tych zasad można skonfigurować co najwyżej 10 wymiarów niestandardowych.

  • Wywoływanie emit-metric zasad jest uwzględniane w odniesieniu do limitów użycia metryk niestandardowych na region w subskrypcji. Dowiedz się więcej

Przykład

Poniższy przykład wysyła niestandardową metrykę w celu zliczenia liczby żądań interfejsu API wraz z identyfikatorem użytkownika, adresem IP klienta i identyfikatorem interfejsu API jako wymiarami niestandardowymi.

<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>

Powiązana zawartość

Aby uzyskać więcej informacji na temat pracy z zasadami, zobacz: