Compartilhar via

Emitir métricas personalizadas

APLICA-SE A: todas as camadas do Gerenciamento de API

A política emit-metric envia métricas personalizadas no formato especificado para o Application insights.

Note

Defina os elementos da política e os elementos filho na ordem fornecida na declaração da política. Saiba mais sobre como definir e editar as políticas de Gerenciamento de API.

Limites para métricas personalizadas

O Azure Monitor impõe limites de uso para métricas personalizadas que podem afetar sua capacidade de emitir métricas de Gerenciamento de API. Por exemplo, o Azure Monitor atualmente define um limite de 10 chaves de dimensão por métrica e um limite de 50.000 séries temporais ativas totais por região em uma assinatura (dentro de um período de 12 horas). No Gerenciamento de API, 5 deles são usados para dimensões padrão, incluindo o seguinte:

  • Region
  • Service ID
  • Service Name
  • Service Type

Esses limites têm as seguintes implicações para configurar métricas personalizadas em uma política de Gerenciamento de API, como emit-metric ou azure-openai-emit-token-metric:

  • Você pode configurar um máximo de 5 dimensões personalizadas por política.

  • O número de séries temporais ativas geradas pela política dentro de um período de 12 horas é o produto do número de valores exclusivos de cada dimensão configurada durante o período. Por exemplo, se três dimensões personalizadas foram configuradas na política e cada dimensão tinha 10 valores possíveis dentro do período, a política contribuiria com 1.000 (10 x 10 x 10) séries temporais ativas.

  • Se você configurar a política em várias instâncias de Gerenciamento de API que estão na mesma região em uma assinatura, todas as instâncias poderão contribuir para o limite de série temporal ativo regional.

Saiba mais sobre limitações de design e considerações para métricas personalizadas no 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. Nome da métrica personalizada. Expressões de política não são permitidas. Yes N/A
espaço para nome A string. Namespace da métrica personalizada. Expressões de política não são permitidas. No API Management
value Valor da métrica personalizada expresso como o dobro. Expressões de política são permitidas. No 1

Elements

Element Description Required
dimension Adicione um ou mais desses elementos para cada dimensão incluída na métrica personalizada. Yes

Dimension attributes

Attribute Description Required Default value
name Uma cadeia de caracteres ou expressão de política. Nome da dimensão. Yes N/A
value Uma cadeia de caracteres ou expressão de política. Valor da dimensão. Só poderá ser omitido se name corresponder a uma das dimensões padrão. Em caso afirmativo, o valor é fornecido de acordo com o nome da dimensão. No N/A

Nomes de dimensão padrão que podem ser usados sem valor

  • API ID
  • Operation ID
  • Product ID
  • User ID
  • Subscription ID
  • Location
  • Gateway ID
  • ID de back-end (use apenas na seção de política de saída)

Usage

Usage notes

  • Você pode configurar no máximo cinco dimensões personalizadas para essa política.

Example

O exemplo a seguir envia uma métrica personalizada para contar o número de solicitações de API junto com a ID da API como uma dimensão padrão.

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

Related content

Para obter mais informações sobre como trabalhar com políticas, consulte:

  • Last updated on