Log to Event Hub
S’APPLIQUE À : tous les niveaux de Gestion des API
La stratégie log-to-eventhub
envoie des messages au format spécifié à un Event Hub défini par une entité Enregistreur d’événements. Comme son nom l’indique, la stratégie est utilisée pour enregistrer certaines informations sur le contexte de la réponse ou de la demande à des fins d’analyse en ligne ou hors ligne.
Notes
Vous trouverez un guide de configuration étape par étape d’un Event Hub et des événements de journalisation à la page Guide pratique de l’enregistrement d’événements de la Gestion des API avec Azure Event Hubs.
Notes
Définissez les éléments enfants et de stratégie dans l’ordre fourni dans l’instruction de stratégie. En savoir plus sur comment définir ou modifier des stratégies du service Gestion des API.
Instruction de la stratégie
<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>
Attributs
Attribut | Description | Obligatoire | Default |
---|---|---|---|
logger-id | ID de l’Enregistreur d’événements inscrit auprès de votre service Gestion des API. Les expressions de stratégie ne sont pas autorisées. | Oui | N/A |
partition-id | Spécifie l’index de la partition où les messages sont envoyés. Les expressions de stratégie ne sont pas autorisées. | facultatif. À ne pas utiliser si partition-key est utilisé. |
N/A |
partition-key | Spécifie la valeur utilisée pour l’affectation de partitions lorsque des messages sont envoyés. Les expressions de stratégie sont autorisées. | facultatif. À ne pas utiliser si partition-id est utilisé. |
N/A |
Usage
- Sections de la stratégie : inbound, outbound, backend, on-error
- Étendues de la stratégie : global, product, API, operation
- Passerelles : classiques, v2, de consommation, auto-hébergées
Notes d’utilisation
- La stratégie n’est pas affectée par l’échantillonnage d’Application Insights. Tous les appels de la stratégie seront enregistrés.
- La taille maximale des messages pris en charge pouvant être envoyée à un Event Hub par cette stratégie est de 200 kilo-octets (Ko). Un message plus volumineux est automatiquement tronqué à 200 Ko avant le transfert vers un hub d’événements.
Exemple
Toute chaîne peut être utilisée comme valeur à consigner dans Event Hubs. Dans cet exemple, la date et l’heure, le nom de service de déploiement, l’ID de la demande, l’adresse IP et le nom de l’opération de tous les appels entrants sont consignés dans l’enregistreur d’événements Event Hub inscrit avec l’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>
Stratégies connexes
Contenu connexe
Pour plus d’informations sur l’utilisation des stratégies, consultez :
- Tutoriel : Transformer et protéger votre API
- Référence de stratégie pour obtenir la liste complète des instructions et des paramètres de stratégie
- Expressions de stratégie
- Définir ou modifier des stratégies
- Réutilisation de configurations de stratégie
- Référentiel d’extrait de stratégie
- Kit de ressources des stratégies Gestion des API Azure
- Créer des stratégies à l’aide de Microsoft Copilot dans Azure