Passer au contenu principal
Afin d’offrir à nos clients la solution la plus fiable et la plus évolutive, Auth0 a déclaré obsolète Tenant Logs Search Engine v2 au profit de v3. Auth0 migre de façon proactive les clients qui ne sont pas touchés par ce changement, tandis que ceux qui pourraient l’être reçoivent une notification les invitant à opter pour v3 pendant la période de grâce prévue.

​
Fonctionnalités concernées

Vous êtes concerné si vous répondez à tous les critères suivants :
  • Locataires créés le 21 mai 2019 ou avant
  • Locataires hébergés dans le nuage public d’Auth0 dans les régions AU ou EU
  • Utilisez le point de terminaison GET /api/v2/logs ou le point de terminaison GET /api/v2/users/{user_id}/logs avec le paramètre include_totals=true ou le paramètre q.
  • Paginez sur plus de 1000 résultats.
  • Utilisez l’extension Delegated Admin. Les anciennes versions de l’extension continueront de fonctionner après la migration de votre locataire vers Logs Search Engine v3, mais il se peut que les totaux de pagination affichés lors de la consultation des logs soient inexacts. La mise à jour vers la version 3.7 de l’extension corrige ce problème.
Les locataires suivants ne sont pas concernés :
  • Locataires cloud dans la région US. La région US a été entièrement migrée et utilise déjà Search Engine v3.
  • Locataires de cloud privé (la migration pour les clients de Private Cloud commencera à une date ultérieure.)
  • Locataires cloud dans les régions EU et AU qui :
    • N’utilisent pas du tout les points de terminaison GET /api/v2/logs ou GET /api/v2/users/{user_id}/logs du Management API.
    • Consomment les logs uniquement à partir de la section Logs de l’Auth0 Dashboard.
    • Utilisent le point de terminaison GET /api/v2/logs avec la méthode par checkpoint (à l’aide du paramètre from).
    • Consomment les logs à l’aide de l’une des extensions Auth0 Logs to External Service Dashboard (qui utilisent la méthode par checkpoint).

​
Vérifier la migration des requêtes

Auth0 génère seulement une entrée de journal du même type et avec la même description toutes les 60 minutes. Peu importe le nombre d’appels que vous effectuez vers les points de terminaison touchés à l’aide de fonctionnalités obsolètes, vous ne verrez qu’une seule entrée de journal par fonctionnalité obsolète chaque heure. Si vous modifiez vos requêtes, vous devrez attendre 60 minutes avant de pouvoir conclure avec certitude que l’absence de nouveaux journaux depnote signifie que le comportement obsolète a été supprimé de votre code. Vous pouvez rechercher ce qui suit dans les journaux de votre locataire afin de repérer les requêtes qui généreraient des erreurs après la migration vers v3 : type:depnote AND description:*logs* Ces entrées de journal comprennent un champ description qui précise le comportement obsolète que vous utilisez. Vous pouvez aussi vérifier les champs details.request.path et client_name pour voir quelle application appelle soit GET /api/v2/logs, soit GET /api/v2/users/{user_id}/logs.

​
Changements

Les changements incompatibles sont mineurs, mais vous devriez vérifier vos requêtes pour vous assurer que les résultats que vous obtenez correspondent à vos attentes. Les changements incompatibles concernent :
  • Lorsque votre locataire sera migré vers logs v3, la valeur du champ total renvoyée dans le résultat récapitulatif lors d’un appel à GET /api/v2/logs ou à GET /api/v2/users/{user_id}/logs changera. Lorsque vous recherchez des logs à l’aide du moteur de recherche v2, le champ totals dans vos résultats indique le nombre de logs qui correspondent à la requête fournie. Toutefois, dans v3, le champ totals indique le nombre de logs renvoyés dans la page (comme le fait le champ length). Pour éviter toute perturbation potentielle, si votre application s’appuie sur le champ total à des fins de pagination, vous devriez mettre à jour votre logique afin de tenir compte de ce changement.
  • Il existe actuellement une limite de 100 logs par requête. Lorsque votre locataire sera migré vers logs v3, vous ne pourrez paginer que dans un maximum de 1 000 résultats de recherche; par conséquent, les appels portant sur plus de 1 000 résultats renverront une erreur. Pour éviter toute perturbation potentielle, vous devriez revoir vos requêtes pour éviter cette limite ou gérer les erreurs en conséquence.

​
validation du paramètre q

  • La syntaxe de requête utilisée avec le paramètre q dans GET /api/v2/logs présente quelques changements mineurs dont vous devez tenir compte. Lorsque votre locataire sera migré vers logs v3, cette validation sera appliquée, et cette requête renverra alors une erreur. Pour éviter toute interruption potentielle, vous devriez vérifier vos requêtes pour vous assurer qu’elles respectent la syntaxe de requête prise en charge.
  • Le paramètre q contient un champ non valide. Lorsque votre locataire sera migré vers logs v3, cette validation sera appliquée, et cet appel renverra alors une erreur. Pour éviter toute interruption potentielle, vous devriez vérifier vos requêtes pour vous assurer qu’elles ne contiennent que des champs interrogeables.

​
Activer la recherche dans les journaux du locataire v3

Après avoir examiné vos requêtes, vous pouvez activer Tenant Logs Search Engine v3 dans l’Auth0 Dashboard.
  1. Accédez à Paramètres du locataire > Avancé.
  2. Faites défiler la page jusqu’à Migrations.
  3. Basculez le commutateur Legacy Logs Search V2 à désactivé. Lorsque ce commutateur est désactivé, le moteur de recherche dans les journaux v2 obsolète est désactivé et l’utilisation du moteur de recherche v3 est forcée. Si vous ne voyez pas le commutateur Legacy Logs Search V2, c’est que vous avez déjà été migré vers v3. Aucune autre action n’est requise.
Si vous avez besoin d’aide pour la migration, contactez-nous par l’entremise du Support Center.

​
Pour en savoir plus