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

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. Actuellement, Auth0 ne prend pas en charge l’envoi d’événements vers des flux d’événements désactivés. Pour tester votre flux d’événements, créez d’abord un utilisateur pour votre application en exécutant la commande suivante avec les identifiants de votre choix :

Auth0 CLI
cURL

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

curl -s \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -X POST https://$TENANT/api/v2/users \
  -d '{
        "email": "nick-testing-21@example.com",
        "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 prendre en charge 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": "nick-testing-21@example.com",
      "email_verified": false,
      "identities": [
        {
          "connection": "Username-Password-Authentication",
          "isSocial": false,
          "provider": "auth0",
          "user_id": "679fb1b1e809445f129bc18d"
        }
      ],
      "name": "nick-testing-21@example.com",
      "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 les échecs de livraison pour un flux d’événements précis en exécutant :

Auth0 CLI
cURL

auth0 api get event-streams/$EVENT_STREAM_ID/deliveries

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

Si un tableau vide d’échecs de livraison est renvoyé, 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 vérifie périodiquement si des échecs de livraison se produisent et déclenche des alertes au besoin. Les échecs de livraison peuvent être causés par :

Des flux d’événements désactivés.
Des flux d’événements indisponibles.
Des erreurs de connexion.

Interrogation du point de terminaison Deliveries

Interrogez le point de terminaison Deliveries toutes les 5 minutes pour vérifier si des événements ont échoué. Utilisez l’appel d’API suivant pour récupérer les livraisons d’événements récentes :

Auth0 CLI
cURL

auth0 api get event-streams/$EVENT_STREAM_ID/deliveries

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 de l’événement ayant échoué.
Alertez l’équipe ou le système approprié afin d’examiner le problème et d’en diagnostiquer la cause.

Récupération

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 l’API de relivraison pour réessayer la livraison des événements.

Renvoyer un seul événement en échec

Pour réessayer un événement en échec précis, utilisez :

Auth0 CLI
cURL

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

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

Réexpédition par lot des événements en échec

Pour relancer tous les événements en échec du flux d’événements :

Auth0 CLI
cURL

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

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 si un trop grand nombre d’échecs se produit.

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

Si un flux d’événements est désactivé automatiquement, vous devez utiliser l’API de relivraison pour traiter les événements ayant échoué.
Le flux d’événements ne peut pas être réactivé manuellement tant que le nombre total d’échecs ne descend pas sous 5000.
Une fois le nombre d’échecs réduit, vous pouvez réactiver le flux au moyen de l’API.

​Tester le flux d’événements

​Observabilité

​Interrogation du point de terminaison Deliveries

​Récupération

​Renvoyer un seul événement en échec

​Réexpédition par lot des événements en échec

​Mécanisme de désactivation automatique

​En savoir plus