View a markdown version of this page

S'abonner à des événements sur un bus événementiel personnalisé - Amazon EventBridge

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

S'abonner à des événements sur un bus événementiel personnalisé

Un abonné est une ressource qui indique quels événements vous souhaitez et où les envoyer. Vous le créez en CreateSubscriber nommant le bus, les filtres et une cible. Il surveille ce bus, conserve les événements correspondant à ses filtres, transforme éventuellement chacun d'eux et les transmet exactement à une cible. Pour étendre un événement à plusieurs cibles, créez un abonné pour chaque cible sur le même bus.

EventBridge permet de créer ou de supprimer un abonné à la fois sur un bus donné, quel que soit l'appel du compte. Un deuxième bus CreateSubscriber ou DeleteSubscriber sur le même bus alors qu'un autre est en cours échoue ConcurrentModificationException ; réessayez. Les tarifs de création et de suppression dans s'appliquent Quotas d'Event Bus personnalisés donc par bus.

Filtrer les événements qui atteignent la cible

FilterConfigurationcontient une liste deFilters. Chaque filtre possède unPattern, dans la syntaxe du modèle d' EventBridge événement, et unScope. Vous pouvez avoir au plus un filtre par étendue et diffuser EventBridge un événement uniquement s'il correspond à tous les filtres de la liste. Un abonné non abonné FilterConfiguration reçoit tous les événements du bus.

Pour la syntaxe des modèles, les règles de portée et des exemples, consultezFiltrer les événements pour un abonné.

Transformation de la charge utile

Transformer.Typesélectionne ce que reçoit la cible. Une cible universelle ne l'utilise pas ; voirObjectifs universels pour un bus événementiel personnalisé.

  • RAW, la valeur par défaut. La charge utile uniquement.

  • WITH_METADATA. L'événement complet : DataMetadata, etSystemMetadata.

  • JSONATA. Le résultat de l'expression JSonata inJsonataConfiguration.Expression, entourée de {% %} délimiteurs, avec l'événement disponible sous la forme. $events

EventBridge vérifie la syntaxe d'une expression lorsque vous créez l'abonné et l'évalue au moment de la livraison. Une expression qui renvoie, ou qui ne produit aucune valeur, échoue à délivrer cet événement. Testez les expressions par rapport à des événements réels avant de vous en remettre à eux. Pour ce $events qui est en vigueur, les fonctions supplémentaires et les limites, voirTransformer les événements avec JSonata.

Atteindre un objectif

InvokeConfigurationcontient leTargetArn, RoleArn qui EventBridge suppose d'invoquer la cible, et au plus un bloc de paramètres correspondant au type de cible. La plupart des valeurs de paramètres acceptent une expression JSonata, de sorte qu'une valeur peut provenir de l'événement. Le tableau suivant répertorie les types de cibles personnalisés et leur bloc de paramètres ; chacun possède sa propre page en dessousObjectifs pour un abonné à Custom Event Bus.

CibleBloc de paramètres
File d’attente Amazon SQSSqsParameters
Fonction LambdaLambdaParameters
Flux KinesisKinesisParameters
Machine d’état Step FunctionsStepFunctionsParameters
Rubrique Amazon SNSSnsParameters
Point de terminaison HTTP ou destination de l'APIHttpParameters
Flux FirehoseFirehoseParameters

Un bus d'événements personnalisé ou un bus d'événements personnalisé - Classic peut également être la cible : définissez l'ARN du bus commeTargetArn. Pour une cible FIFO telle qu'une file d'attente FIFO Amazon SQS, définissez le propre identifiant de déduplication de la cible dans le bloc de paramètres, par exempleSqsParameters.MessageDeduplicationId, sur une valeur par message dérivée de l'événement avec une expression JSonata. Une constante oblige la cible à supprimer tous les messages après le premier.

