Métricas de API de Auth0
La página API Metrics muestra cuánto tráfico de API gestiona un tenant de Auth0, qué parte tiene éxito y lo cerca que está el tenant de sus límites de peticiones. Los datos proceden de un Metric Stream de Auth0, que es independiente del log stream que transporta los eventos.
Requisitos
Sección titulada «Requisitos»- Un tenant de Auth0 conectado a Identiguard. Consulte Conectar Auth0.
- Un plan de Auth0 que admita Metric Streams. Normalmente es un plan Enterprise. Confírmelo con el cliente antes de empezar.
- El rol Admin en el workspace para configurar el stream. Todos los roles, incluido Viewer, pueden abrir la página y leer los gráficos.
- Acceso al dashboard de Auth0, para crear el stream en Monitoring → Streams.
El metric stream tiene su propio endpoint y su propio secreto. No usa el token del log stream. El proveedor de Terraform de Auth0 no admite metric streams, así que este stream se crea siempre a mano en Auth0.
Abrir la página
Sección titulada «Abrir la página»- Abra Tenants.
- En Tenant overview, busque el tenant de Auth0.
- Elija el icono de gráfico de líneas (texto emergente API Metrics) en su fila. Solo las filas de Auth0 tienen este icono.
El título de la página es API Metrics, con el nombre del tenant y “Auth0 API request volume and response type from the OTLP metric stream.” (Volumen de peticiones de API de Auth0 y tipo de respuesta del metric stream OTLP.)
Si el tenant todavía no tiene metric stream, la página muestra la tarjeta Enable the Auth0 Metric Stream en lugar de los gráficos.
Configurar un metric stream en un tenant nuevo
Sección titulada «Configurar un metric stream en un tenant nuevo»- En el formulario Add New Auth0 Tenant, marque Set up a metric stream now en la sección Metric stream.
- Elija Create Auth0 Tenant.
- En la pantalla de configuración, busque el panel Metric stream. Copie el OTLP endpoint URL y el Bearer token (shown once).
- En Auth0, vaya a Monitoring → Streams → Create Stream y elija Metric Stream de tipo HTTP.
- Pegue la URL del endpoint OTLP.
- Elija Bearer Token como método de autenticación y pegue el token.
- Guarde el stream.
Configurar un metric stream en un tenant existente
Sección titulada «Configurar un metric stream en un tenant existente»La configuración está en la página API Metrics. No está en la página Edit del tenant.
- Abra Tenants y elija el icono de gráfico de líneas (API Metrics) en la fila de Auth0.
- En la tarjeta Enable the Auth0 Metric Stream, elija Generate endpoint. Solo los administradores pueden hacerlo. Los demás roles ven el botón desactivado, con el texto emergente “Admin access required to generate a metric-stream endpoint” (Se requiere acceso de administrador para generar un endpoint de metric stream).
- La tarjeta muestra el aviso “Shown once - copy these now. The header secret cannot be retrieved again after you leave this page.” (Se muestra una sola vez: cópielos ahora. El secreto de la cabecera no se puede recuperar después de salir de esta página.)
- Copie el Endpoint URL y el Header secret con sus botones Copy. Header name se muestra como referencia.
- En Auth0, siga los pasos de Manual setup in Auth0:
- Vaya a Monitoring → Streams → New Metric Stream.
- Elija el tipo HTTP.
- Pegue la URL del endpoint como endpoint OTLP.
- Elija Bearer Token como método de autenticación y pegue el secreto de la cabecera como token. Pegue solo el secreto.
- De vuelta en Identiguard, elija Continue to metrics. El secreto desaparece de la pantalla de forma definitiva.
- Observe el recuadro Stream status. Cambia de “nothing received yet” (todavía no se ha recibido nada) a Active cuando Auth0 entrega las primeras métricas.
Los controles
Sección titulada «Los controles»| Control | Qué hace |
|---|---|
| Botones de intervalo 5m, 15m, 1h, 24h, 7d, 30d, 90d | Definen el intervalo de tiempo de todas las tarjetas. El valor por defecto es 24h. |
| Siete menús de filtro: API, Operation, Failure code, Client ID, Connection ID, Country code, Grant type | Limitan todas las tarjetas a un valor. Cada uno empieza en All. |
| Updated Ns ago o Updated <time> | Cuándo se cargaron los datos por última vez |
| Icono de actualización (Refresh metrics) | Carga los datos de nuevo ahora |
El menú de intervalo
Sección titulada «El menú de intervalo»El intervalo define también el nivel de detalle de los gráficos.
| Intervalo | Un punto del gráfico es | Notas |
|---|---|---|
| 5m, 15m | Un segundo | Vista en directo. La página se actualiza sola cada 10 segundos mientras la pestaña del navegador está visible. Los filtros no están disponibles. |
| 1h, 24h | Un minuto | |
| 7d, 30d | Una hora | |
| 90d | Un día |
En 5m y 15m los menús de filtro están desactivados, con la nota “Dimension filters aren’t available on 5m/15m - per-second data can’t be filtered by dimension. Switch to 1h or a longer range to filter.” (Los filtros por dimensión no están disponibles en 5m/15m: los datos por segundo no se pueden filtrar por dimensión. Cambie a 1h o a un intervalo más largo para filtrar.)
Cuando parte de los datos más antiguos no se puede leer con los filtros que usted eligió, la página indica: “Some older history in this range could not be read with the current filters and was omitted from the charts below (never fabricated).” (Parte del historial más antiguo de este intervalo no se ha podido leer con los filtros actuales y se ha omitido de los gráficos siguientes, nunca se inventa.) Los gráficos muestran entonces menos historial que el intervalo. Borre los filtros o elija un intervalo más corto.
Las tarjetas
Sección titulada «Las tarjetas»Las tarjetas aparecen en este orden.
Recuadros de resumen
Sección titulada «Recuadros de resumen»| Recuadro | Qué muestra |
|---|---|
| Requests (<range>) | El total de peticiones de API en el intervalo. La indicación muestra “N not succeeded” (N sin éxito). |
| Success rate | La proporción de peticiones que tuvieron éxito, “across the selected range and filters” (en el intervalo y con los filtros seleccionados). Se pone en rojo por debajo del 90%. Indica No traffic cuando no hubo peticiones. |
| Max RPS | El “busiest single second in range” (el segundo con más actividad del intervalo), en peticiones por segundo |
| Avg RPS | El “average across the range” (la media en el intervalo), en peticiones por segundo |
| Rate limited | El número de peticiones que Auth0 rechazó con una respuesta 429 en el intervalo |
| Stream status | Active, o Stale en rojo. La indicación muestra “last received <time>” (última recepción) o “nothing received yet”. |
Stale significa que el metric stream está activado pero Identiguard no ha recibido nada durante más de 15 minutos, o no ha recibido nada nunca.
Max RPS y Avg RPS dependen de los datos por segundo, que Identiguard conserva desde el momento en que el stream hace su primera entrega. Antes de eso, indican Not available con “per-second history begins at the point of capture” (el historial por segundo empieza en el momento de la captura). Cuando los datos por segundo cubren solo una parte del intervalo, la indicación dice “measured over the last X of this Y range” (medido en los últimos X de este intervalo de Y).
Sustained request rate
Sección titulada «Sustained request rate»“How long traffic in the last <range> ran above each rate threshold, second-accurate.” (Cuánto tiempo estuvo el tráfico del último intervalo por encima de cada umbral de ritmo, con precisión de un segundo.)
Cuatro recuadros: >100 rps, >300 rps, >400 rps y >500 rps. Cada uno muestra una duración. Por ejemplo, 2 minutos en >300 rps significa que durante 120 segundos distintos del intervalo el tenant gestionó más de 300 peticiones por segundo.
Use esta tarjeta para comparar el tráfico real con el límite de peticiones de Auth0 del tenant. Responde a «cuánto tiempo estuvimos por encima del límite», algo que una media oculta.
API requests
Sección titulada «API requests»Barras apiladas, una barra por cada paso de tiempo. Cada barra se divide por tipo de respuesta:
- Succeeded
- Rate limited
- Error de cliente o de servidor
- Detección de anomalías
- Cualquier otro código de fallo
En 5m y 15m la división es más sencilla: Succeeded, Rate limited y Failed. Los datos por segundo no conservan la diferencia entre tipos de error.
Requests per second
Sección titulada «Requests per second»Un gráfico de líneas: “Bucket-average request rate, same window as the chart above - not the true instantaneous peak (see the sustained-rate card for that).” (Ritmo medio de peticiones por tramo, con el mismo intervalo que el gráfico anterior. No es el pico instantáneo real. Para eso, vea la tarjeta de ritmo sostenido.)
Cada punto es el ritmo medio durante un paso de tiempo. En 24h, un punto es la media de un minuto, así que una ráfaga corta parece aquí más pequeña de lo que fue. Para el pico real, lea Max RPS y Sustained request rate.
Response type
Sección titulada «Response type»Un gráfico de anillo junto al gráfico de líneas: “Share of requests by response type across the selected range and filters.” (Proporción de peticiones por tipo de respuesta en el intervalo y con los filtros seleccionados.) El centro muestra Total requests.
Per-stream request rate
Sección titulada «Per-stream request rate»Una tabla: “Requests, success rate and sustained rate for every Auth0 stream in the last <range>.” (Peticiones, tasa de éxito y ritmo sostenido de cada stream de Auth0 en el último intervalo.)
Columnas: Stream, Requests, Success %, Max RPS, Avg RPS, >100, >300, >400, >500 y Trend (un pequeño gráfico de líneas). En la página de un solo tenant la tabla tiene una fila.
Traffic by
Sección titulada «Traffic by»Un gráfico con un selector: App, Path, Country o Grant type. El título sigue al selector, por ejemplo Traffic by App. Muestra “Succeeded, rate-limited and failed requests by <dimension> in the last <range>, top 10 shown” (Peticiones con éxito, limitadas y fallidas por dimensión en el último intervalo, se muestran las 10 primeras).
- App agrupa por el client ID de Auth0. Úselo para encontrar qué aplicación causa el tráfico.
- Path agrupa por operación de API.
- Country agrupa por código de país.
- Grant type agrupa por tipo de concesión de OAuth. Solo las peticiones de token llevan un tipo de concesión, así que la mayor parte del tráfico no tiene ninguno.
Top rate-limited operations
Sección titulada «Top rate-limited operations»“Which Auth0 API operations were throttled (429) the most in the last <range>.” (Qué operaciones de API de Auth0 se limitaron más, con 429, en el último intervalo.) Columnas: Operation, % rate limited, Events, Rate limited. Las 10 primeras.
Busiest API operations
Sección titulada «Busiest API operations»“The 10 Auth0 API operations that carried the most requests in the last <range>.” (Las 10 operaciones de API de Auth0 con más peticiones en el último intervalo.) Columnas: Operation, Requests, % of range, Failed, % failed.
Failures by API operation
Sección titulada «Failures by API operation»“Which Auth0 API operations carried failure codes in the last <range>.” (Qué operaciones de API de Auth0 tuvieron códigos de fallo en el último intervalo.) Columnas: Operation, % failed, Events, Failed.
Leer la página en cinco pasos
Sección titulada «Leer la página en cinco pasos»- Elija un intervalo. Use 24h para una comprobación diaria, y 5m o 15m para seguir un incidente en directo.
- Lea Success rate y Rate limited. Una tasa de éxito en rojo o un recuento de peticiones limitadas por encima de cero requieren mirar más de cerca.
- Lea Sustained request rate y compárelo con el límite de peticiones de Auth0 del tenant.
- Use Top rate-limited operations y Failures by API operation para encontrar la operación.
- Cambie Traffic by a App para encontrar el cliente. Después limite todas las tarjetas con los menús de filtro, en 1h o en un intervalo más largo.
Estados vacíos
Sección titulada «Estados vacíos»| Qué ve | Significado |
|---|---|
| Tarjeta Enable the Auth0 Metric Stream | El tenant todavía no tiene metric stream |
| No traffic in range | Una tarjeta no tiene peticiones en el intervalo |
| No traffic en Success rate | No hay peticiones, así que no se puede calcular ninguna tasa |
| No Auth0 streams configured | No hay ningún stream que medir |
| Not available | Todavía no hay datos por segundo para el intervalo |
| “Metrics unavailable - the metrics query did not answer.” (Métricas no disponibles: la consulta de métricas no ha respondido.) | No se han podido cargar los datos |
En el panel
Sección titulada «En el panel»El Dashboard tiene una tarjeta Auth0 API metrics: “API request volume and response type from every Auth0 tenant’s metric stream, combined” (Volumen de peticiones de API y tipo de respuesta del metric stream de todos los tenants de Auth0, combinados). Aparece cuando el workspace tiene al menos un tenant de Auth0, aunque ninguno tenga metric stream.
Es el mismo panel para todos los tenants de Auth0 juntos, con dos diferencias:
- El último recuadro es Streams reporting, mostrado como N of M. La indicación dice “all streams receiving data” (todos los streams reciben datos), “stale: <names>” (sin datos recientes) o “not enabled: <names>” (no activado).
- Una tarjeta adicional Response type by stream muestra “Succeeded, rate-limited and failed requests per Auth0 stream in the selected range” (Peticiones con éxito, limitadas y fallidas por stream de Auth0 en el intervalo seleccionado).
Con más de un stream, Max RPS es el pico del stream individual con más actividad. No es un pico de todos los streams sumados.
Solución de problemas
Sección titulada «Solución de problemas»Configuración
Sección titulada «Configuración»| Qué ve | Por qué | Qué hacer |
|---|---|---|
| Tarjeta Enable the Auth0 Metric Stream en lugar de los gráficos | El metric stream no está activado para este tenant | Un administrador elige Generate endpoint y crea el stream en Auth0. |
| Generate endpoint está desactivado, con “Admin access required to generate a metric-stream endpoint” | Su rol es Member o Viewer | Pídaselo a un administrador del workspace. |
| “Failed to enable the metric stream (<status>).” (No se ha podido activar el metric stream.) o “Network error while generating the endpoint.” (Error de red al generar el endpoint.) | La petición ha fallado | Inténtelo de nuevo. |
| “Metric stream is already enabled for this tenant. Pass {“rotate”:true} to generate a new secret.” (El metric stream ya está activado para este tenant.) | El endpoint ya se había generado, por ejemplo en otra pestaña del navegador | Recargue la página. El secreto no se puede mostrar de nuevo y no hay ningún botón para emitir uno nuevo. Si el secreto se ha perdido, póngase en contacto con el equipo de producto. |
| No encuentra Metric Streams en el dashboard de Auth0 | El plan de Auth0 del cliente no los incluye | Confirme el plan con el cliente. Sin él, esta función no se puede usar. |
Lectura de la página
Sección titulada «Lectura de la página»| Qué ve | Por qué | Qué hacer |
|---|---|---|
| Stream status está en Stale, o indica “nothing received yet” | Auth0 no está entregando. El stream no se creó, el endpoint es incorrecto, el secreto es incorrecto o se escribió la palabra Bearer delante del secreto. |
En Auth0, abra el metric stream. Compruebe que el tipo es HTTP, que la autenticación es Bearer Token y que el token es solo el secreto. |
| Not available con “per-second history begins at the point of capture” | Todavía no existen datos por segundo para este intervalo | Espere. Los datos empiezan cuando el stream hace su primera entrega. |
| “measured over the last X of this Y range” | Los datos por segundo cubren solo una parte del intervalo | Es informativo. Elija un intervalo más corto para tener cobertura completa. |
| “Dimension filters aren’t available on 5m/15m - per-second data can’t be filtered by dimension. Switch to 1h or a longer range to filter.” | Los datos por segundo no se pueden filtrar | Elija 1h o más. |
| “Some older history in this range could not be read with the current filters and was omitted from the charts below (never fabricated).” | Los datos almacenados más antiguos no contienen el detalle de ese filtro | Borre los filtros, o elija un intervalo más corto. |
| “Metrics unavailable - the metrics query did not answer.” | No se han podido cargar los datos | Elija el icono de actualización. Escálelo si continúa. |
| No traffic in range, No traffic o No Auth0 streams configured | No se recibió nada en el intervalo | Elija un intervalo más largo. Compruebe Stream status. |
| La mayoría de las filas no muestran ningún tipo de concesión | Solo las peticiones de token llevan un tipo de concesión | Nada. Es normal. |
| El recuadro Streams reporting del panel muestra 0 of N con “not enabled: <names>” | Esos tenants de Auth0 no tienen metric stream | Configure uno, o ignore la tarjeta. |
| El recuadro Streams reporting del panel muestra “stale: <names>” | Esos streams no han entregado nada durante más de 15 minutos | Abra la página API Metrics de ese tenant y compruebe el stream en Auth0. |