Comment créer des Flux de métriques

Les Flux de métriques prennent en charge les plateformes de surveillance suivantes :

Datadog

Intégration native avec l’API de mesures de Datadog

New Relic

Diffusion en continu par l’entremise d’OpenTelemetry Protocol (OTLP)

Splunk

Diffusion en continu par l’entremise d’OpenTelemetry Protocol (OTLP)

Informations requises

Avant de configurer un flux de métriques, vous devez disposer des éléments suivants :

Accès à Auth0 Management API : créez une application de communication entre machines (M2M) dotée des autorisations suivantes :
- read:event_streams
- create:event_streams
- update:event_streams
- delete:event_streams
- read:event_deliveries
- update:event_deliveries
Pour obtenir des instructions détaillées, consultez Obtenir des jetons d’accès pour Management API.
Auth0 CLI : installez Auth0 CLI pour configurer les flux de métriques à l’aide de commandes API.
Compte sur une plateforme de surveillance : un compte actif sur l’une des plateformes prises en charge.

Configurer Datadog

Transmettez en flux les mesures d’Auth0 directement à Datadog au moyen de son API de mesures native.

Informations requises

Un compte Datadog actif
Une clé API Datadog (à générer sous Organization Settings > API Keys dans Datadog)
Votre site Datadog (identifiant de région, par exemple US1 pour app.datadoghq.com, EU pour app.datadoghq.eu ou US3 pour us3.datadoghq.com)

Créer un flux de métriques

Dashboard
CLI

Accéder aux Flux de métriques :

Accédez à Auth0 Dashboard > surveillance > Flux de métriques.
Sélectionnez + Create Metric Stream.
Sélectionnez Datadog.

Configurer le flux :

Name : Saisissez un nom descriptif (p. ex. datadog-production).
Datadog Site : Sélectionnez votre région Datadog dans la liste déroulante :
- US1 pour app.datadoghq.com
- US3 pour us3.datadoghq.com
- US5 pour us5.datadoghq.com
- EU pour app.datadoghq.eu
- AP1 pour ap1.datadoghq.com
Datadog API Key : Collez votre clé d’API Datadog.
Sélectionnez Save.

Votre Flux de métriques est alors créé et activé automatiquement.

Utilisez Auth0 CLI pour créer un flux de métriques Datadog :

Vous utilisez Auth0 CLI? Si ce n’est pas déjà fait, configurez et authentifiez votre session CLI avant d’exécuter cette commande.

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"
      }
    }
  }'

Réponse :

{
  "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"
    }
  }
}

Notez la valeur id : vous en aurez besoin pour gérer ce flux par la suite.

Vérifier dans Datadog

D’ici quelques minutes, les mesures Auth0 s’afficheront dans Datadog. Accédez à Metrics > Explorer et recherchez auth0.api_request.count pour consulter vos données.

Gérer les flux

Dashboard
CLI

Afficher tous les flux :

Accédez à Auth0 Dashboard > Surveillance > Flux de métriques.
Tous les flux configurés sont répertoriés avec leur destination, leur statut, leur nom et leurs abonnements.

Modifier un flux :

Sélectionnez le nom du flux dans la liste.
Mettez à jour la configuration.
Sélectionnez Sauvegarder.

Activer ou désactiver un flux :

Utilisez le bouton bascule dans la colonne Statut pour activer ou désactiver le flux.
Les flux désactivés n’envoient plus de mesures, mais conservent leur configuration.

Supprimer un flux :

Sélectionnez le nom du flux dans la liste.
Sélectionnez Supprimer au bas de la page de configuration.
Confirmez la suppression.

Lister tous les flux :

auth0 api get /api/v2/metric-streams

Désactiver un flux :

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

Réactiver un flux :

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

Configurer New Relic

Transmettez en flux les mesures Auth0 vers New Relic à l’aide du protocole OpenTelemetry Protocol (OTLP).

Obtenir les informations d’identification New Relic

Trouver votre terminal OTLP

Consultez la documentation OTLP de New Relic pour trouver le terminal propre à votre région :

États-Unis : https://otlp.nr-data.net
UE : https://otlp.eu01.nr-data.net

Notez l’URL de ce terminal.

Créer une clé de licence d’ingestion

Accédez à [votre menu utilisateur] > API Keys.
Sélectionnez Create a key.
Sélectionnez Key Type = Ingest - License.
Saisissez un nom descriptif et, au besoin, une note.
Sélectionnez Create a key.
Copiez la clé API sans attendre. Vous en aurez besoin aux étapes suivantes, et elle ne sera plus affichée.

Créer un flux de métriques

Dashboard
CLI

Accéder aux Flux de métriques :

Accédez à Auth0 Dashboard > Surveillance > Flux de métriques.
Sélectionnez + Créer un flux de métriques.
Sélectionnez OpenTelemetry.

Configurer le flux :

