Metric Streams

Envía métricas de Auth0 a plataformas de monitorización como Datadog, New Relic y Splunk para obtener observabilidad en tiempo real.

​

Metric Streams (Beta)

Metric Streams está disponible actualmente en Beta. Para usar esta función, debe tener un plan Enterprise. Al usar esta función, acepta los términos de prueba gratuita aplicables incluidos en el Master Subscription Agreement de Okta. Para obtener más información sobre el ciclo de lanzamiento de productos de Auth0, consulte Fases de lanzamiento del producto.

Transmita en tiempo real las métricas de Auth0 a su plataforma de monitoreo para hacer seguimiento del rendimiento de la API, identificar problemas de límite de tasa y resolver errores más rápido. Metric Streams es compatible tanto con la integración nativa con Datadog como con OpenTelemetry Protocol (OTLP) para plataformas como New Relic y Splunk.

​

Qué puede supervisar

Supervise métricas clave sobre el uso de las API de Auth0:

• Volumen de solicitudes a la API: Supervise el total de solicitudes a Authentication API y Management API.
• Tasas de error: Identifique errores del cliente y del servidor que afecten a su integración.
• Incidencias de límite de tasa: Detecte cuándo su aplicación alcanza los límites de tasa.
• Distribución geográfica: Analice los patrones de tráfico por país.
• Flujos de autenticación: Haga seguimiento de los tipos de concesión y del uso de las conexiones.

​

Casos de uso

​

Identifique problemas con los límites de tasa

Supervise qué API y endpoints alcanzan los límites de tasa para poder ajustar su integración o cambiar a un nivel superior de límite de tasa.

​

Diagnosticar fallos de la API

Identifique rápidamente la causa raíz de los errores filtrando las métricas por API, operación y tipo de fallo (límites de tasa, detección de anomalías o errores generales).

​

Planificación de capacidad

Analice el uso en picos, el RPS promedio y las métricas de percentiles para determinar el nivel de límite de tasa adecuado para su carga de trabajo.

​

Requisitos previos

Antes de configurar Metric Streams, necesitas:

• Acceso a Auth0 Management API: Crea una aplicación de Machine-to-Machine (M2M) con los siguientes permisos:

  • read:event_streams
  • create:event_streams
  • update:event_streams
  • delete:event_streams
  • read:event_deliveries
  • update:event_deliveries

  Para obtener instrucciones detalladas, consulta Obtener tokens de acceso para la Management API.

• Auth0 CLI: Instala Auth0 CLI para configurar Metric Streams mediante comandos de la API.

• Cuenta en una plataforma de monitorización: Una cuenta activa con uno de los destinos compatibles.

​

Referencia de métricas

​

auth0.api_request.count

Cuenta las solicitudes a la API de tu inquilino de Auth0 con etiquetas detalladas de filtrado y agregación. Se emite una nueva métrica cada 10 segundos y ofrece una granularidad de un segundo.

​

Etiquetas disponibles

Nombre de etiqueta	Obligatorio	Descripción
api	Sí	Tipo de API: AUTHENTICATION o MANAGEMENT
operation_name	Sí	Método HTTP y ruta (p. ej., POST /oauth/token)
operation_result	Sí	Resultado: SUCCESS o FAILURE
tenant	Sí	Nombre de tu inquilino de Auth0
failure_code	No	Motivo del error: RATE_LIMIT, ANOMALY_DETECTION o CLIENT_SERVER_ERROR
country_code	No	Código ISO del país a partir de la dirección IP de la solicitud
client_id	No	ID de cliente de la aplicación (solo Authentication API)
connection_id	No	ID de la conexión (solo Authentication API)
grant_type	No	Tipo de grant de OAuth 2.0 (solo Authentication API)
batch_seq	Sí	Número de secuencia para métricas con las mismas etiquetas y marca de tiempo (temporal; se eliminará después de la Beta)

