Enregistrer et exporter l’activité du proxy

En un clin d’œil
Objectif: Enregistrer et exporter l’activité du proxy de développement vers un fichier de rapport
Heure : 10 minutes
Plugins :ExecutionSummaryPlugin, MarkdownReporter
Prérequis :configurer le proxy de développement

Pour enregistrer et exporter l’activité proxy, utilisez ExecutionSummaryPlugin et un plug-in de rapport dans votre fichier de configuration.

L’exemple suivant montre comment configurer le Dev Proxy pour enregistrer et exporter l’activité du proxy à l’aide du plug-in ExecutionSummaryPlugin et du plug-in MarkdownReporter.

Fichier : devproxyrc.json

{
  "plugins": [
    {
      "name": "ExecutionSummaryPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll"
    },
    {
        "name": "MarkdownReporter",
        "enabled": true,
        "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll"
    }
  ],
  "urlsToWatch": [
    "https://jsonplaceholder.typicode.com/*"
  ]
}

Tip

Au lieu de créer vous-même la configuration, vous pouvez télécharger le préréglage prêt à l’emploi api-inventory, qui enregistre les URL que votre application appelle et un résumé de son activité :

devproxy config get api-inventory
devproxy --config-file "~dataFolder/configs/api-inventory/.devproxy/devproxyrc.json" --urls-to-watch "https://api.contoso.com/*"

Pour plus d’informations, consultez Utiliser des configurations prédéfinies.

Remarque

Pour exporter l’activité, le plug-in reporter doit être activé dans le fichier de configuration et placé après ExecutionSummaryPlugin dans la liste des plug-ins. Il est recommandé de placer un plug-in reporter à la fin de la liste des plug-ins.

Pour enregistrer l’activité, Dev Proxy doit être placé en mode enregistrement.

Il existe deux façons de démarrer l’enregistrement :

  • Enregistrez immédiatement. Démarrez le proxy avec l’option --record, par exemple devproxy --record.
  • Enregistrement ad hoc. Appuyez sur R pendant que le proxy est en cours d’exécution.

Lorsque l’enregistrement est activé, ◉ Recording... s’affiche dans la sortie du proxy.

Pour générer un rapport à partir de l’activité enregistrée, arrêtez l’enregistrement.

Il existe deux façons d’arrêter l’enregistrement :

  • Arrêter le proxy. Appuyez sur Ctrl + C.
  • Arrêter ad hoc. Appuyez sur S.

Par défaut, les activités sont regroupées par URL. Pour regrouper l’activité par type de message, utilisez l’option --summary-group-by .

devproxy --record --summary-group-by messageType

Où les rapports sont écrits

Lorsque vous arrêtez l’enregistrement, chaque reporter activé écrit un fichier pour chaque rapport généré par un plug-in de création de rapports. Dev Proxy écrit les fichiers dans le répertoire de travail actuel, qui est le dossier à partir duquel vous avez démarré Dev Proxy. Lorsque vous démarrez Dev Proxy en arrière-plan, par exemple dans un pipeline CI, veillez à le démarrer à partir du dossier dans lequel vous souhaitez que les rapports soient stockés.

Les fichiers de rapport utilisent la convention de nommage suivante :

<ReportingPlugin>_<Reporter>.<ext>

Par exemple, la configuration décrite dans cet article produit un fichier nommé ExecutionSummaryPlugin_MarkdownReporter.md.

Si un fichier portant ce nom existe déjà, Dev Proxy ne le remplace pas. Au lieu de cela, il ajoute un horodatage au nom du fichier, au format yyyyMMddHHmmss, par exemple ExecutionSummaryPlugin_MarkdownReporter_20261105103000.md. Le proxy de développement enregistre le nom de chaque fichier de rapport qu’il écrit, par exemple :

Writing report ExecutionSummaryPlugin to ExecutionSummaryPlugin_MarkdownReporter.md...

Le tableau suivant répertorie les extensions que chaque reporter utilise.

Journaliste Extension
JsonReporter .json (certains rapports utilisent une autre extension, par exemple .jsonc pour UrlDiscoveryPlugin)
MarkdownReporter .md
PlainTextReporter .txt

Remarque

Tout est enregistré localement. Aucune donnée n’est envoyée à Microsoft.

Enregistrer depuis des scripts et CI

Dans les scripts et les pipelines CI/CD, vous ne pouvez pas appuyer sur les touches pour démarrer et arrêter l’enregistrement. Au lieu de cela, exécutez Dev Proxy en arrière-plan et contrôlez l’enregistrement à l’aide de l’API Dev Proxy. Toutes les requêtes d’API nécessitent un jeton du porteur. Pour connaître le jeton à l’avance, définissez la variable d’environnement DEV_PROXY_API_TOKEN sur une valeur d’au moins 32 caractères avant de démarrer Dev Proxy.

La séquence minimale est la suivante :

  1. Définissez DEV_PROXY_API_TOKEN sur une valeur aléatoire d’au moins 32 caractères.
  2. Démarrez le proxy de développement en arrière-plan : devproxy --detach --as-system-proxy false -c devproxyrc.json.
  3. Patientez jusqu’à ce que GET /proxy réussisse.
  4. Démarrer l’enregistrement : POST /proxy avec {"recording": true}.
  5. Exécutez votre charge de travail avec les variables d’environnement HTTP_PROXY et HTTPS_PROXY pointant vers Dev Proxy.
  6. Arrêter l’enregistrement : POST /proxy avec {"recording": false}. La requête se termine une fois que les générateurs de rapports ont terminé leur traitement. Les rapports sont donc prêts à la fin de la requête.
  7. Arrêtez Dev Proxy : POST /proxy/stopProxy.

Dev Proxy écrit les rapports dans le dossier à partir duquel vous l’avez démarré.

#!/usr/bin/env bash
set -euo pipefail

# 1. use a known API token (at least 32 characters)
export DEV_PROXY_API_TOKEN=$(openssl rand -hex 32)
api=http://127.0.0.1:8897
auth="Authorization: Bearer $DEV_PROXY_API_TOKEN"

# 2. start Dev Proxy in the background
devproxy --detach --as-system-proxy false -c devproxyrc.json

# 3. wait for the API
until curl -sf -H "$auth" "$api/proxy" > /dev/null; do sleep 1; done

# 4. start recording
curl -sf -X POST "$api/proxy" -H "$auth" -H "Content-Type: application/json" -d '{"recording": true}'

# 5. run the workload through Dev Proxy
HTTP_PROXY=http://127.0.0.1:8000 HTTPS_PROXY=http://127.0.0.1:8000 npm test

# 6. stop recording and wait for the reports
curl -sf -X POST "$api/proxy" -H "$auth" -H "Content-Type: application/json" -d '{"recording": false}'

# 7. shut down Dev Proxy
curl -sf -X POST "$api/proxy/stopProxy" -H "$auth"

Les exemples utilisent le port proxy par défaut 8000 et le port d’API par défaut 8897. Définissez les variables d’environnement du proxy uniquement pour la charge de travail afin que les appels d’API ne passent pas par Dev Proxy. Pour intercepter le trafic HTTPS, la charge de travail doit approuver le certificat racine de Dev Proxy. Pour plus d’informations sur l’exécution de Dev Proxy dans des pipelines, notamment l’approbation du certificat, consultez Utiliser Dev Proxy dans les scénarios CI/CD.

Voir aussi