HarGeneratorPlugin

Genererar HTTP-arkivfiler (HAR) från snappade begäranden och svar.

Konfigurationsexempel

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "HarGeneratorPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "harGeneratorPlugin"
    }
  ],
  "harGeneratorPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/hargeneratorplugin.schema.json",
    "includeSensitiveInformation": false,
    "includeResponse": true
  }
}

Konfigurationsegenskaper

Fastighet Description Förinställning
includeSensitiveInformation Avgör om känslig information ska inkluderas (auktoriseringshuvuden, cookies osv.) i den genererade HAR-filen. När värdet är inställt på falseredigeras värden för känsliga huvuden, cookies och känsliga frågeparametrar med värdet REDACTED false
includeResponse Avgör om innehållet i svarstexten ska inkluderas i den genererade HAR-filen false

Kommandoradsalternativ

None

Anmärkningar

FORMATET HAR (HTTP Archive) är ett JSON-baserat format för loggning av HTTP-transaktioner. Olika verktyg stöder det i stor utsträckning och använde det för att:

  • Analysera nätverkstrafik och prestanda
  • Felsöka API-interaktioner
  • Dela HTTP-sessionsdata
  • Importera till webbläsarutvecklarverktyg och andra analysverktyg

När includeSensitiveInformation är inställt på falseredigerar plugin-programmet automatiskt följande känsliga rubriker:

  • authorization
  • cookie
  • from
  • proxy-authenticate
  • proxy-authorization
  • set-cookie
  • www-authenticate
  • x-api-key
  • x-auth-token
  • x-csrf-token
  • x-forwarded-for
  • x-real-ip
  • x-session-token
  • x-xsrf-token

Plugin-programmet ersätter också värdena för alla begärande- och svarscookies (request.cookies och response.cookies) med REDACTED, samtidigt som cookienamnen behålls.

Dessutom redigerar plugin-programmet värdena för följande känsliga frågeparametrar (skiftlägesokänsliga) i både begärande-URL:en (request.url) och frågesträngen (request.queryString). Andra frågeparametrar behåller sina ursprungliga värden.

  • access_token
  • api_key
  • api-key
  • apikey
  • auth
  • client_secret
  • code
  • id_token
  • key
  • password
  • refresh_token
  • secret
  • sig
  • signature
  • token
  • x-amz-credential
  • x-amz-security-token
  • x-amz-signature
  • x-goog-credential
  • x-goog-signature

Till exempel registreras begärande-URL:en https://api.contoso.com/users?access_token=abc123&page=2 som https://api.contoso.com/users?access_token=REDACTED&page=2.

Den genererade HAR-filen innehåller:

  • HTTP-begärandeinformation (metod, URL, rubriker, frågeparametrar, cookies)
  • HTTP-svarsinformation (status, rubriker, cookies)
  • Brödtextdata för begäran och svar (om tillämpligt)
  • Innehållstyper och storlekar
  • HTTP-versionsinformation

Plugin-programmet skapar en HAR-fil med namnet devproxy-{timestamp}.har i den aktuella katalogen när inspelningen stoppas.

Se även

  • Uppdaterades senast