Emitir métricas personalizadas
APLICA-SE A: Todas as camadas de gerenciamento de API
A emit-metric
política envia métricas personalizadas no formato especificado para o Application Insights.
Nota
Defina os elementos da política e os elementos filho na ordem fornecida na declaração de política. Saiba mais sobre como definir ou editar 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 do 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).
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 10 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 fossem configuradas na política e cada dimensão tivesse 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éries temporais ativas regionais.
Saiba mais sobre limitações de design e considerações para métricas personalizadas no Azure Monitor.
Pré-requisitos
- Sua instância de gerenciamento de API deve ser integrada com o Application insights. Para obter mais informações, consulte Como integrar o Gerenciamento de API do Azure com o Azure Application Insights.
- Habilite o log do Application Insights para suas APIs.
- Habilite métricas personalizadas com dimensões no Application Insights. Para obter mais informações, consulte Emitir métricas personalizadas.
Declaração de política
<emit-metric name="name of custom metric" value="value of custom metric" namespace="metric namespace">
<dimension name="dimension name" value="dimension value" />
</emit-metric>
Atributos
Atributo | Description | Obrigatório | Default value |
---|---|---|---|
nome | Uma cadeia de caracteres. Nome da métrica personalizada. Expressões de política não são permitidas. | Sim | N/A |
espaço de nomes | Uma cadeia de caracteres. Namespace de métrica personalizada. Expressões de política não são permitidas. | Não | Gestão de API |
valor | Valor da métrica personalizada expresso como um duplo. São permitidas expressões de política. | Não | 1 |
Elementos
Elemento | Description | Obrigatório |
---|---|---|
dimensão | Adicione um ou mais desses elementos para cada dimensão incluída na métrica personalizada. | Sim |
Atributos de dimensão
Atributo | Description | Obrigatório | Default value |
---|---|---|---|
nome | Uma cadeia de caracteres ou expressão de política. Nome da dimensão. | Sim | N/A |
valor | Uma cadeia de caracteres ou expressão de política. Valor da dimensão. Só pode ser omitido se name corresponder a uma das dimensões padrão. Em caso afirmativo, o valor é fornecido conforme o nome da dimensão. |
No | N/A |
Nomes de dimensão padrão que podem ser usados sem valor
- API ID
- ID da operação
- ID do Produto
- ID de Utilizador
- ID de Subscrição
- Location
- ID do Gateway
Utilização
- Seções de política: entrada, saída, back-end, no erro
- Âmbitos de política: global, área de trabalho, produto, API, operação
- Gateways: clássico, v2, consumo, auto-hospedado, espaço de trabalho
Notas de utilização
- Você pode configurar no máximo 10 dimensões personalizadas para esta política.
Exemplo
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 personalizada.
<policies>
<inbound>
<emit-metric name="Request" value="1" namespace="my-metrics">
<dimension name="API ID" />
</emit-metric>
</inbound>
<outbound>
</outbound>
</policies>
Políticas relacionadas
Conteúdos relacionados
Para obter mais informações sobre como trabalhar com políticas, consulte:
- Tutorial: Transforme e proteja sua API
- Referência de política para uma lista completa de declarações de política e suas configurações
- Expressões de política
- Definir ou editar políticas
- Reutilizar configurações de política
- Recompra de trechos de política
- Kit de ferramentas de política de Gerenciamento de API do Azure
- Criar políticas usando o Microsoft Copilot no Azure