Nom : Saisissez un nom descriptif (p. ex., newrelic-production).
Protocole : Sélectionnez HTTP dans la liste déroulante.
Terminal OTLP : Collez l’adresse de votre terminal OTLP New Relic (p. ex., https://otlp.nr-data.net).
Méthode d’authentification : Sélectionnez Clé API dans la liste déroulante.
Nom de l’en-tête : Saisissez api-key.
Clé API : Collez la clé de licence d’ingestion (Ingest License Key) New Relic que vous avez copiée aux étapes précédentes.
Sélectionnez Sauvegarder.

Votre flux de métriques est alors créé et activé automatiquement.

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"
      }
    }
  }'

Configurer Splunk

Transmettez en flux les mesures d’Auth0 vers Splunk Observability Cloud à l’aide du protocole OpenTelemetry Protocol (OTLP).

Obtenir les informations d’identification Splunk

Trouver votre terminal OTLP

Consultez la documentation de l’exportateur OTLP HTTP de Splunk pour trouver votre terminal.Le terminal respecte le format suivant :

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

Remplacez <REALM> par votre domaine Splunk (p. ex. us1, eu0, jp0).

Créer un jeton d’accès

Accédez à Settings > Access Tokens > New Token.
Saisissez un nom descriptif.
Réglez Authorization Scope à INGEST (obligatoire).
Définissez la date d’expiration du jeton.
Sélectionnez Create.
Copiez la valeur du jeton et conservez-la en lieu sûr. Vous en aurez besoin aux étapes suivantes.

Créer un flux de métriques

Dashboard
CLI

Accédez aux Flux de métriques :

Allez dans Auth0 Dashboard > Surveillance > Flux de métriques.
Sélectionnez + Créer un flux de métriques.
Sélectionnez OpenTelemetry.

Configurez le flux :

Nom : saisissez un nom descriptif (p. ex., splunk-production).
Protocole : sélectionnez HTTP dans le menu déroulant.
Terminal OTLP : collez votre terminal OTLP Splunk (p. ex., https://ingest.us1.signalfx.com/v2/datapoint/otlp).
Méthode d’authentification : sélectionnez Clé API dans le menu déroulant.
Nom de l’en-tête : saisissez X-SF-TOKEN.
Clé API : collez votre jeton d’accès Splunk (obtenu à l’étape 2 ci-dessus).
Sélectionnez Sauvegarder.

Le flux de métriques est alors créé et activé automatiquement.

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"
      }
    }
  }'

Dépannage

Les mesures n’apparaissent pas

Vérifiez l’état du flux :

Dashboard
CLI

Accédez à Auth0 Dashboard > surveillance > Flux de métriques.
Repérez votre flux de métriques dans la liste.
Vérifiez que la colonne Status affiche Enabled.
Sélectionnez le nom du flux pour afficher sa configuration détaillée et vérifier les paramètres.

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

Vérifiez que le champ status a la valeur enabled.

Vérifiez les informations d’identification de la destination :

Datadog : Confirmez que votre clé API est valide et que l’URL du site correspond à votre région Datadog
Destinations OTLP : Vérifiez que l’URL du terminal, le jeton d’authentification et le nom de l’en-tête sont exacts

Vérifiez la mise en cache en périphérie : N’oubliez pas que les requêtes mises en cache et celles bloquées par le WAF ne sont pas incluses dans les flux de métriques.

Coûts de surveillance élevés

Si vos coûts sont plus élevés que prévu :

Vérifiez les balises que vous utilisez dans vos requêtes et vos tableaux de bord.
Envisagez de retirer client_id et connection_id des agrégations.
Utilisez l’échantillonnage ou le filtrage dans votre plateforme de surveillance pour réduire le volume de mesures ingérées.
Agrégez selon des balises de plus haut niveau, comme api et operation_result, plutôt que selon des balises plus fines.

Concepts

Procédures

Référence

Comment créer des Flux de métriques

Datadog

New Relic

Splunk

Informations requises

Configurer Datadog

Informations requises

Créer un flux de métriques

Vérifier dans Datadog

Gérer les flux

Configurer New Relic

Obtenir les informations d’identification New Relic

Créer un flux de métriques

Configurer Splunk

Obtenir les informations d’identification Splunk

Créer un flux de métriques

Dépannage

Les mesures n’apparaissent pas

Coûts de surveillance élevés

Datadog

New Relic

Splunk

​Informations requises

​Configurer Datadog

​Informations requises

​Créer un flux de métriques

​Vérifier dans Datadog

​Gérer les flux

​Configurer New Relic

​Obtenir les informations d’identification New Relic

​Créer un flux de métriques

​Configurer Splunk

​Obtenir les informations d’identification Splunk

​Créer un flux de métriques

​Dépannage

​Les mesures n’apparaissent pas

​Coûts de surveillance élevés

Informations requises

Configurer Datadog

Informations requises

Créer un flux de métriques

Vérifier dans Datadog

Gérer les flux

Configurer New Relic

Obtenir les informations d’identification New Relic

Créer un flux de métriques

Configurer Splunk

Obtenir les informations d’identification Splunk

Créer un flux de métriques

Dépannage

Les mesures n’apparaissent pas

Coûts de surveillance élevés