Tests des événements, observabilité et reprise après échec

Testez un flux d’événements Auth0, surveillez les échecs de livraison en interrogeant l’endpoint Deliveries et récupérez les événements manqués grâce aux API Redelivery unique et par lot afin de maintenir la fiabilité de votre flux d’événements.

Les sections suivantes présentent de l’information sur les tests des flux d’événements et la gestion des événements.

​

Tester le flux d’événements

Après avoir créé et activé un flux d’événements, vous pouvez tester ce nouveau flux. À l’heure actuelle, Auth0 ne permet pas d’envoyer des événements vers des flux d’événements désactivés.

Pour tester votre flux d’événements, commencez par créer un utilisateur pour votre application en exécutant la commande suivante avec les identifiants de votre choix :

Auth0 CLI

auth0 users create # suivez les instructions pour créer un utilisateur de test

cURL

curl -s \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -X POST https://$TENANT/api/v2/users \
  -d '{
        "email": "[e-mail]",
        "password": "Password123!",
        "connection": "Username-Password-Authentication"
      }'

Une fois l’utilisateur créé, cela devrait déclencher l’événement user.created dans votre flux d’événements et renvoyer une réponse. Dans cet exemple, des webhooks sont utilisés pour acheminer le flux d’événements.

"Webhook received": {
  "id": "evt_6SfwXrtm8nVcjzzNCFFH1L",
  "source": "urn:auth0:",
  "specversion": "1.0",
  "type": "user.created",
  "time": "2025-02-02T17:56:01.573Z",
  "data": {
    "object": {
      "created_at": "2025-02-02T17:56:01.566Z",
      "email": "[e-mail]",
      "email_verified": false,
      "identities": [
        {
          "connection": "Username-Password-Authentication",
          "isSocial": false,
          "provider": "auth0",
          "user_id": "679fb1b1e809445f129bc18d"
        }
      ],
      "name": "[e-mail]",
      "nickname": "nick-testing-21",
      "picture": "test.png",
      "updated_at": "2025-02-02T17:56:01.566Z",
      "user_id": "auth0|679fb1b1e809445f129bc18d"
    }
  },
  "a0tenant": "acme",
  "a0stream": "est_38ANnv8pQhqsZrX2VFbftv",
  "a0purpose": "test"
}

Vous pouvez afficher la liste des échecs de livraison pour un flux d’événements précis en exécutant :

Auth0 CLI

auth0 api get event-streams/$EVENT_STREAM_ID/deliveries

cURL

curl -s -H "Authorization: Bearer $TOKEN" \
  "https://$TENANT/api/v2/event-streams/${EVENT_STREAM_ID}/deliveries" | jq .

Si le tableau des échecs de livraison renvoyé est vide, votre flux d’événements fonctionne correctement.

​

Observabilité

Pour assurer la fiabilité des flux d’événements, mettez en place un processus de surveillance qui contrôle périodiquement les échecs de livraison et déclenche des alertes au besoin.

Les échecs de livraison peuvent être causés par ce qui suit :

• Flux d’événements désactivés.
• Flux d’événements non disponibles.
• Erreurs de connexion.

​

Point de terminaison Deliveries pour le polling

Interrogez le point de terminaison Deliveries toutes les 5 minutes pour vérifier s’il y a des événements en échec. Utilisez l’appel d’API suivant pour récupérer les livraisons d’événements récentes :

Auth0 CLI

auth0 api get event-streams/$EVENT_STREAM_ID/deliveries

cURL

curl -s -H "Authorization: Bearer $TOKEN" \
  "https://$TENANT/api/v2/event-streams/${EVENT_STREAM_ID}/deliveries" | jq .

Si des échecs sont détectés :

• Consignez les détails des événements en échec.
• Alertez l’équipe ou le système approprié pour examiner et diagnostiquer le problème.

​

Reprise

La livraison des événements fera automatiquement l’objet de nouvelles tentatives. Pour en savoir plus, consultez les Bonnes pratiques.

En cas d’échec, utilisez la Redelivery API pour tenter de livrer l’événement de nouveau.

​

Réacheminer un seul événement en échec

Pour réessayer la livraison d’un événement en échec précis, utilisez :

Auth0 CLI

EVENT_ID=<your event id>
auth0 api POST event-streams/$EVENT_STREAM_ID/redeliver/$EVENT_ID --data '{}'

cURL

curl -s -X POST -H "Authorization: Bearer $TOKEN" \
  "https://<your-domain>/api/v2/event-streams/$EVENT_STREAM_ID/redeliver/$EVENT_ID"

​

Renvoi par lot des événements en échec

Pour réessayer tous les événements en échec dans le flux d’événements :

Auth0 CLI

auth0 api POST event-streams/$EVENT_STREAM_ID/redeliver --data '{}'

cURL

curl -s -X POST -H "Authorization: Bearer $TOKEN" \
  "https://<your-tenant>.auth0.com/api/v2/event-streams/<event_stream_id>/redeliver"

​

Mécanisme de désactivation automatique

Auth0 désactive automatiquement un flux d’événements en cas de trop grand nombre d’échecs.

Condition	Mesure prise
500 échecs consécutifs	Le flux d’événements est automatiquement désactivé.
5000 échecs au total	Le flux d’événements est automatiquement désactivé.

• Si un flux d’événements est désactivé automatiquement, vous devez utiliser la Redelivery API pour traiter tous les événements en échec.
• Le flux d’événements ne peut pas être réactivé manuellement tant que le nombre total d’échecs ne redescend pas sous 5000.
• Une fois le nombre d’échecs réduit, vous pouvez réactiver le flux par API.

​

En savoir plus

• Catalogue d’événements
• Créer un flux d’événements
• Bonnes pratiques pour les événements