Une cible universelle invoque directement une action d' AWS API, sans aucune fonction intermédiaire. Son ARN a la formearn:aws:events:::aws-sdk:service:apiAction, par exemplearn:aws:events:::aws-sdk:dynamodb:putItem, et il UniversalTargetParameters.Input contient la demande au format JSON ou en tant qu'expression JSonata qui la produit. Pour les règles de dénomination, le traitement par lots et le comportement en cas de défaillance, consultezObjectifs universels pour un bus événementiel personnalisé.

Lorsque vous créez l'abonné, vous EventBridge corrigez le type de cible à partir de l'ARN et vérifiez trois choses : que le bloc de paramètres correspond au type de cible, que l'ARN appartient à votre compte et que chaque expression est analysée. Si la cible existe, si le rôle peut l'atteindre et si l'API de la cible accepte les valeurs sont vérifiées lors de la livraison, confirmez donc la première livraison sur la cible.

Réessais et files d'attente aux lettres mortes

RetryPolicydéfinit la durée pendant EventBridge laquelle une livraison a échoué, par défaut 5 tentatives en 300 secondes, et OnFailureConfiguration.Arn nomme la file d'attente Amazon SQS qui reçoit un enregistrement pour chaque événement ayant épuisé ses nouvelles tentatives. Définissez les deux lorsque vous créez l'abonné. Pour les limites, le format d'enregistrement et la manière de reconduire, voirPolitiques relative aux nouvelles tentatives et files d’attente de lettres mortes.

Le rôle de prestation

Le rôle dans RoleArn doit appartenir à votre compte et faire confiance au responsable du events.amazonaws.com service. Votre appelant doit avoir iam:PassRole le rôle nécessaire pour créer l'abonné, ou EventBridge refuse la demande avant qu'il ne vérifie l'ARN cible. La politique d'autorisations du rôle nécessite deux autorisations.

  • L'action requise par la cible, par exemple sqs:SendMessage sur une file d'attente, lambda:InvokeFunction sur une fonction, sns:Publish sur un sujet ou kinesis:PutRecords sur un flux.

  • sqs:SendMessagedans la file d'attente des lettres mortes dans. OnFailureConfiguration.Arn Sans cela, un échec de livraison n'a nulle part où s'enregistrer, et ces événements sont perdus sans aucun signal.

La politique de confiance suivante permet EventBridge d'assumer ce rôle.

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "events.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }

La politique d'autorisations suivante fournit des informations à une file d'attente Amazon SQS et des lettres mortes à une deuxième file d'attente.

{ "Version": "2012-10-17", "Statement": [ { "Sid": "InvokeTheTarget", "Effect": "Allow", "Action": "sqs:SendMessage", "Resource": "arn:aws:sqs:us-east-1:111122223333:large-orders" }, { "Sid": "WriteToTheDeadLetterQueue", "Effect": "Allow", "Action": "sqs:SendMessage", "Resource": "arn:aws:sqs:us-east-1:111122223333:large-orders-dlq" } ] }

Exemple : envoyer des commandes importantes dans une file d'attente

La commande suivante crée un abonné qui livre les commandes de plus de 500 à une file d'attente Amazon SQS, pour les événements publiés avecPutEvents, et envoie les échecs à une file d'attente lettre morte.

aws eventsv2 create-subscriber \ --name large-orders \ --event-bus-arn arn:aws:events:us-east-1:111122223333:event-busv2/orders/EXAMPLE1234567890abcdef \ --filter-configuration '{ "Filters": [ { "Scope": "DATA", "Pattern": "{\"detail\":{\"total\":[{\"numeric\":[\">\",500]}]}}" } ] }' \ --invoke-configuration '{ "TargetArn": "arn:aws:sqs:us-east-1:111122223333:large-orders", "RoleArn": "arn:aws:iam::111122223333:role/EventBusDeliveryRole" }' \ --on-failure-configuration '{ "Arn": "arn:aws:sqs:us-east-1:111122223333:large-orders-dlq" }'

Résolution des problèmes : vous avez publié et rien n'est arrivé à la cible

