Registrar no hub de eventos
APLICA-SE A: todas as camadas do Gerenciamento de API
A política log-to-eventhub
envia mensagens no formato especificado para um hub de eventos definido por uma entidade Logger. Como o nome sugere, a política é usada para salvar informações de contexto de solicitação ou de resposta solicitadas para a análise online ou offline.
Observação
Para obter um guia passo a passo sobre como configurar um hub de eventos e registrar eventos, consulte Como registrar eventos em log para Hubs de Eventos do Azure no Gerenciamento de API.
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
<log-to-eventhub logger-id="id of the logger entity" partition-id="index of the partition where messages are sent" partition-key="value used for partition assignment">
Expression returning a string to be logged
</log-to-eventhub>
Atributos
Atributo | Descrição | Obrigatório | Padrão |
---|---|---|---|
logger-id | A ID do agente registrada com o serviço de Gerenciamento de API. Expressões de política não são permitidas. | Sim | N/D |
partition-id | Especifica o índice da partição em que as mensagens são enviadas. Expressões de política não são permitidas. | Opcional. Não use se partition-key for usado. |
N/D |
partition-key | Especifica o valor usado para a atribuição de partição quando as mensagens são enviadas. Expressões de política são permitidas. | Opcional. Não use se partition-id for usado. |
N/D |
Uso
- Seções da política: entrada, saída, back-end, em caso de erro
- Escopos de política: global, produto, API, operação
- Gateways: clássico, v2, consumo, auto-hospedado
Observações de uso
- A política não é afetada pela amostragem do Application Insights. Todas as invocações da política serão registradas.
- O tamanho máximo de mensagem com suporte que pode ser enviado a um hub de eventos dessa política é de 200 KB (quilobytes). Uma mensagem maior será truncada automaticamente para 200 KB antes de ser transferida para um hub de eventos.
Exemplo
Qualquer cadeia de caracteres pode ser usada como o valor a ser registrado em Hubs de Eventos. Neste exemplo, a data e hora, nome do serviço de implantação, a ID de solicitação, o endereço IP e o nome da operação para todas as chamadas de entrada são registrados no agente do hub de eventos registrado com a ID contoso-logger
.
<policies>
<inbound>
<log-to-eventhub logger-id ='contoso-logger'>
@( string.Join(",", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) )
</log-to-eventhub>
</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 no Azure