Proxy du trafic du SDK Feature Flag

Documentation > Feature Flags > Guides sur les Feature Flags > Proxy du trafic du SDK Feature Flag

Présentation

Le SDK Datadog Feature Flag effectue deux types de requêtes réseau sortantes depuis votre application :

Téléchargement de la configuration des flags : le SDK récupère les attributions de flags précalculées depuis le CDN Datadog au démarrage et lorsque le contexte d’évaluation change. Cette requête détermine quelles variantes de flag sont renvoyées à votre application.
Téléversements d’événements : le SDK envoie les données d’événement d’exposition et d’évaluation aux endpoints d’ingestion Datadog.

Vous pouvez acheminer l’un ou l’autre de ces types de requêtes, ou les deux, via un proxy sur votre propre domaine. Les raisons courantes d’utiliser un proxy incluent :

Les politiques réseau qui restreignent l’accès direct aux domaines tiers depuis les appareils clients
Les exigences de résidence des données ou de conformité
Le contournement des bloqueurs de publicités pour les applications de navigateur

Les exemples de code sur cette page utilisent le site US1 (datadoghq.com) comme exemple. Remplacez les domaines Datadog par les valeurs correspondantes pour votre site Datadog.

Configurez le proxy

Passez des URL d’endpoint personnalisées à FlagsConfiguration.Builder avant d’appeler Flags.enable().

Proxy de configuration des flags

Pour acheminer le téléchargement de la configuration des flags via votre proxy, appelez useCustomFlagEndpoint avec l’URL complète exposée par votre proxy. Le SDK envoie une requête POST à cette URL avec le contexte d’évaluation dans le corps.

Application.kt

import com.datadog.android.flags.FlagsConfiguration

val flagsConfig = FlagsConfiguration.Builder()
    .useCustomFlagEndpoint("https://proxy.example.com/precompute-assignments")
    .build()

Flags.enable(flagsConfig)

Votre proxy doit transférer cette requête vers le CDN Datadog : https://preview.ff-cdn.datadoghq.com/precompute-assignments (remplacez le sous-domaine selon les besoins pour votre site Datadog). Transmettez le corps de la requête et tous les en-têtes sans modification.

Proxy de téléversement d’événements

Pour acheminer les téléversements d’événements d’exposition et d’évaluation via votre proxy, appelez les méthodes de constructeur correspondantes avec l’URL complète de votre endpoint de proxy.

Application.kt

import com.datadog.android.flags.FlagsConfiguration

val flagsConfig = FlagsConfiguration.Builder()
    .useCustomFlagEndpoint("https://proxy.example.com/precompute-assignments")
    .useCustomExposureEndpoint("https://proxy.example.com/api/v2/exposures")
    .useCustomEvaluationEndpoint("https://proxy.example.com/api/v2/flagevaluation")
    .build()

Flags.enable(flagsConfig)

Votre proxy doit transférer chaque requête vers l’endpoint d’ingestion Datadog correspondant pour votre site Datadog (le tableau suivant utilise le site US1 comme exemple) :

Chemin du proxy	Transférer vers
`/api/v2/exposures`	`https://api.datadoghq.com/api/v2/exposures`
`/api/v2/flagevaluation`	`https://api.datadoghq.com/api/v2/flagevaluation`

Définissez des URL d’endpoint personnalisées sur Flags.Configuration avant d’appeler Flags.enable(with:).

Proxy de configuration des flags

Pour acheminer le téléchargement de la configuration des flags via votre proxy, définissez customFlagsEndpoint sur l’URL complète exposée par votre proxy. Le SDK envoie une requête POST à cette URL avec le contexte d’évaluation dans le corps.

AppDelegate.swift

import DatadogFlags

let flagsConfig = Flags.Configuration(
    customFlagsEndpoint: URL(string: "https://proxy.example.com/precompute-assignments")
)

Flags.enable(with: flagsConfig)

Pour ajouter des en-têtes HTTP supplémentaires aux requêtes de configuration des flags (par exemple, pour l’authentification sur votre proxy), définissez customFlagsHeaders.

AppDelegate.swift

let flagsConfig = Flags.Configuration(
    customFlagsEndpoint: URL(string: "https://proxy.example.com/precompute-assignments"),
    customFlagsHeaders: ["X-Proxy-Token": "<YOUR_PROXY_TOKEN>"]
)

Proxy de téléversement d’événements

Pour acheminer les téléversements d’événements d’exposition et d’évaluation via votre proxy, définissez customExposureEndpoint et customEvaluationEndpoint.

AppDelegate.swift

let flagsConfig = Flags.Configuration(
    customFlagsEndpoint: URL(string: "https://proxy.example.com/precompute-assignments"),
    customExposureEndpoint: URL(string: "https://proxy.example.com/api/v2/exposures"),
    customEvaluationEndpoint: URL(string: "https://proxy.example.com/api/v2/flagevaluation")
)

