EsecuzioneRiepilogoPlugin

Crea un riepilogo delle richieste che passano attraverso il proxy.

Suggerimento

Usare un plug-in reporter nella configurazione per salvare il riepilogo in un file.

Screenshot di un prompt dei comandi con il riepilogo dell'esecuzione del proxy di sviluppo con informazioni sulle richieste intercettate.

Screenshot di un prompt dei comandi con il riepilogo delle richieste intercettate dal proxy di sviluppo.

Esempio di configurazione

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "ExecutionSummaryPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "executionSummaryPlugin"
    }
  ],
  "executionSummaryPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/executionsummaryplugin.schema.json",
    "groupBy": "url"
  }
}

Proprietà di configurazione

Proprietà Descrizione Predefinito
groupBy Come il proxy deve raggruppare le informazioni nel riepilogo. Opzioni disponibili: url, messageType url

Opzioni della riga di comando

Nome Descrizione Predefinito
--summary-group-by Come il proxy deve raggruppare le informazioni nel riepilogo. Opzioni disponibili: url, messageType url

Output

ExecutionSummaryPlugin crea il report quando si arresta la registrazione. Per salvare il report come JSON, aggiungere JsonReporter dopo ExecutionSummaryPlugin nella configurazione. JsonReporter scrive il report in un file denominato ExecutionSummaryPlugin_JsonReporter.json nella directory di lavoro corrente. Se il file esiste già, Dev Proxy aggiunge un timestamp al nome del file, ad esempio ExecutionSummaryPlugin_JsonReporter_20261105104151.json.

Il report JSON è un oggetto annidato a tre livelli profondi. I valori a livello più interno sono numeri che mostrano quante volte Dev Proxy ha registrato un messaggio. Il significato di ogni livello dipende dall'impostazione groupBy .

Dev Proxy usa i nomi di categoria leggibili seguenti nel report:

Category Descrizione
Requests intercepted Richiede l'intercettazione del proxy di sviluppo. Incluso solo quando groupBy è messageType
Requests passed through Richieste passate dal proxy di sviluppo al server originale
Requests mocked Richieste per le quali un plug-in ha restituito una risposta fittizia
Requests with chaos Richieste per le quali un plug-in ha simulato un errore o una latenza
Failures Richieste non riuscite
Tips Suggerimenti per i plug-in registrati per la richiesta
Warnings Avvisi relativi ai plug-in registrati per la richiesta
Unknown Altri messaggi registrati per la richiesta, ad esempio timestamp della richiesta e messaggi dai plug-in che hanno ignorato la richiesta

Raggruppa per URL

Quando groupBy è url, il report ha la forma seguente:

{
  "<method> <url>": {
    "<category>": {
      "<message>": <count>
    }
  }
}
livello Descrizione
1 Il metodo HTTP e l'URL di ogni richiesta intercettata, ad esempio GET https://jsonplaceholder.typicode.com/users. Ogni combinazione di metodi e URL viene visualizzata una sola volta, indipendentemente dal numero di chiamate dell'app
2 Categoria dei messaggi registrati dal proxy di sviluppo per la richiesta
3 Messaggio di registrazione del proxy di sviluppo, mappato al numero di volte in cui il proxy di sviluppo lo ha registrato per il metodo e l'URL

L'esempio seguente mostra un report per un'app chiamata GET https://jsonplaceholder.typicode.com/users una volta, che Dev Proxy ha simulato e GET https://jsonplaceholder.typicode.com/posts due volte, che dev Proxy ha passato. Le Unknown voci vengono abbreviate per la leggibilità.

{
  "GET https://jsonplaceholder.typicode.com/users": {
    "Unknown": {
      "2026-11-05T10:41:13.1151430+00:00": 1,
      "GET https://jsonplaceholder.typicode.com/users": 1
    },
    "Requests mocked": {
      "200 https://jsonplaceholder.typicode.com/users": 1
    }
  },
  "GET https://jsonplaceholder.typicode.com/posts": {
    "Unknown": {
      "No matching mock response found": 2,
      "GET https://jsonplaceholder.typicode.com/posts": 2
    },
    "Requests passed through": {
      "Passed through": 2
    }
  }
}

Raggruppa per tipo di messaggio

Quando groupBy è messageType, il report ha la forma seguente:

{
  "<category>": {
    "<message>": {
      "<method> <url>": <count>
    }
  }
}
livello Descrizione
1 Categoria dei messaggi registrati dal proxy di sviluppo
2 Messaggio di registrazione del proxy di sviluppo. Per le Requests intercepted categorie e Requests passed through , questo livello ripete il nome della categoria
3 Il metodo HTTP e l'URL della richiesta, mappati al numero di volte in cui Il proxy di sviluppo ha registrato il messaggio per il metodo e l'URL

Nell'esempio seguente viene illustrato il report per le stesse richieste raggruppate per tipo di messaggio. La Unknown categoria viene abbreviata per la leggibilità.

{
  "Requests intercepted": {
    "Requests intercepted": {
      "GET https://jsonplaceholder.typicode.com/users": 1,
      "GET https://jsonplaceholder.typicode.com/posts": 2
    }
  },
  "Unknown": {
    "No matching mock response found": {
      "GET https://jsonplaceholder.typicode.com/posts": 2
    }
  },
  "Requests mocked": {
    "200 https://jsonplaceholder.typicode.com/users": {
      "GET https://jsonplaceholder.typicode.com/users": 1
    }
  },
  "Requests passed through": {
    "Requests passed through": {
      "GET https://jsonplaceholder.typicode.com/posts": 2
    }
  }
}

Suggerimento

Per archiviare una pipeline CI che richiede Dev Proxy intercettato, usare il messageType raggruppamento e leggere le chiavi dell'oggetto ["Requests intercepted"]["Requests intercepted"] . Con il url raggruppamento leggere le chiavi di primo livello. Ogni chiave inizia con il metodo HTTP seguito da uno spazio e dall'URL. Non basarsi sul contenuto della Unknown categoria, perché include timestamp e altri messaggi di diagnostica.

Vedere anche

Passo successivo