Iniciar sessão no hub de eventos
APLICA-SE A: Todas as camadas de gerenciamento de API
A log-to-eventhub
política envia mensagens no formato especificado para um hub de eventos definido por uma entidade Logger . Como o próprio nome indica, a política é usada para salvar informações de contexto de solicitação ou resposta selecionadas para análise on-line ou off-line.
Nota
Para obter um guia passo a passo sobre como configurar um hub de eventos e registrar eventos, consulte Como registrar eventos de Gerenciamento de API com Hubs de Eventos do Azure.
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
<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 | Description | Necessário | Predefinição |
---|---|---|---|
ID do registador | A ID do Logger registrado no seu serviço de Gerenciamento de API. Expressões de política não são permitidas. | Sim | N/A |
ID da partição | Especifica o índice da partição para onde as mensagens são enviadas. Expressões de política não são permitidas. | Opcional. Não utilize se partition-key for utilizado. |
N/A |
chave de partição | Especifica o valor usado para atribuição de partição quando as mensagens são enviadas. São permitidas expressões de política. | Opcional. Não utilize se partition-id for utilizado. |
N/A |
Utilização
- Seções de política: entrada, saída, back-end, no erro
- Escopos da política: global, produto, API, operação
- Gateways: clássico, v2, consumo, auto-hospedado
Notas de utilização
- 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 suportado que pode ser enviado para um hub de eventos a partir desta política é de 200 kilobytes (KB). Uma mensagem maior será automaticamente truncada 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 a hora, o nome do serviço de implantação, a ID da solicitação, o endereço IP e o nome da operação para todas as chamadas de entrada são registrados no Logger do hub de eventos registrado com a contoso-logger
ID.
<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ú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