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.
Observação
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).
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 no máximo 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 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.
Pré-requisitos
- Sua instância do Gerenciamento de API deve ser integrada ao Application Insights. Para obter mais informações, consulte Como integrar o Gerenciamento de API do Azure ao Azure Application Insights.
- Habilitar o log do Application Insights para suas APIs.
- Habilitar 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 | Descrição | Obrigatório | Valor padrão |
---|---|---|---|
name | Uma cadeia de caracteres. Nome da métrica personalizada. Expressões de política não são permitidas. | Sim | N/D |
namespace | Uma cadeia de caracteres. Namespace da métrica personalizada. Expressões de política não são permitidas. | Não | Gerenciamento de API |
value | Valor da métrica personalizada expresso como o dobro. Expressões de política são permitidas. | Não | 1 |
Elementos
Elemento | Descrição | 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 | Descrição | Obrigatório | Valor padrão |
---|---|---|---|
name | Uma cadeia de caracteres ou expressão de política. Nome da dimensão. | Sim | N/D |
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. |
Não | N/D |
Nomes de dimensão padrão que podem ser usados sem valor
- ID da API
- ID da Operação
- Produto ID
- ID do Usuário
- ID da assinatura
- Localidade
- ID de Gateway
Uso
- Seções da política: entrada, saída, back-end, em caso de erro
- Escopos de política: global, espaço de trabalho, produto, API, operação
- Gateways: clássico, v2, consumo, auto-hospedado, espaço de trabalho
Observações de uso
- Você pode configurar no máximo 10 dimensões personalizadas para essa 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 dimensões 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údo relacionado
Para obter mais informações sobre como trabalhar com políticas, consulte:
- Tutorial: Transformar e proteger sua API
- Referência de Política para uma lista completa das instruções de política e suas configurações
- Expressões de política
- Definir ou editar políticas
- Reutilizar configurações de política
- Repositório de snippets de política
- Kit de ferramentas de políticas do Gerenciamento de API do Azure
- Criar políticas usando o Microsoft Copilot no Azure