Registro HTTP en ASP.NET Core

Registro HTTP es un middleware que registra información sobre las solicitudes HTTP y las respuestas HTTP. El registro HTTP proporciona registros de:

• Información de solicitud HTTP
• Propiedades comunes
• Encabezados
• Cuerpo
• Información de respuesta HTTP

Registro HTTP es útil en varios escenarios para:

• Registrar información sobre las solicitudes y respuestas entrantes.
• Filtrar las partes de la solicitud y la respuesta que se registran.
• Filtrar los encabezados que se registrarán.

Registro HTTP puede reducir el rendimiento de una aplicación, especialmente al registrar los cuerpos de solicitud y respuesta. Tenga en cuenta el impacto en el rendimiento al seleccionar los campos que se van a registrar. Pruebe cómo inciden en el rendimiento las propiedades de registro seleccionadas.

Habilitación de Registro HTTP

Registro HTTP está habilitado con UseHttpLogging, que agrega middleware de registro 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!");
        });
    });
}

De forma predeterminada, Registro HTTP registra propiedades comunes como ruta de acceso, código de estado y encabezados para solicitudes y respuestas. La salida se registra como un único mensaje en LogLevel.Information.

Opciones de Registro HTTP

Para configurar el middleware de registro HTTP, llame a AddHttpLogging en 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 es una marca de enumeración que configura partes específicas de la solicitud y respuesta para registrar. LoggingFields se establece de forma predeterminada en 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 son un conjunto de encabezados de solicitud HTTP que se pueden registrar. Los valores de encabezado solo se registran para los nombres de encabezado que están en esta colección.

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 son un conjunto de encabezados de respuesta HTTP que se pueden registrar. Los valores de encabezado solo se registran para los nombres de encabezado que están en esta colección.

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 proporciona la configuración para seleccionar la codificación que se va a usar para un tipo de medio específico.

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;
    });
}

Métodos de MediaTypeOptions

• public void AddText(string contentType)
  • Agrega un objeto contentType que se usará para el registro como texto mediante la codificación UTF-8.
• public void AddText(string contentType, Encoding encoding)
  • Agrega un objeto contentType que se usará para el registro como texto mediante la codificación especificada.
• public void AddBinary(MediaTypeHeaderValue mediaType)
  • Agrega un objeto MediaTypeHeaderValue que se va a usar para el registro como binario.
• public void AddBinary(string contentType)
  • Agrega un contenido que se usará para el registro como texto mediante el tipo de contenido especificado.
• public void Clear()
  • Borra todos los objetos MediaTypes.

RequestBodyLogLimit

Tamaño máximo del cuerpo de la solicitud para registrar, en bytes. El valor predeterminado es 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

Tamaño máximo del cuerpo de la respuesta para registrar, en bytes. El valor predeterminado es 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;
    });
}