Udostępnij przez

Emituj metryki niestandardowe

DOTYCZY: Wszystkie warstwy usługi API Management

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

Note

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). W usłudze API Management 5 z nich są używane dla wymiarów domyślnych, w tym następujących:

  • Region
  • Service ID
  • Service Name
  • Service Type

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

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. Nazwa metryki niestandardowej. Wyrażenia zasad nie są dozwolone. Yes N/A
obszar nazw A string. Przestrzeń nazw metryki niestandardowej. Wyrażenia zasad nie są dozwolone. No API Management
value Wartość metryki niestandardowej wyrażonej jako podwójna. Wyrażenia zasad są dozwolone. No 1

Elements

Element Description Required
dimension Dodaj co najmniej jeden z tych elementów dla każdego wymiaru uwzględnionego w metryce niestandardowej. Yes

Dimension attributes

Attribute Description Required Default value
name Ciąg lub wyrażenie zasad. Nazwa wymiaru. Yes N/A
value 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. No N/A

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

  • API ID
  • Operation ID
  • Product ID
  • User ID
  • Subscription ID
  • Location
  • Gateway ID
  • Identyfikator zaplecza (użyj tylko w sekcji zasad ruchu wychodzącego)

Usage

  • 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

Usage notes

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

Example

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

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

Related content

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

  • Last updated on