Récupérer les logs à l’aide de la Management API

Découvrez comment récupérer des logs à l’aide du point de terminaison get_logs de l’Auth0 Management API, soit par point de contrôle, soit selon des critères de recherche.

Vous pouvez utiliser la Management API pour récupérer jusqu’à 100 logs par requête à l’aide du point de terminaison /get_logs, qui prend en charge deux modes d’utilisation :

• Par point de contrôle : recommandé si vous souhaitez exporter des logs vers un service externe d’analyse de données.
• Par critères de recherche : utilisé par l’Auth0 Dashboard.

Les logs stockés par Auth0 sont soumis à une période de conservation déterminée par votre abonnement Auth0. Pour en savoir plus, consultez Conservation des données de journalisation.

Vous pouvez également utiliser ces points de terminaison pour rechercher des logs :

• /api/v2/logs/{id} : récupère l’entrée de log associée à l’ID de log fourni.
• /api/v2/users/{user_id}/logs : récupère les logs pour un ID d’utilisateur précis.

​

Récupérer les logs par point de contrôle

Cette méthode vous permet de récupérer les logs plus récents qu’un log_id donné. Elle est couramment utilisée pour envoyer vos logs vers un système externe, comme Splunk, Datadog, Application Insights, Mixpanel, et d’autres encore.

Pour effectuer une recherche par point de contrôle, utilisez les paramètres suivants :

Paramètre	Description
from	ID d’événement de journal à partir duquel commencer à récupérer les logs. Vous pouvez limiter le nombre de logs à l’aide du paramètre take.
take	Nombre total d’entrées à récupérer lors de l’utilisation du paramètre from.

Tout paramètre autre que from et take sera ignoré. Les logs sont triés selon le log_id.

​

Sémantique

La récupération des logs par point de contrôle fonctionne comme suit :

• Tous les logs auxquels votre rôle vous donne accès sont renvoyés
• Les logs sont triés selon le log_id, plutôt qu’en fonction de l’heure de génération, afin d’éviter d’omettre des enregistrements en raison des délais du système Auth0
• La pagination n’est pas bornée, c’est-à-dire qu’il n’y a pas de limite, contrairement à la limite de 1,000 enregistrements lors de la récupération des logs selon des critères de recherche

​

Pagination

Lors de la récupération des logs par point de contrôle, seule la première requête doit être effectuée manuellement. Chaque requête suivante doit être effectuée à l’aide de l’URL associée à la relation next dans l’en-tête Link. Cela simplifie l’intégration avec l’API et permet à Auth0 d’effectuer des optimisations sans nuire à l’expérience client.

​

Exemple

Supposons que le nom de votre locataire dans us est acme. Pour commencer à récupérer des enregistrements par point de contrôle :

1. Récupérez le log_id de n’importe quel journal de votre système. Exemple : 90020211201185132572079310688835925971249535794074878050.

2. Envoyez une requête à https://TENANT_NAME.LOCALITY.auth0.com/api/v2/logs?from=LOG_ID&take=100 pour demander les 100 logs suivants, plus récents que le LOG_ID donné.

3. La réponse HTTP contiendra :

   1. Un tableau JSON contenant de 0 à 100 logs plus récents que le LOG_ID donné
   2. Un en-tête HTTP Link avec une relation next

4. Si l’ensemble de résultats est vide, vous recevrez un tableau vide et la relation next correspondra à la même URL que celle utilisée dans la requête la plus récente

​

Récupérer des logs selon des critères de recherche

Cette méthode vous permet de récupérer les logs qui correspondent aux critères de recherche spécifiés ou, si aucun critère n’est fourni, d’afficher tous les logs. Pour effectuer une recherche selon des critères, utilisez les paramètres suivants :

Paramètre	Description
q	Critères de recherche utilisant la syntaxe de chaîne de requête.
page	Le numéro de page commençant à zéro.
per_page	Le nombre d’entrées par page.
sort	Le champ à utiliser pour le tri. Utilisez field:order, où order est 1 pour l’ordre croissant et -1 pour l’ordre décroissant. Par exemple : date:-1.
fields	Une liste de champs séparés par des virgules à inclure ou à exclure (selon include_fields) du résultat. Laissez ce paramètre vide pour récupérer tous les champs.
include_fields	true si les champs spécifiés doivent être inclus dans le résultat, false sinon. La valeur par défaut est true.

Pour obtenir la liste des champs et des paramètres de tri pouvant être utilisés dans la requête de recherche, consultez Syntaxe de requête de recherche des journaux.

​

Limites

En plus de la limite de 100 logs par requête lors de la récupération des logs, vous ne pouvez paginer que jusqu’à 1 000 résultats de recherche.

Si vous obtenez l’erreur 414 Request-URI Too Large, cela signifie que votre chaîne de requête dépasse la longueur prise en charge. Dans ce cas, affinez votre recherche.

Limites des champs de recherche du cloud privé

Les champs suivants sont interrogeables uniquement dans le cloud privé :

• user
• connection
• application
• type
• ip

Utilisez des guillemets doubles pour les recherches exactes (par exemple, application:"test" recherchera tous les événements de log propres à l’application nommée test, tandis que application:test recherchera les événements de log des applications dont le nom contient « test ».

​

En savoir plus

• Codes de type d’événement des journaux
• Syntaxe des requêtes de recherche dans les journaux
• Conservation des données de journalisation