> ## Documentation Index
> Fetch the complete documentation index at: https://auth0.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Comment créer des Flux de métriques

> Diffusez en continu les mesures Auth0 vers des plateformes de surveillance comme Datadog, New Relic et Splunk pour bénéficier d’une observabilité en temps réel.

> [!WARNING]
>
> **La fonctionnalité Flux de métriques est en .**

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

> [card] [Datadog](#set-up-datadog)
>
> Intégration native avec l’API de mesures de Datadog

> [card] [New Relic](#set-up-new-relic)
>
> Diffusion en continu par l’entremise d’OpenTelemetry Protocol (OTLP)

> [card] [Splunk](#set-up-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](https://auth0.com/docs/fr-ca/secure/tokens/access-tokens/management-api-access-tokens/get-management-api-access-tokens-for-production).

* **Auth0 CLI** : installez [Auth0 CLI](https://auth0.github.io/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](https://auth0.com/docs/fr-ca/deploy-monitor/metric-streams.md#supported-platforms).

## Configurer Datadog

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

### Informations requises

* Un [compte Datadog](https://www.datadoghq.com/) 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

> [tab] Dashboard
>
> **Accéder aux Flux de métriques :**
>
> 1. Accédez à [Auth0 Dashboard](https://manage.auth0.com) > **surveillance** > **Flux de métriques**.
> 2. Sélectionnez **+ Create Metric Stream**.
> 3. Sélectionnez **Datadog**.
>
> **Configurer le flux :**
>
> 1. **Name** : Saisissez un nom descriptif (p. ex. `datadog-production`).
> 2. **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
> 3. **Datadog API Key** : Collez votre clé d’API Datadog.
> 4. Sélectionnez **Save**.
>
> Votre Flux de métriques est alors créé et activé automatiquement.

> [tab] CLI
>
> 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](https://auth0.com/docs/fr-ca/deploy-monitor/auth0-cli.md) avant d’exécuter cette commande.
>
> ```bash theme={null}
> 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 :**
>
> ```json theme={null}
> {
>   "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

> [tab] Dashboard
>
> **Afficher tous les flux :**
>
> 1. Accédez à [Auth0 Dashboard](https://manage.auth0.com) > **Surveillance** > **Flux de métriques**.
> 2. Tous les flux configurés sont répertoriés avec leur destination, leur statut, leur nom et leurs abonnements.
>
> **Modifier un flux :**
>
> 1. Sélectionnez le nom du flux dans la liste.
> 2. Mettez à jour la configuration.
> 3. Sélectionnez **Sauvegarder**.
>
> **Activer ou désactiver un flux :**
>
> 1. Utilisez le **bouton bascule** dans la colonne Statut pour activer ou désactiver le flux.
> 2. Les flux désactivés n’envoient plus de mesures, mais conservent leur configuration.
>
> **Supprimer un flux :**
>
> 1. Sélectionnez le nom du flux dans la liste.
> 2. Sélectionnez **Supprimer** au bas de la page de configuration.
> 3. Confirmez la suppression.

> [tab] CLI
>
> **Lister tous les flux :**
>
> ```bash theme={null}
> auth0 api get /api/v2/metric-streams
> ```
>
> **Désactiver un flux :**
>
> ```bash theme={null}
> auth0 api patch /api/v2/metric-streams/YOUR_STREAM_ID \
>   --data '{"status":"disabled"}'
> ```
>
> **Réactiver un flux :**
>
> ```bash theme={null}
> 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

**1. Trouver votre terminal OTLP**

Consultez la [documentation OTLP de New Relic](https://docs.newrelic.com/docs/opentelemetry/best-practices/opentelemetry-otlp/#configure-endpoint-port-protocol) 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.

**2. Créer une clé de licence d’ingestion**

1. Accédez à **\[votre menu utilisateur]** > **API Keys**.
2. Sélectionnez **Create a key**.
3. Sélectionnez **Key Type** = **Ingest - License**.
4. Saisissez un nom descriptif et, au besoin, une note.
5. Sélectionnez **Create a key**.
6. 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

> [tab] Dashboard
>
> **Accéder aux Flux de métriques :**
>
> 1. Accédez à [Auth0 Dashboard](https://manage.auth0.com) > **Surveillance** > **Flux de métriques**.
> 2. Sélectionnez **+ Créer un flux de métriques**.
> 3. Sélectionnez **OpenTelemetry**.
>
> **Configurer le flux :**
>
> 1. **Nom** : Saisissez un nom descriptif (p. ex., `newrelic-production`).
> 2. **Protocole** : Sélectionnez **HTTP** dans la liste déroulante.
> 3. **Terminal OTLP** : Collez l’adresse de votre terminal OTLP New Relic (p. ex., `https://otlp.nr-data.net`).
> 4. **Méthode d’authentification** : Sélectionnez **Clé API** dans la liste déroulante.
> 5. **Nom de l’en-tête** : Saisissez `api-key`.
> 6. **Clé API** : Collez la clé de licence d’ingestion (Ingest License Key) New Relic que vous avez copiée aux étapes précédentes.
> 7. Sélectionnez **Sauvegarder**.
>
> Votre flux de métriques est alors créé et activé automatiquement.

> [tab] CLI
>
> ```bash theme={null}
> 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

**1. Trouver votre terminal OTLP**

Consultez la [documentation de l’exportateur OTLP HTTP de Splunk](https://help.splunk.com/en/splunk-observability-cloud/manage-data/splunk-distribution-of-the-opentelemetry-collector/get-started-with-the-splunk-distribution-of-the-opentelemetry-collector/collector-components/exporters/otlphttp-exporter) 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`).

**2. Créer un jeton d’accès**

1. Accédez à **Settings** > **Access Tokens** > **New Token**.
2. Saisissez un nom descriptif.
3. Réglez **Authorization Scope** à **INGEST** (obligatoire).
4. Définissez la date d’expiration du jeton.
5. Sélectionnez **Create**.
6. 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

> [tab] Dashboard
>
> **Accédez aux Flux de métriques :**
>
> 1. Allez dans [Auth0 Dashboard](https://manage.auth0.com) > **Surveillance** > **Flux de métriques**.
> 2. Sélectionnez **+ Créer un flux de métriques**.
> 3. Sélectionnez **OpenTelemetry**.
>
> **Configurez le flux :**
>
> 1. **Nom** : saisissez un nom descriptif (p. ex., `splunk-production`).
> 2. **Protocole** : sélectionnez **HTTP** dans le menu déroulant.
> 3. **Terminal OTLP** : collez votre terminal OTLP Splunk (p. ex., `https://ingest.us1.signalfx.com/v2/datapoint/otlp`).
> 4. **Méthode d’authentification** : sélectionnez **Clé API** dans le menu déroulant.
> 5. **Nom de l’en-tête** : saisissez `X-SF-TOKEN`.
> 6. **Clé API** : collez votre jeton d’accès Splunk (obtenu à l’étape 2 ci-dessus).
> 7. Sélectionnez **Sauvegarder**.
>
> Le flux de métriques est alors créé et activé automatiquement.

> [tab] CLI
>
> ```bash theme={null}
> 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 :**

> [tab] Dashboard
>
> 1. Accédez à [Auth0 Dashboard](https://manage.auth0.com) > **surveillance** > **Flux de métriques**.
> 2. Repérez votre flux de métriques dans la liste.
> 3. Vérifiez que la colonne **Status** affiche **Enabled**.
> 4. Sélectionnez le nom du flux pour afficher sa configuration détaillée et vérifier les paramètres.

> [tab] CLI
>
> ```bash theme={null}
> 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 :

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


## Related topics

- [About Metric Streams](https://auth0.com/docs/deploy-monitor/metric-streams.md)
- [Metric Streams Tags Reference](https://auth0.com/docs/deploy-monitor/metric-streams/reference.md)