ExecutionSummaryPlugin

Crée un résumé des requêtes qui passent par le proxy.

Conseil

Utilisez un plug-in reporter dans votre configuration pour enregistrer le résumé dans un fichier.

Capture d’écran d’une invite de commandes avec le résumé de l’exécution du proxy de développement avec des informations sur les demandes interceptées.

Capture d’écran d’une invite de commandes avec le résumé des demandes interceptées par le proxy de développement.

Exemple de configuration

{
  "$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"
  }
}

Propriétés de configuration

Propriété Descriptif Par défaut
groupBy Comment le proxy doit regrouper les informations dans le résumé. Options disponibles : url, messageType url

Options de ligne de commande

Nom Descriptif Par défaut
--summary-group-by Comment le proxy doit regrouper les informations dans le résumé. Options disponibles : url, messageType url

Output

ExecutionSummaryPlugin crée son rapport lorsque vous arrêtez l’enregistrement. Pour enregistrer le rapport au format JSON, ajoutez jsonReporter après ExecutionSummaryPlugin dans votre configuration. JsonReporter écrit le rapport dans un fichier nommé ExecutionSummaryPlugin_JsonReporter.json dans le répertoire de travail actif. Si le fichier existe déjà, le proxy de développement ajoute un horodatage au nom du fichier, par exemple ExecutionSummaryPlugin_JsonReporter_20261105104151.json.

Le rapport JSON est un objet imbriqué à trois niveaux. Les valeurs au niveau le plus interne sont des nombres qui indiquent le nombre de fois où le proxy de développement a enregistré un message. La signification de chaque niveau dépend du groupBy paramètre.

Le proxy de développement utilise les noms de catégorie lisibles suivants dans le rapport :

Catégorie Descriptif
Requests intercepted Demandes interceptées par le proxy de développement. Inclus uniquement quand groupBy est messageType
Requests passed through Demandes transmises par le proxy de développement au serveur d’origine
Requests mocked Demandes pour lesquelles un plug-in a retourné une réponse fictif
Requests with chaos Demandes pour lesquelles un plug-in a simulé une erreur ou une latence
Failures Demandes ayant échoué
Tips Conseils que les plug-ins enregistrés pour la demande
Warnings Avertissements indiquant que les plug-ins enregistrés pour la demande
Unknown Autres messages enregistrés pour la demande, tels que les horodatages de requête et les messages des plug-ins qui ont ignoré la requête

Regrouper par URL

Quand groupBy c’est urlle cas, le rapport a la forme suivante :

{
  "<method> <url>": {
    "<category>": {
      "<message>": <count>
    }
  }
}
Level Descriptif
1 Méthode HTTP et URL de chaque requête interceptée, par exemple GET https://jsonplaceholder.typicode.com/users. Chaque méthode et combinaison d’URL s’affiche une seule fois, peu importe le nombre de fois que votre application l’a appelée
2 Catégorie des messages enregistrés par le proxy de développement pour la demande
3 Message indiquant que le proxy de développement a enregistré, mappé au nombre de fois où le proxy de développement l’a journalisé pour la méthode et l’URL

L’exemple suivant montre un rapport pour une application appelée GET https://jsonplaceholder.typicode.com/users une seule fois, le proxy de développement simulé et GET https://jsonplaceholder.typicode.com/posts deux fois, via lequel le proxy de développement est passé. Les Unknown entrées sont raccourcies pour la lisibilité.

{
  "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
    }
  }
}

Regrouper par type de message

Quand groupBy c’est messageTypele cas, le rapport a la forme suivante :

{
  "<category>": {
    "<message>": {
      "<method> <url>": <count>
    }
  }
}
Level Descriptif
1 Catégorie des messages enregistrés par le proxy de développement
2 Message enregistré par le proxy de développement. Pour les catégories et Requests passed through les Requests intercepted catégories, ce niveau répète le nom de catégorie
3 La méthode HTTP et l’URL de la requête, mappées au nombre de fois où le proxy de développement a enregistré le message pour cette méthode et cette URL

L’exemple suivant montre le rapport pour les mêmes demandes regroupées par type de message. La Unknown catégorie est raccourcie pour la lisibilité.

{
  "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
    }
  }
}

Conseil

Pour vérifier dans un pipeline CI qui demande le proxy de développement intercepté, utilisez le messageType regroupement et lisez les clés de l’objet ["Requests intercepted"]["Requests intercepted"] . Avec le url regroupement, lisez les clés de niveau supérieur. Chaque clé commence par la méthode HTTP suivie d’un espace et de l’URL. Ne vous fiez pas au contenu de la Unknown catégorie, car il inclut des horodatages et d’autres messages de diagnostic.

Voir aussi

Étape suivante