Udostępnij za pośrednictwem

Emituj metryki niestandardowe

  • Artykuł

DOTYCZY: Wszystkie warstwy usługi API Management

Zasady emit-metric wysyła metryki niestandardowe w określonym formacie do usługi Application Insights.

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.

Limity metryk niestandardowych

Usługa Azure Monitor nakłada limity użycia dla metryk niestandardowych, które mogą mieć wpływ na możliwość emitowania metryk z usługi API Management. Na przykład usługa Azure Monitor obecnie ustawia limit 10 kluczy wymiarów na metrykę i limit 50 000 łącznych aktywnych szeregów czasowych na region w ramach subskrypcji (w okresie 12 godzin).

Te limity mają następujące konsekwencje dotyczące konfigurowania metryk niestandardowych w zasadach usługi API Management, takich jak emit-metric lub azure-openai-emit-token-metric:

  • Można skonfigurować maksymalnie 10 wymiarów niestandardowych na zasady.

  • Liczba aktywnych szeregów czasowych wygenerowanych przez zasady w okresie 12 godzin jest produktem liczby unikatowych wartości każdego skonfigurowanego wymiaru w danym okresie. Jeśli na przykład w zasadach skonfigurowano trzy wymiary niestandardowe, a każdy wymiar miał 10 możliwych wartości w danym okresie, zasady współtworzyłyby 1000 (10 x 10 x 10) aktywnych szeregów czasowych.

  • Jeśli skonfigurujesz zasady w wielu wystąpieniach usługi API Management, które znajdują się w tym samym regionie w ramach subskrypcji, wszystkie wystąpienia mogą współtworzyć regionalny aktywny limit szeregów czasowych.

Dowiedz się więcej o ograniczeniach i zagadnieniach dotyczących projektowania metryk niestandardowych w usłudze Azure Monitor.

Wymagania wstępne

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
  • Lokalizacja
  • 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, obszar roboczy

Uwagi dotyczące użycia

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

Przykład

Poniższy przykład wysyła niestandardową metrykę, aby zliczyć liczbę żądań interfejsu API wraz z identyfikatorem interfejsu API jako wymiarem niestandardowym.

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

Powiązana zawartość

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