Las etiquetas client_id y connection_id pueden generar una cardinalidad alta en entornos con muchos clientes o conexiones distintos, lo que puede aumentar los costos de monitoreo. Usa estas etiquetas de forma selectiva.

Los Metric Streams no incluyen las llamadas a la API que se almacenan en caché o que el Web Application Firewall (WAF) de Auth0 bloquea en el perímetro para evitar la sobrecarga del sistema.

​

Valores de enumeración

api

• AUTHENTICATION - Solicitudes a la Authentication API
• MANAGEMENT - Solicitudes a la Management API

operation_result

• SUCCESS - La solicitud se completó correctamente
• FAILURE - La solicitud falló debido a un error del cliente o del servidor

failure_code (solo está presente cuando operation_result es FAILURE)

• RATE_LIMIT - La solicitud superó el límite de tasa
• ANOMALY_DETECTION - Bloqueada por la protección contra ataques de Auth0
• CLIENT_SERVER_ERROR - Error HTTP 4xx o 5xx

​

Destinos compatibles

Metric Streams admite las siguientes plataformas de monitorización:

Datadog

Integración nativa con la API de métricas de Datadog

New Relic

Transmisión mediante OpenTelemetry Protocol (OTLP)

Splunk

Transmisión mediante OpenTelemetry Protocol (OTLP)

​

Configurar Datadog

Transmite métricas de Auth0 directamente a Datadog mediante su API nativa de métricas.

​

Requisitos previos

• Una cuenta activa de Datadog
• Una clave de API de Datadog (genérala en Organization Settings > API Keys de Datadog)
• Tu sitio de Datadog (un identificador de región, como US1 para app.datadoghq.com, EU para app.datadoghq.eu o US3 para us3.datadoghq.com)

​

Crear flujo de métricas

Dashboard

Vaya a Metric Streams:

1. Vaya a Auth0 Dashboard > Monitoring > Metric Streams.
2. Seleccione + Create Metric Stream.
3. Seleccione Datadog.

Configure el flujo:

1. Name: Introduzca un nombre descriptivo (por ejemplo, datadog-production).
2. Datadog Site: Seleccione su región de Datadog en el menú desplegable:
   • US1 para app.datadoghq.com
   • US3 para us3.datadoghq.com
   • US5 para us5.datadoghq.com
   • EU para app.datadoghq.eu
   • AP1 para ap1.datadoghq.com
3. Datadog API Key: Pegue la clave de API de Datadog.
4. Seleccione Save.

Esto crea y habilita automáticamente su Metric Stream.

CLI

Use la CLI de Auth0 para crear un flujo de métricas de Datadog:

auth0 api post metric-streams \
  --data '{
    "name": "datadog-production",
    "subscriptions": [{ "metric_type": "auth0.api_request.count" }],
    "destination": {
      "type": "datadog",
      "configuration": {
        "api_key": "YOUR_DATADOG_API_KEY",
        "site": "app.datadoghq.com"
      }
    }
  }'

Respuesta:

{
  "id": "mst_abc123xyz",
  "status": "enabled",
  "name": "datadog-production",
  "created_at": "2024-02-12T10:30:00Z",
  "updated_at": "2024-02-12T10:30:00Z",
  "destination": {
    "type": "datadog",
    "configuration": {
      "api_key": "***",
      "site": "app.datadoghq.com"
    }
  }
}

Guarde el valor de id para administrar este flujo más adelante.

​

Verificación en Datadog

En unos minutos, las métricas de Auth0 aparecerán en Datadog. Vaya a Metrics > Explorer y busque auth0.api_request.count para ver los datos.

​

Administrar streams

Dashboard

Ver todos los streams:

1. Vaya a Auth0 Dashboard > Monitoring > Metric Streams.
2. Todos los streams configurados aparecen con su Destination, Status, Name y Subscriptions.

Editar un stream:

1. Seleccione el nombre del stream en la lista.
2. Actualice la configuración.
3. Seleccione Save.

