Saltar al contenido principal
Puede usar la para recuperar hasta 100 log por solicitud mediante el endpoint /get_logs, que admite dos tipos de uso:
  • Por punto de control: Recomendado si desea exportar los log a un servicio externo de análisis de datos.
  • Por criterios de búsqueda: Lo utiliza el Dashboard.
Los log almacenados por Auth0 están sujetos a un período de retención que depende de su suscripción de Auth0. Para obtener más información, lea Retención de datos de registro. También puede usar estos endpoints para buscar log:
  • /api/v2/logs/{id}: Recupera el registro individual asociado con el ID de log proporcionado.
  • /api/v2/users/{user_id}/logs: Recupera log para un ID de usuario específico.

​
Recuperar logs por punto de control

Este método le permite recuperar logs posteriores a un log_id determinado. Se usa habitualmente para enviar logs a un sistema externo, como Splunk, Datadog, Application Insights, Mixpanel, entre otros. Para buscar por punto de control, use los siguientes parámetros:
ParámetroDescripción
fromID del evento de log a partir del cual se empezarán a recuperar logs. Puede limitar la cantidad de logs con el parámetro take.
takeLa cantidad total de entradas que se recuperarán al usar el parámetro from.
Se ignorará cualquier parámetro distinto de from y take. Los logs se ordenan por log_id.

​
Semántica

La recuperación de logs mediante punto de control tiene la siguiente semántica:
  • Se devolverán todos los logs disponibles según los permisos de su rol
  • Los logs se ordenan por log_id, en lugar de por el momento en que se generó el log, para evitar omitir registros debido a retrasos del sistema de Auth0
  • La paginación no está acotada, lo que significa que no hay límite, a diferencia del límite de 1,000 registros al recuperar logs por criterios de búsqueda
Al recuperar logs por punto de control, solo la primera solicitud debe hacerse manualmente. Cada solicitud posterior debe hacerse con la URL de la relación next dentro del encabezado Link. Esto simplifica la integración con la API y permite que Auth0 realice optimizaciones sin afectar la experiencia del cliente.

​
Ejemplo

Supongamos que tu inquilino en us se llama acme. Para empezar a recuperar registros por punto de control:
  1. Obtén el log_id de cualquier log de tu sistema. Ejemplo: 90020211201185132572079310688835925971249535794074878050.
  2. Haz una solicitud a https://TENANT_NAME.LOCALITY.auth0.com/api/v2/logs?from=LOG_ID&take=100 para obtener los siguientes 100 logs posteriores al LOG_ID indicado.
  3. La respuesta HTTP contendrá
    1. Un array JSON de 0 a 100 logs posteriores al LOG_ID indicado
    2. Una cabecera HTTP Link con una relación next
  4. Si el conjunto de resultados está vacío, recibirás un array vacío y la relación next coincidirá con la misma URL que usaste en la solicitud más reciente

​
Recuperar logs por criterios de búsqueda

Este método le permite recuperar los logs que coincidan con los criterios de búsqueda especificados o, si no se usa ningún criterio, enumerar todos los logs. Para buscar por criterios, use los siguientes parámetros:
ParámetroDescripción
qCriterios de búsqueda mediante la sintaxis de cadena de consulta.
pageEl número de página con índice de base cero.
per_pageEl número de entradas por página.
sortEl campo que se usará para ordenar. Use field:order, donde order es 1 para orden ascendente y -1 para orden descendente. Por ejemplo, date:-1.
fieldsUna lista de campos separados por comas para incluir o excluir del resultado (según include_fields). Déjelo vacío para recuperar todos los campos.
include_fieldstrue si los campos especificados deben incluirse en el resultado; de lo contrario, false. El valor predeterminado es true.
Para ver una lista de campos y parámetros de ordenación que se pueden usar en la consulta de búsqueda, lea Sintaxis de consulta de búsqueda de logs.

​
Limitaciones

Además del límite de 100 registros por solicitud al recuperar log, solo puede paginar hasta 1.000 resultados de búsqueda. Si recibe el error 414 Request-URI Too Large, significa que la cadena de consulta supera la longitud admitida. En ese caso, refine la búsqueda.

Limitaciones de los campos de búsqueda de Private Cloud

Los siguientes campos solo se pueden buscar en Private Cloud:
  • user
  • connection
  • application
  • type
  • ip
Use comillas dobles para búsquedas exactas (por ejemplo, application:\"test\" buscará todos los eventos de log específicos de la aplicación llamada test, mientras que application:test buscará eventos de log de aplicaciones que tengan “test” en su nombre.

​
Más información