Registrare ed esportare attività proxy

A colpo d'occhio
Obiettivo: Registrare ed esportare l'attività del proxy di sviluppo in un file di rapporto
Tempo: 10 minuti
Plugins:ExecutionSummaryPlugin, MarkdownReporter
Prerequisiti:Configurare il proxy di sviluppo

Per registrare ed esportare l'attività del proxy, utilizzare il ExecutionSummaryPlugin e un plug-in reporter nel file di configurazione.

L'esempio seguente illustra come configurare il proxy di sviluppo per registrare ed esportare l'attività proxy usando ExecutionSummaryPlugin e il plug-in MarkdownReporter.

File: 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

Invece di creare manualmente la configurazione, è possibile scaricare il set di impostazioni pronto api-inventory, che registra gli URL chiamati dall'app e un riepilogo dell'attività:

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

Per altre informazioni, vedere Usare configurazioni predefinite.

Nota

Per esportare l'attività, il plug-in reporter deve essere abilitato nel file di configurazione e inserito dopo ExecutionSummaryPlugin nell'elenco dei plug-in. È consigliabile inserire un plug-in reporter alla fine dell'elenco dei plug-in.

Per registrare l'attività, Dev Proxy deve essere inserito in modalità record.

Esistono due modi per avviare la registrazione:

  • Registra immediatamente. Avviare il proxy con l'opzione --record, ad esempio devproxy --record.
  • Registrare ad hoc. Premere R mentre il proxy è in esecuzione.

Quando la registrazione è abilitata, ◉ Recording... viene visualizzata nell'output del proxy.

Per generare un report dall'attività registrata, arrestare la registrazione.

Esistono due modi per arrestare la registrazione:

  • Ferma il proxy. Premere CTRL + C.
  • Arrestare l'adhoc. Premere S.

Per impostazione predefinita, le attività raggruppate in base all'URL. Per raggruppare l'attività in base al tipo di messaggio, usare l'opzione --summary-group-by .

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

Dove vengono scritti i report

Quando si arresta la registrazione, ogni reporter abilitato scrive un file per ogni report prodotto da un plug-in di report. Dev Proxy scrive i file nella directory di lavoro corrente, ovvero la cartella da cui hai avviato Dev Proxy. Quando si avvia Dev Proxy in background, ad esempio in una pipeline di integrazione continua, assicurarsi di avviarlo dalla cartella in cui si desidera archiviare i report.

I file di report usano il modello di denominazione seguente:

<ReportingPlugin>_<Reporter>.<ext>

Ad esempio, la configurazione in questo articolo produce un file denominato ExecutionSummaryPlugin_MarkdownReporter.md.

Se esiste già un file con tale nome, Dev Proxy non lo sovrascrive. Aggiunge invece un timestamp nel yyyyMMddHHmmss formato al nome del file, ad esempio ExecutionSummaryPlugin_MarkdownReporter_20261105103000.md. Dev Proxy registra il nome di ogni file di report che scrive, ad esempio:

Writing report ExecutionSummaryPlugin to ExecutionSummaryPlugin_MarkdownReporter.md...

Nella tabella seguente sono elencate le estensioni usate da ogni reporter.

Cronista Estensione
JsonReporter .json Alcuni report usano un'estensione diversa, ad esempio .jsonc per UrlDiscoveryPlugin.
MarkdownReporter .md
PlainTextReporter .txt

Nota

Tutte le registrazioni sono locali. Nessun dato viene inviato a Microsoft.

Registra dagli script e dall'integrazione continua

Negli script e nelle pipeline CI/CD non è possibile premere i tasti per avviare e arrestare la registrazione. Eseguire invece Dev Proxy in background e controllare la registrazione usando l'API Dev Proxy. Tutte le richieste API richiedono un token bearer. Per conoscere il token in anticipo, impostare la DEV_PROXY_API_TOKEN variabile di ambiente su un valore di almeno 32 caratteri prima di avviare Dev Proxy.

La sequenza minima è:

  1. Impostare DEV_PROXY_API_TOKEN su un valore casuale di almeno 32 caratteri.
  2. Avviare Dev Proxy in background: devproxy --detach --as-system-proxy false -c devproxyrc.json.
  3. Attendere finché GET /proxy riesce.
  4. Avviare la registrazione: POST /proxy con {"recording": true}.
  5. Esegui il carico di lavoro con le variabili di ambiente HTTP_PROXY e HTTPS_PROXY che puntano a Dev Proxy.
  6. Interrompi registrazione: POST /proxy con {"recording": false}. La richiesta si conclude al termine dei generatori di report, in modo che i report siano pronti quando si conclude.
  7. Arresta Dev Proxy: POST /proxy/stopProxy.

Dev Proxy scrive i report nella cartella da cui lo hai avviato.

#!/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"

Gli esempi usano la porta 8000 proxy predefinita e la porta 8897API . Impostare le variabili di ambiente proxy solo per il carico di lavoro, in modo che le chiamate API non attraversino Dev Proxy. Per intercettare il traffico HTTPS, il carico di lavoro deve considerare attendibile il certificato radice di Dev Proxy. Per altre informazioni sull'esecuzione di Dev Proxy nelle pipeline, inclusa l'attendibilità del certificato, vedere Usare Dev Proxy in scenari CI/CD.

Vedere anche