Habilitar/deshabilitar un stream:

1. Use el Toggle switch de la columna Status para habilitar o deshabilitar el stream.
2. Los streams deshabilitados dejan de enviar métricas, pero conservan su configuración.

Eliminar un stream:

1. Seleccione el nombre del stream en la lista.
2. Seleccione Delete al final de la página de configuración.
3. Confirme la eliminación.

CLI

Listar todos los streams:

auth0 api get /api/v2/metric-streams

Deshabilitar un stream:

auth0 api patch /api/v2/metric-streams/YOUR_STREAM_ID \
  --data '{"status":"disabled"}'

Volver a habilitar un stream:

auth0 api patch /api/v2/metric-streams/YOUR_STREAM_ID \
  --data '{"status":"enabled"}'

​

Configurar New Relic

Transmita las métricas de Auth0 a New Relic mediante el OpenTelemetry Protocol (OTLP).

​

Obtener credenciales de New Relic

1. Busca tu endpoint de OTLP

   Consulta la documentación de OTLP de New Relic para encontrar el endpoint correspondiente a tu región:

   • US: https://otlp.nr-data.net
   • EU: https://otlp.eu01.nr-data.net

   Guarda esta URL de endpoint.

2. Crear una clave de licencia de ingesta

   1. Ve a [tu menú de usuario] > API Keys.
   2. Selecciona Create a key.
   3. Selecciona Key Type = Ingest - License.
   4. Introduce un nombre descriptivo y una nota opcional.
   5. Selecciona Create a key.
   6. Copia la clave de API de inmediato. La necesitarás en pasos posteriores y no volverá a mostrarse.

​

Crear un flujo de métricas

Dashboard

Ve a Metric Streams:

1. Ve a Auth0 Dashboard > Monitoring > Metric Streams.
2. Selecciona + Create Metric Stream.
3. Selecciona OpenTelemetry.

Configura el flujo:

1. Name: Introduce un nombre descriptivo (por ejemplo, newrelic-production).
2. Protocol: Selecciona HTTP en el menú desplegable.
3. OTLP Endpoint: Pega el endpoint OTLP de New Relic (por ejemplo, https://otlp.nr-data.net).
4. Authentication Method: Selecciona API Key en el menú desplegable.
5. Header Name: Introduce api-key.
6. API Key: Pega la clave de licencia de ingesta de New Relic que copiaste en los pasos anteriores.
7. Selecciona Save.

Esto crea y habilita automáticamente el flujo de métricas.

CLI

auth0 api post metric-streams \
  --data '{
    "name": "newrelic-production",
    "subscriptions": [{ "metric_type": "metrics_bridge.api_request" }],
    "destination": {
      "type": "otlp",
      "configuration": {
        "endpoint": "YOUR_NEW_RELIC_ENDPOINT",
        "protocol": "http",
        "auth_type": "api_key",
        "api_key": "YOUR_INGEST_LICENSE_KEY",
        "auth_header_name": "api-key"
      }
    }
  }'

​

Configurar Splunk

Transmite las métricas de Auth0 a Splunk Observability Cloud mediante OpenTelemetry Protocol (OTLP).

​

Obtener las credenciales de Splunk

1. Busca tu endpoint de OTLP

   Consulta la documentación del exportador HTTP OTLP de Splunk para encontrar tu endpoint.

   El formato del endpoint es:

   https://ingest.<REALM>.signalfx.com/v2/datapoint/otlp
   

   Sustituye <REALM> por tu realm de Splunk (por ejemplo, us1, eu0, jp0).

2. Crear token de acceso

   1. Ve a Settings > Access Tokens > New Token.
   2. Introduce un nombre descriptivo.
   3. Establece Authorization Scope en INGEST (obligatorio).
   4. Configura la expiración del token.
   5. Selecciona Create.
   6. Copia y guarda de forma segura el valor del token. Lo necesitarás en los pasos posteriores.

​

Crear un flujo de métricas

