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
- As métricas personalizadas são um recurso de visualização do Azure Monitor e estão sujeitas a limitações.
- Para obter mais informações sobre os dados de Gerenciamento de API adicionados ao Application Insights, consulte Como integrar o Gerenciamento de API do Azure ao Azure 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.
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
- Gateway ID
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.
Invocar a
emit-metric
política conta para os limites de uso de métricas personalizadas por região em uma assinatura. Mais informações
Exemplo
O exemplo a seguir envia uma métrica personalizada para contar o número de solicitações de API junto com ID de usuário, IP de cliente e ID de API como dimensões personalizadas.
<policies>
<inbound>
<emit-metric name="Request" value="1" namespace="my-metrics">
<dimension name="User ID" />
<dimension name="Client IP" value="@(context.Request.IpAddress)" />
<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
- Criar políticas usando o Microsoft Copilot no Azure