Přihlášení HTTP ASP.NET Core

Protokolování HTTP je middleware, který protokoluje informace o požadavcích HTTP a odpovědích HTTP. Protokolování HTTP poskytuje protokoly:

• Informace o požadavku HTTP
• Společné vlastnosti
• Hlavičky
• Text
• Informace o odpovědi HTTP

Protokolování HTTP je užitečné v několika scénářích:

• Zaznamenejte informace o příchozích požadavcích a odpovědích.
• Filtrovat, které části žádosti a odpovědi jsou protokolovány.
• Filtrování hlaviček, které se mají protokolovat

Protokolování HTTP může snížit výkon aplikace, zejména při protokolování těla žádosti a odpovědi. Při výběru polí pro protokolování Vezměte v úvahu dopad na výkon. Otestujte dopad na výkon vybraných vlastností protokolování.

Povolení protokolování HTTP

Protokolování HTTP je povoleno pomocí UseHttpLogging , které přidává middleware protokolování protokolu HTTP.

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseHttpLogging();

    app.UseRouting();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapGet("/", async context =>
        {
            await context.Response.WriteAsync("Hello World!");
        });
    });
}

Ve výchozím nastavení protokoluje protokolování HTTP společné vlastnosti, jako je například cesta, stavový kód a hlavičky pro žádosti a odpovědi. Výstup je protokolován jako jediná zpráva na adrese LogLevel.Information .

Možnosti protokolování HTTP

Chcete-li nakonfigurovat middleware protokolování HTTP, zavolejte AddHttpLogging na ConfigureServices .

public void ConfigureServices(IServiceCollection services)
{
    services.AddHttpLogging(logging =>
    {
        // Customize HTTP logging here.
        logging.LoggingFields = HttpLoggingFields.All;
        logging.RequestHeaders.Add("My-Request-Header");
        logging.ResponseHeaders.Add("My-Response-Header");
        logging.MediaTypeOptions.AddText("application/javascript");
        logging.RequestBodyLogLimit = 4096;
        logging.ResponseBodyLogLimit = 4096;
    });
}

LoggingFields

HttpLoggingOptions.LoggingFields je příznak výčtu, který konfiguruje určité části žádosti a odpovědi na protokol. LoggingFields Výchozí hodnota je RequestPropertiesAndHeaders | ResponsePropertiesAndHeaders .

public void ConfigureServices(IServiceCollection services)
{
    services.AddHttpLogging(logging =>
    {
        // Customize HTTP logging here.
        logging.LoggingFields = HttpLoggingFields.All;
        logging.RequestHeaders.Add("My-Request-Header");
        logging.ResponseHeaders.Add("My-Response-Header");
        logging.MediaTypeOptions.AddText("application/javascript");
        logging.RequestBodyLogLimit = 4096;
        logging.ResponseBodyLogLimit = 4096;
    });
}

RequestHeaders

RequestHeaders je sada hlaviček požadavků protokolu HTTP, které je povoleno protokolovat. Hodnoty hlaviček jsou protokolovány pouze pro názvy hlaviček, které jsou v této kolekci.

public void ConfigureServices(IServiceCollection services)
{
    services.AddHttpLogging(logging =>
    {
        // Customize HTTP logging here.
        logging.LoggingFields = HttpLoggingFields.All;
        logging.RequestHeaders.Add("My-Request-Header");
        logging.ResponseHeaders.Add("My-Response-Header");
        logging.MediaTypeOptions.AddText("application/javascript");
        logging.RequestBodyLogLimit = 4096;
        logging.ResponseBodyLogLimit = 4096;
    });
}

ResponseHeaders

ResponseHeaders je sada hlaviček HTTP odpovědi, které mohou být protokolovány. Hodnoty hlaviček jsou protokolovány pouze pro názvy hlaviček, které jsou v této kolekci.

public void ConfigureServices(IServiceCollection services)
{
    services.AddHttpLogging(logging =>
    {
        // Customize HTTP logging here.
        logging.LoggingFields = HttpLoggingFields.All;
        logging.RequestHeaders.Add("My-Request-Header");
        logging.ResponseHeaders.Add("My-Response-Header");
        logging.MediaTypeOptions.AddText("application/javascript");
        logging.RequestBodyLogLimit = 4096;
        logging.ResponseBodyLogLimit = 4096;
    });
}

MediaTypeOptions

MediaTypeOptions poskytuje konfiguraci pro výběr, které kódování se má použít pro určitý typ média.

public void ConfigureServices(IServiceCollection services)
{
    services.AddHttpLogging(logging =>
    {
        // Customize HTTP logging here.
        logging.LoggingFields = HttpLoggingFields.All;
        logging.RequestHeaders.Add("My-Request-Header");
        logging.ResponseHeaders.Add("My-Response-Header");
        logging.MediaTypeOptions.AddText("application/javascript");
        logging.RequestBodyLogLimit = 4096;
        logging.ResponseBodyLogLimit = 4096;
    });
}

MediaTypeOptions způsobů

• public void AddText(string contentType)
  • Přidá contentType, který se použije pro protokolování jako text pomocí kódování UTF-8.
• public void AddText(string contentType, Encoding encoding)
  • Přidá contentType, který se použije pro protokolování jako text pomocí zadaného kódování.
• public void AddBinary(MediaTypeHeaderValue mediaType)
  • Přidá objekt, MediaTypeHeaderValue který se použije pro protokolování jako binární.
• public void AddBinary(string contentType)
  • Přidá obsah, který se použije pro protokolování jako text pomocí zadaného typu obsahu.
• public void Clear()
  • Vymaže všechna MediaTypes.

RequestBodyLogLimit

Maximální velikost textu požadavku, která se má protokolovat, v bajtech Výchozí hodnota je 32 KB.

public void ConfigureServices(IServiceCollection services)
{
    services.AddHttpLogging(logging =>
    {
        // Customize HTTP logging here.
        logging.LoggingFields = HttpLoggingFields.All;
        logging.RequestHeaders.Add("My-Request-Header");
        logging.ResponseHeaders.Add("My-Response-Header");
        logging.MediaTypeOptions.AddText("application/javascript");
        logging.RequestBodyLogLimit = 4096;
        logging.ResponseBodyLogLimit = 4096;
    });
}

ResponseBodyLogLimit

Maximální velikost textu odezvy pro protokol v bajtech Výchozí hodnota je 32 KB.

public void ConfigureServices(IServiceCollection services)
{
    services.AddHttpLogging(logging =>
    {
        // Customize HTTP logging here.
        logging.LoggingFields = HttpLoggingFields.All;
        logging.RequestHeaders.Add("My-Request-Header");
        logging.ResponseHeaders.Add("My-Response-Header");
        logging.MediaTypeOptions.AddText("application/javascript");
        logging.RequestBodyLogLimit = 4096;
        logging.ResponseBodyLogLimit = 4096;
    });
}