Une réponse publiée indique uniquement que le bus a accepté et enregistré l'événement ; elle ne confirme jamais la livraison. Effectuez les vérifications suivantes dans l'ordre.

Symptôme

L'appel de publication a renvoyé HTTP 200 sans aucune entrée échouée, et la cible n'a rien reçu après plusieurs minutes.

Cause

L'une des cinq choses, par ordre de fréquence : la diffusion est toujours en cours de nouvelle tentative ; l'abonné est STOPPED ou a été révoqué ; l'abonné StartingPosition est LATEST et l'événement a été publié avant que l'abonné n'existe ; le filtre est écrit pour l'autre API de publication et ne correspond à rien ; ou le rôle de diffusion ne peut pas atteindre la cible ou la file d'attente de lettres mortes. TargetInvocationsvous indique la moitié du problème que vous rencontrez. Les points de données activés alors qu'aucun n'est activé EventsDelivered signifient que des tentatives de livraison ont été effectuées et qu'elles échouent. TargetInvocations L'absence de points de données TargetInvocations alors qu'ils sont présents signifie qu'aucune tentative de livraison n'a FilterEvaluated été effectuée ; vérifiez que c'est RUNNING bien l'abonné et vérifiez. EventTransformationFailures

Solution
  1. Lisez l'abonné. Statedoit être absente RUNNING et Revoked doit être absente ; elle n'apparaît que si elle est vraie. Remarque StartingPosition et filtres.

    aws eventsv2 describe-subscriber \ --subscriber-arn arn:aws:events:us-east-1:111122223333:subscriber/large-orders/EXAMPLE1234567890abcdef
  2. Consultez les statistiques de l'abonné dansAWS/EventsV2. FilterEvaluatedà zéro signifie qu'aucun événement n'a atteint cet abonné : le producteur a publié sur un autre bus, ou avant que l'abonné n'existe avecLATEST. FilterEvaluatedau-dessus de zéro et FilterMatched à zéro signifie que le filtre ne correspond à rien ; voirStructure de l'événement : données, métadonnées et métadonnées du système. Lorsqu'il y FilterMatched a des points de données et EventsDelivered qu'il n'en a pas, les livraisons échouent, et la métrique qui enregistre le résultat dépend de l'abonné : EventsDropped lorsqu'aucune file d'attente de lettres mortes n'est configurée, OnFailureDestinationDelivered quand l'événement a atteint la file d'attente et OnFailureDestinationFailed quand il ne l'a pas fait.

  3. Activez les journaux et reproduisez. LogConfiguration.LevelRéglez sur INFO et IncludePayload surFULL, transférez une livraison de journal, publiez à nouveau et lisez les EVENT_DELIVERY_ATTEMPT enregistrements. Chacun contient le code d'erreur et le message de la cibledetails.target_input, et c'est ce qui EventBridge a été envoyé plutôt que ce que vous vouliez envoyer. Consultez Observabilité pour le bus d'événements personnalisé : métriques, journaux et CloudTrail.

  4. Si le filtre est suspect, ajoutez un abonné de diagnostic sur le même bus sans filtre Transformer.TypeWITH_METADATA, et une file d'attente dont vous êtes propriétaire comme cible. Il propose chaque événement exactement tel qu' EventBridge il est vu, tel que DataMetadata, etSystemMetadata. Simplifiez ensuite votre filtre une condition à la fois ; la dernière condition que vous supprimez en est la cause.

Vérification

Publiez un événement qui devrait correspondre et un autre qui ne devrait pas. Le premier arrive à la cible et EventsDelivered augmente d'un point ; le second n'arrive pas et FilterEvaluated augmente alors qu'il n'y arrive FilterMatched pas.

Note

Les statistiques d'un abonné sont disponibles pour le propriétaire du bus et pour le propriétaire de l'abonné ; ses journaux ne sont transmis qu'au propriétaire de l'abonné.