Dashboard

Vaya a Metric Streams:

1. Vaya a Auth0 Dashboard > Monitoring > Metric Streams.
2. Seleccione + Create Metric Stream.
3. Seleccione OpenTelemetry.

Configure el flujo:

1. Nombre: Introduzca un nombre descriptivo (por ejemplo, splunk-production).
2. Protocolo: Seleccione HTTP en el menú desplegable.
3. Endpoint OTLP: Pegue el endpoint OTLP de Splunk (por ejemplo, https://ingest.us1.signalfx.com/v2/datapoint/otlp).
4. Método de autenticación: Seleccione API Key en el menú desplegable.
5. Nombre del encabezado: Introduzca X-SF-TOKEN.
6. API Key: Pegue su token de acceso de Splunk (del paso 2 anterior).
7. Seleccione Save.

El flujo de métricas se crea y se habilita automáticamente.

CLI

auth0 api post metric-streams \
  --data '{
    "name": "splunk-production",
    "subscriptions": [{ "metric_type": "metrics_bridge.api_request" }],
    "destination": {
      "type": "otlp",
      "configuration": {
        "endpoint": "YOUR_SPLUNK_ENDPOINT",
        "protocol": "http",
        "auth_type": "api_key",
        "api_key": "YOUR_SPLUNK_ACCESS_TOKEN",
        "auth_header_name": "X-SF-TOKEN"
      }
    }
  }'

​

Comprender la cardinalidad de las métricas

La cardinalidad se refiere a la cantidad de series temporales únicas que generan sus métricas. Una cardinalidad más alta incrementa los costos de monitoreo.

Tag	Cardinalidad	Impacto
api	Baja	2 valores únicos (Authentication, Management)
operation_name	Media	Varía según las operaciones de API que se utilicen
operation_result	Baja	2 valores únicos (Success, Failure)
tenant	Media	1 por inquilino de Auth0
failure_code	Baja	3 valores únicos (solo en caso de error)
country_code	Media-alta	Varía según la distribución geográfica
client_id	Alta	1 por cliente de aplicación
connection_id	Alta	1 por conexión de Proveedor de identidad
grant_type	Baja	Tipos de concesión de OAuth 2.0 limitados
batch_seq	Baja	Tag temporal (se elimina después de la Beta)

Use las tags client_id y connection_id con cuidado. En entornos con muchas aplicaciones o conexiones, estas tags pueden aumentar significativamente los costos. Considere filtrar por clientes específicos o agrupar estas tags si no necesita ese nivel de granularidad.

​

Solución de problemas

​

Métricas que no aparecen

Compruebe el estado del flujo:

Dashboard

1. Vaya a Auth0 Dashboard > Monitoring > Metric Streams.
2. Busque su flujo de métricas en la lista.
3. Verifique que la columna Status muestre Enabled.
4. Seleccione el nombre del flujo para ver la configuración detallada y verificar los ajustes.

CLI

auth0 api get /api/v2/metric-streams/YOUR_STREAM_ID

Verifique que el campo status sea enabled.

Verifique las credenciales de destino:

• Datadog: Confirme que su clave de API sea válida y que la URL del sitio coincida con su región de Datadog
• Destinos OTLP: Verifique que la URL del endpoint, el token de autenticación y el nombre del encabezado sean correctos

Compruebe si hay caché en el edge:

Recuerde que las solicitudes almacenadas en caché y las solicitudes bloqueadas por el WAF no se incluyen en los flujos de métricas.

​

Costos elevados de monitoreo

Si observas costos inesperadamente altos:

1. Revisa qué etiquetas estás usando en las consultas y los paneles.
2. Considera eliminar client_id y connection_id de las agregaciones.
3. Usa muestreo o filtrado en tu plataforma de monitoreo para reducir el volumen de métricas ingeridas.
4. Agrupa por etiquetas de nivel superior, como api y operation_result, en lugar de usar etiquetas granulares.