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
- As métricas personalizadas são uma versão prévia do recurso 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.
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.
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
- ID da Localização
- 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
Observações de uso
Você pode configurar no máximo 10 dimensões personalizadas para essa política.
Invocar a política
emit-metric
conta para os limites de uso para métricas personalizadas por região em uma assinatura. Saiba mais
Exemplo
O exemplo a seguir envia uma métrica personalizada para contar o número de solicitações de API junto com a ID de usuário, o IP do cliente e a ID da 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ú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
- Criar políticas usando o Microsoft Copilot para Azure