Flags.enable(with: flagsConfig)

Votre proxy doit transférer chaque requête vers l’endpoint d’ingestion Datadog correspondant pour votre site Datadog (le tableau suivant utilise le site US1 comme exemple) :

Chemin du proxy	Transférer vers
`/api/v2/exposures`	`https://api.datadoghq.com/api/v2/exposures`
`/api/v2/flagevaluation`	`https://api.datadoghq.com/api/v2/flagevaluation`

Transmettez un objet FlagsConfiguration à DdFlags.enable().

Proxy de configuration des flags

Pour acheminer le téléchargement de la configuration des flags via votre proxy, définissez customFlagsEndpoint sur l’URL de base de votre proxy. Le SDK ajoute automatiquement /precompute-assignments à cette valeur et envoie une requête POST avec le contexte d’évaluation dans le corps.

App.tsx

import { DdFlags } from '@datadog/mobile-react-native';

await DdFlags.enable({
    customFlagsEndpoint: 'https://proxy.example.com',
    // SDK sends POST to: https://proxy.example.com/precompute-assignments
});

Proxy de téléversement d’événements

Pour acheminer les téléversements d’événements d’exposition via votre proxy, définissez customExposureEndpoint sur l’URL de base de votre proxy. Le SDK ajoute automatiquement /api/v2/exposures à cette valeur.

App.tsx

await DdFlags.enable({
    customFlagsEndpoint: 'https://proxy.example.com',
    customExposureEndpoint: 'https://proxy.example.com',
    // SDK sends POST to: https://proxy.example.com/api/v2/exposures
});

Votre proxy doit transférer les requêtes d’exposition vers l’endpoint d’ingestion Datadog correspondant pour votre site Datadog ; par exemple, pour le site US1, utilisez https://api.datadoghq.com/api/v2/exposures.

Le SDK React Native n'expose pas de customEvaluationEndpoint option. Les événements d'évaluation sont envoyés via le SDK natif Android ou iOS sous-jacent et ne peuvent pas être acheminés via un endpoint de proxy personnalisé.

Transmettez les options de configuration à DatadogBrowserFlagging.init().

Proxy de configuration des flags

Pour acheminer le téléchargement de la configuration des flags via votre proxy, définissez flaggingProxy sur l’URL de votre endpoint de proxy. Le SDK envoie une requête POST avec le contexte d’évaluation dans le corps directement à cette URL, en remplaçant l’endpoint CDN Datadog par défaut.

index.js

import { DatadogBrowserFlagging } from '@datadog/browser-flagging';

DatadogBrowserFlagging.init({
    clientToken: '<CLIENT_TOKEN>',
    site: 'datadoghq.com',
    flaggingProxy: 'https://proxy.example.com/precompute-assignments',
});

Pour ajouter des en-têtes personnalisés à la requête de configuration des flags (par exemple, pour l’authentification à votre proxy), utilisez customHeaders :

index.js

DatadogBrowserFlagging.init({
    clientToken: '<CLIENT_TOKEN>',
    site: 'datadoghq.com',
    flaggingProxy: 'https://proxy.example.com/precompute-assignments',
    customHeaders: { 'X-Proxy-Token': '<YOUR_PROXY_TOKEN>' },
});

Proxy de téléversement d’événements

Les données d’événement des flags du navigateur (expositions et évaluations) sont envoyées via le pipeline d’ingestion standard du SDK Browser. Pour acheminer ce trafic via un proxy, définissez l’option proxy sur une URL de votre domaine.

index.js

DatadogBrowserFlagging.init({
    clientToken: '<CLIENT_TOKEN>',
    site: 'datadoghq.com',
    flaggingProxy: 'https://proxy.example.com/precompute-assignments',
    proxy: 'https://proxy.example.com/intake',
});

Le SDK ajoute un paramètre de requête ddforward à chaque requête envoyée à votre proxy. Ce paramètre contient le chemin et la chaîne de requête encodés en URL vers lesquels votre proxy doit effectuer le transfert. Exemple :

POST https://proxy.example.com/intake?ddforward=%2Fapi%2Fv2%2Fexposures%3Fddsource%3Dbrowser...

Votre proxy décode la valeur ddforward et construit l’URL d’ingestion Datadog :

https://browser-intake-datadoghq.com/api/v2/exposures?ddsource=browser...

L’origine de l’ingestion varie selon le site Datadog. Par exemple, pour datadoghq.eu, il s’agit de https://browser-intake-datadoghq.eu. Transférez le corps de la requête POST sans modification et ajoutez un en-tête X-Forwarded-For avec l’adresse IP du client pour une géolocalisation précise. Supprimez tout en-tête sensible tel que cookie avant le transfert.

L’option proxy accepte également une fonction qui reçoit les path et parameters décodés et renvoie l’URL complète du proxy. Consultez Proxy Browser RUM Data pour la signature complète de la fonction.