ASP.NET Core 中的 HTTP 記錄

Note

這不是這篇文章的最新版本。關於目前版本，請參閱本文的 .NET 10 版本。

Warning

不再支援此版本的 ASP.NET Core。如需詳細資訊，請參閱 .NET 和 .NET Core 支持原則。如需目前的版本，請參閱本文的 .NET 9 版本。

HTTP 記錄是一個中介軟體，可記錄輸入 HTTP 要求和 HTTP 回應的相關資訊。 HTTP 記錄提供下列項目的記錄：

HTTP 要求資訊
一般屬性
Headers
Body
HTTP 回應資訊

HTTP 記錄可以：

記錄所有要求和回應，或只記錄符合特定條件的要求和回應。
請選擇要記錄的請求和回應部分。
可讓您從記錄中編輯敏感性資訊。

HTTP 記錄 可以降低應用程式的效能，尤其是在記錄要求和響應主體時。選取要記錄的欄位時，請考量效能影響。測試所選記錄屬性的效能影響。

Warning

HTTP 記錄可能會記錄個人識別資訊 (PII)。請考慮風險並避免記錄敏感性資訊。如需有關修訂的詳細資訊，請檢查修訂敏感數據

啟用 HTTP 記錄

HTTP 記錄是藉由呼叫 AddHttpLogging 和 UseHttpLogging 來啟用，如下列範例所示：

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(o => { });

var app = builder.Build();

app.UseHttpLogging();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}
app.UseStaticFiles();

app.MapGet("/", () => "Hello World!");

app.Run();

在上述範例中，呼叫 AddHttpLogging 的空白 Lambda 會新增具有預設組態的中介軟體。根據預設，HTTP 記錄會記錄一般屬性，例如要求和回應的路徑、狀態碼和標頭。

將下列這一行新增至 appsettings.Development.json 層級的 "LogLevel": { 檔案，以便顯示 HTTP 記錄：

"Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware": "Information"

使用預設組態時，要求和回應會記錄為類似下列範例的訊息組：

info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware[1]
      Request:
      Protocol: HTTP/2
      Method: GET
      Scheme: https
      PathBase:
      Path: /
      Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7
      Host: localhost:52941
      User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 Edg/118.0.2088.61
      Accept-Encoding: gzip, deflate, br
      Accept-Language: en-US,en;q=0.9
      Upgrade-Insecure-Requests: [Redacted]
      sec-ch-ua: [Redacted]
      sec-ch-ua-mobile: [Redacted]
      sec-ch-ua-platform: [Redacted]
      sec-fetch-site: [Redacted]
      sec-fetch-mode: [Redacted]
      sec-fetch-user: [Redacted]
      sec-fetch-dest: [Redacted]
info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware[2]
      Response:
      StatusCode: 200
      Content-Type: text/plain; charset=utf-8
      Date: Tue, 24 Oct 2023 02:03:53 GMT
      Server: Kestrel

HTTP 記錄選項

若要設定 HTTP 記錄中介軟體的全域選項，請在 AddHttpLogging 中呼叫 Program.cs，並使用 Lambda 來設定 HttpLoggingOptions。

using Microsoft.AspNetCore.HttpLogging;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(logging =>
{
    logging.LoggingFields = HttpLoggingFields.All;
    logging.RequestHeaders.Add("sec-ch-ua");
    logging.ResponseHeaders.Add("MyResponseHeader");
    logging.MediaTypeOptions.AddText("application/javascript");
    logging.RequestBodyLogLimit = 4096;
    logging.ResponseBodyLogLimit = 4096;
    logging.CombineLogs = true;
});

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}

app.UseStaticFiles();

app.UseHttpLogging();

app.Use(async (context, next) =>
{
    context.Response.Headers["MyResponseHeader"] =
        new string[] { "My Response Header Value" };

    await next();
});

app.MapGet("/", () => "Hello World!");

app.Run();

Note

在前述範例和後續範例中，UseHttpLogging 會在 UseStaticFiles 之後被呼叫，因此不會針對靜態文件啟用 HTTP 日誌。若要啟用靜態檔案 HTTP 記錄，請在 UseHttpLogging 之前呼叫 UseStaticFiles。

`LoggingFields`

HttpLoggingOptions.LoggingFields 是枚舉旗標，用於配置要記錄的請求和回應中的特定部分。 LoggingFields 預設為 RequestPropertiesAndHeaders | ResponsePropertiesAndHeaders。

`RequestHeaders` 和 `ResponseHeaders`

RequestHeaders 和 ResponseHeaders 是記錄的 HTTP 標頭集合。只有在這些集合中出現的標題名稱的標題值才會被記錄。下列程式碼會將 sec-ch-ua 新增至 RequestHeaders，因此會記錄 sec-ch-ua 標頭的值。還會將 MyResponseHeader 新增至 ResponseHeaders，因此會記錄 MyResponseHeader 標頭的值。如果移除這些行，這些標頭的值會是 [Redacted]。

using Microsoft.AspNetCore.HttpLogging;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(logging =>
{
    logging.LoggingFields = HttpLoggingFields.All;
    logging.RequestHeaders.Add("sec-ch-ua");
    logging.ResponseHeaders.Add("MyResponseHeader");
    logging.MediaTypeOptions.AddText("application/javascript");
    logging.RequestBodyLogLimit = 4096;
    logging.ResponseBodyLogLimit = 4096;
    logging.CombineLogs = true;
});

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}

app.UseStaticFiles();

app.UseHttpLogging();

app.Use(async (context, next) =>
{
    context.Response.Headers["MyResponseHeader"] =
        new string[] { "My Response Header Value" };

    await next();
});

app.MapGet("/", () => "Hello World!");

app.Run();

`MediaTypeOptions`

MediaTypeOptions 會提供設定，以選取要用於特定媒體類型的編碼方式。

using Microsoft.AspNetCore.HttpLogging;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(logging =>
{
    logging.LoggingFields = HttpLoggingFields.All;
    logging.RequestHeaders.Add("sec-ch-ua");
    logging.ResponseHeaders.Add("MyResponseHeader");
    logging.MediaTypeOptions.AddText("application/javascript");
    logging.RequestBodyLogLimit = 4096;
    logging.ResponseBodyLogLimit = 4096;
    logging.CombineLogs = true;
});

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}

app.UseStaticFiles();

app.UseHttpLogging();

app.Use(async (context, next) =>
{
    context.Response.Headers["MyResponseHeader"] =
        new string[] { "My Response Header Value" };

    await next();
});

app.MapGet("/", () => "Hello World!");

app.Run();

此方法也可以用來啟用預設未記錄之資料的記錄功能 (例如表單資料，其可能具有 application/x-www-form-urlencoded 或 multipart/form-data 等媒體類型)。

`MediaTypeOptions` 方法

`RequestBodyLogLimit` 和 `ResponseBodyLogLimit`

using Microsoft.AspNetCore.HttpLogging;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(logging =>
{
    logging.LoggingFields = HttpLoggingFields.All;
    logging.RequestHeaders.Add("sec-ch-ua");
    logging.ResponseHeaders.Add("MyResponseHeader");
    logging.MediaTypeOptions.AddText("application/javascript");
    logging.RequestBodyLogLimit = 4096;
    logging.ResponseBodyLogLimit = 4096;
    logging.CombineLogs = true;
});

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}

app.UseStaticFiles();

app.UseHttpLogging();

app.Use(async (context, next) =>
{
    context.Response.Headers["MyResponseHeader"] =
        new string[] { "My Response Header Value" };

    await next();
});

app.MapGet("/", () => "Hello World!");

app.Run();

`CombineLogs`

將 CombineLogs 設定為 true，可將中介軟體設定為在請求和回應後把所有啟用的記錄合併成一個記錄檔。這包括請求、請求內容、回應、回應內容和持續時間。

using Microsoft.AspNetCore.HttpLogging;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(logging =>
{
    logging.LoggingFields = HttpLoggingFields.All;
    logging.RequestHeaders.Add("sec-ch-ua");
    logging.ResponseHeaders.Add("MyResponseHeader");
    logging.MediaTypeOptions.AddText("application/javascript");
    logging.RequestBodyLogLimit = 4096;
    logging.ResponseBodyLogLimit = 4096;
    logging.CombineLogs = true;
});

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}

app.UseStaticFiles();

app.UseHttpLogging();

app.Use(async (context, next) =>
{
    context.Response.Headers["MyResponseHeader"] =
        new string[] { "My Response Header Value" };

    await next();
});

app.MapGet("/", () => "Hello World!");

app.Run();

端點專屬配置

對於基本 API 應用程式中的端點專屬組態，可以使用 WithHttpLogging 擴充方法。下列範例示範如何設定一個端點的 HTTP 記錄：

app.MapGet("/response", () => "Hello World! (logging response)")
    .WithHttpLogging(HttpLoggingFields.ResponsePropertiesAndHeaders);

對於使用控制器之應用程式中的端點特定組態， [HttpLogging] 可以使用屬性。該屬性也可以在基本 API 應用程式中使用，如下列範例所示：

app.MapGet("/duration", [HttpLogging(loggingFields: HttpLoggingFields.Duration)]
    () => "Hello World! (logging duration)");

`IHttpLoggingInterceptor`

IHttpLoggingInterceptor 是一個服務介面，可用於實作處理個別要求和個別回應的回呼，以自訂要記錄的詳細資料。任何端點專屬的記錄設定會先被套用，然後可以在這些回呼（callback）函式中加以覆寫。實作可以：

檢查要求或回應。
啟用或停用任何 HttpLoggingFields。
調整要記錄的要求或回應內容的多少。
在記錄中新增自訂欄位。

在 IHttpLoggingInterceptor 中呼叫 AddHttpLoggingInterceptor 來註冊 Program.cs 實作。如果註冊多個 IHttpLoggingInterceptor 執行個體，則會依註冊的順序執行。

下列範例示範如何註冊 IHttpLoggingInterceptor 實作：

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(logging =>
{
    logging.LoggingFields = HttpLoggingFields.Duration;
});
builder.Services.AddHttpLoggingInterceptor<SampleHttpLoggingInterceptor>();

下列範例是關於 IHttpLoggingInterceptor 實作的例子，其特點如下：

檢查請求方法，並停用 POST 請求的記錄功能。
針對非 POST 請求：
- 編輯要求路徑、要求標頭和回應標頭。
- 將自訂欄位和欄位值新增至要求和回應記錄。

using Microsoft.AspNetCore.HttpLogging;

namespace HttpLoggingSample;

internal sealed class SampleHttpLoggingInterceptor : IHttpLoggingInterceptor
{
    public ValueTask OnRequestAsync(HttpLoggingInterceptorContext logContext)
    {
        if (logContext.HttpContext.Request.Method == "POST")
        {
            // Don't log anything if the request is a POST.
            logContext.LoggingFields = HttpLoggingFields.None;
        }

        // Don't enrich if we're not going to log any part of the request.
        if (!logContext.IsAnyEnabled(HttpLoggingFields.Request))
        {
            return default;
        }

        if (logContext.TryDisable(HttpLoggingFields.RequestPath))
        {
            RedactPath(logContext);
        }

        if (logContext.TryDisable(HttpLoggingFields.RequestHeaders))
        {
            RedactRequestHeaders(logContext);
        }

        EnrichRequest(logContext);

        return default;
    }

    public ValueTask OnResponseAsync(HttpLoggingInterceptorContext logContext)
    {
        // Don't enrich if we're not going to log any part of the response
        if (!logContext.IsAnyEnabled(HttpLoggingFields.Response))
        {
            return default;
        }

        if (logContext.TryDisable(HttpLoggingFields.ResponseHeaders))
        {
            RedactResponseHeaders(logContext);
        }

        EnrichResponse(logContext);

        return default;
    }

    private void RedactPath(HttpLoggingInterceptorContext logContext)
    {
        logContext.AddParameter(nameof(logContext.HttpContext.Request.Path), "RedactedPath");
    }

    private void RedactRequestHeaders(HttpLoggingInterceptorContext logContext)
    {
        foreach (var header in logContext.HttpContext.Request.Headers)
        {
            logContext.AddParameter(header.Key, "RedactedHeader");
        }
    }

    private void EnrichRequest(HttpLoggingInterceptorContext logContext)
    {
        logContext.AddParameter("RequestEnrichment", "Stuff");
    }

    private void RedactResponseHeaders(HttpLoggingInterceptorContext logContext)
    {
        foreach (var header in logContext.HttpContext.Response.Headers)
        {
            logContext.AddParameter(header.Key, "RedactedHeader");
        }
    }

    private void EnrichResponse(HttpLoggingInterceptorContext logContext)
    {
        logContext.AddParameter("ResponseEnrichment", "Stuff");
    }
}

使用此攔截器時，即使 HTTP 記錄設定為記錄 HttpLoggingFields.All，POST 要求也不會產生任何記錄。 GET 要求會產生類似下列範例的記錄：

info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware[1]
      Request:
      Path: RedactedPath
      Accept: RedactedHeader
      Host: RedactedHeader
      User-Agent: RedactedHeader
      Accept-Encoding: RedactedHeader
      Accept-Language: RedactedHeader
      Upgrade-Insecure-Requests: RedactedHeader
      sec-ch-ua: RedactedHeader
      sec-ch-ua-mobile: RedactedHeader
      sec-ch-ua-platform: RedactedHeader
      sec-fetch-site: RedactedHeader
      sec-fetch-mode: RedactedHeader
      sec-fetch-user: RedactedHeader
      sec-fetch-dest: RedactedHeader
      RequestEnrichment: Stuff
      Protocol: HTTP/2
      Method: GET
      Scheme: https
info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware[2]
      Response:
      Content-Type: RedactedHeader
      MyResponseHeader: RedactedHeader
      ResponseEnrichment: Stuff
      StatusCode: 200
info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware[4]
      ResponseBody: Hello World!
info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware[8]
      Duration: 2.2778ms

記錄組態優先順序

下列清單顯示記錄組態的優先順序：

HttpLoggingOptions 中的全域組態，設定方式是呼叫 AddHttpLogging。
屬性或擴充方法中的[HttpLogging]WithHttpLogging端點特定組態會覆寫全域組態。
IHttpLoggingInterceptor 會帶著結果一起被呼叫，並且可以進一步修改每個請求的組態。

HTTP 記錄是一個中介軟體，可記錄輸入 HTTP 要求和 HTTP 回應的相關資訊。 HTTP 記錄提供下列項目的記錄：

HTTP 要求資訊
一般屬性
Headers
Body
HTTP 回應資訊

下列幾種情況非常適合使用 HTTP 記錄：

記錄傳入要求和回應的相關資訊。
過濾請求和回應中被記錄的部分。
篩選要記錄的標頭。

HTTP 記錄 可以降低應用程式的效能，尤其是在記錄要求和響應主體時。選取要記錄的欄位時，請考量效能影響。測試所選記錄屬性的效能影響。

Warning

HTTP 記錄可能會記錄個人識別資訊 (PII)。請考慮風險並避免記錄敏感性資訊。

啟用 HTTP 記錄

使用 UseHttpLogging 啟用 HTTP 記錄功能，這將新增 HTTP 記錄中介軟體。

var builder = WebApplication.CreateBuilder(args);

var app = builder.Build();

app.UseHttpLogging();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}
app.UseStaticFiles();

app.MapGet("/", () => "Hello World!");

app.Run();

根據預設，HTTP 記錄會記錄一般屬性，例如要求和回應的路徑、狀態碼和標頭。將下列這一行新增至 appsettings.Development.json 層級的 "LogLevel": { 檔案，以便顯示 HTTP 記錄：

 "Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware": "Information"

輸出會記錄為位於 LogLevel.Information 的單一訊息。

範例要求輸出

HTTP 記錄選項

若要設定 HTTP 記錄中介軟體，請在 AddHttpLogging 中呼叫 Program.cs。

using Microsoft.AspNetCore.HttpLogging;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(logging =>
{
    logging.LoggingFields = HttpLoggingFields.All;
    logging.RequestHeaders.Add("sec-ch-ua");
    logging.ResponseHeaders.Add("MyResponseHeader");
    logging.MediaTypeOptions.AddText("application/javascript");
    logging.RequestBodyLogLimit = 4096;
    logging.ResponseBodyLogLimit = 4096;

});

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}

app.UseStaticFiles();

app.UseHttpLogging(); 

app.Use(async (context, next) =>
{
    context.Response.Headers["MyResponseHeader"] =
        new string[] { "My Response Header Value" };

    await next();
});

app.MapGet("/", () => "Hello World!");

app.Run();

Note

在上述範例和下列範例中，會在 UseHttpLogging 之後呼叫 UseStaticFiles，因此不會針對靜態檔案啟用 HTTP 記錄。若要啟用靜態檔案 HTTP 記錄，請在 UseHttpLogging 之前呼叫 UseStaticFiles。

`LoggingFields`

HttpLoggingOptions.LoggingFields 是枚舉旗標，用於配置要記錄的請求和回應中的特定部分。 HttpLoggingOptions.LoggingFields 預設為 RequestPropertiesAndHeaders | ResponsePropertiesAndHeaders。

`RequestHeaders`

Headers 是一組允許記錄的 HTTP 要求標頭。只會記錄此集合中標頭名稱的標頭值。下列程式碼會記錄要求標頭 "sec-ch-ua"。如果已移除 logging.RequestHeaders.Add("sec-ch-ua");，則會隱藏要求標頭 "sec-ch-ua" 的值。下列醒目提示的程式碼會呼叫 HttpLoggingOptions.RequestHeaders 和 HttpLoggingOptions.ResponseHeaders：

using Microsoft.AspNetCore.HttpLogging;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(logging =>
{
    logging.LoggingFields = HttpLoggingFields.All;
    logging.RequestHeaders.Add("sec-ch-ua");
    logging.ResponseHeaders.Add("MyResponseHeader");
    logging.MediaTypeOptions.AddText("application/javascript");
    logging.RequestBodyLogLimit = 4096;
    logging.ResponseBodyLogLimit = 4096;

});

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}

app.UseStaticFiles();

app.UseHttpLogging(); 

app.Use(async (context, next) =>
{
    context.Response.Headers["MyResponseHeader"] =
        new string[] { "My Response Header Value" };

    await next();
});

app.MapGet("/", () => "Hello World!");

app.Run();

`MediaTypeOptions`

MediaTypeOptions 會提供設定，以選取要用於特定媒體類型的編碼方式。

using Microsoft.AspNetCore.HttpLogging;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(logging =>
{
    logging.LoggingFields = HttpLoggingFields.All;
    logging.RequestHeaders.Add("sec-ch-ua");
    logging.ResponseHeaders.Add("MyResponseHeader");
    logging.MediaTypeOptions.AddText("application/javascript");
    logging.RequestBodyLogLimit = 4096;
    logging.ResponseBodyLogLimit = 4096;

});

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}

app.UseStaticFiles();

app.UseHttpLogging(); 

app.Use(async (context, next) =>
{
    context.Response.Headers["MyResponseHeader"] =
        new string[] { "My Response Header Value" };

    await next();
});

app.MapGet("/", () => "Hello World!");

app.Run();

此方法也可以用來為預設未記錄的資料啟用記錄功能。例如，表單資料可能含有以下媒體類型，比如 application/x-www-form-urlencoded 或 multipart/form-data。

`MediaTypeOptions` 方法

`RequestBodyLogLimit` 和 `ResponseBodyLogLimit`

using Microsoft.AspNetCore.HttpLogging;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(logging =>
{
    logging.LoggingFields = HttpLoggingFields.All;
    logging.RequestHeaders.Add("sec-ch-ua");
    logging.ResponseHeaders.Add("MyResponseHeader");
    logging.MediaTypeOptions.AddText("application/javascript");
    logging.RequestBodyLogLimit = 4096;
    logging.ResponseBodyLogLimit = 4096;

});

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}

app.UseStaticFiles();

app.UseHttpLogging(); 

app.Use(async (context, next) =>
{
    context.Response.Headers["MyResponseHeader"] =
        new string[] { "My Response Header Value" };

    await next();
});

app.MapGet("/", () => "Hello World!");

app.Run();

編輯或隱藏敏感數據

您可以藉由呼叫 AddHttpLoggingRedaction來啟用具有修訂的 Http 記錄：

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(logging =>
{
    logging.LoggingFields = HttpLoggingFields.Duration;
});

builder.Services.AddRedaction();
builder.Services.AddHttpLoggingRedaction(op => { });

如需取得有關 .NET數據修訂程式庫的詳細資訊，請參閱 .NET 中的數據修訂。

記錄修訂選項

若要設定使用修訂進行記錄的選項，請使用 Lambda 來呼叫 AddHttpLoggingRedactionProgram.cs 來設定 LoggingRedactionOptions：

using Microsoft.Extensions.Compliance.Classification;

namespace HttpLoggingSample
{
    public static class MyTaxonomyClassifications
    {
        public static string Name => "MyTaxonomy";

        public static DataClassification Private => new(Name, nameof(Private));
        public static DataClassification Public => new(Name, nameof(Public));
        public static DataClassification Personal => new(Name, nameof(Personal));
    }
}

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(o => { });
builder.Services.AddRedaction();

builder.Services.AddHttpLoggingRedaction(op =>
{
    op.RequestPathParameterRedactionMode = HttpRouteParameterRedactionMode.None;
    op.RequestPathLoggingMode = IncomingPathLoggingMode.Formatted;
    op.RequestHeadersDataClasses.Add(HeaderNames.Accept, MyTaxonomyClassifications.Public);
    op.ResponseHeadersDataClasses.Add(HeaderNames.ContentType, MyTaxonomyClassifications.Private);
    op.RouteParameterDataClasses = new Dictionary<string, DataClassification>
    {
        { "one", MyTaxonomyClassifications.Personal },
    };
    // Add the paths that should be filtered, with a leading '/'.
    op.ExcludePathStartsWith.Add("/home");
    op.IncludeUnmatchedRoutes = true;
});

var app = builder.Build();

app.UseHttpLogging();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}
app.UseStaticFiles();

app.MapGet("/", () => "Logged!");
app.MapGet("/home", () => "Not logged!");

app.Run();

使用先前的修訂組態，輸出會類似下列內容：

info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware[9]
      Request and Response:
      server.address: localhost:61361
      Path: /
      http.request.header.accept:
      Protocol: HTTP/2
      Method: GET
      Scheme: https
      http.response.header.content-type:
      StatusCode: 200
      Duration: 8.4684
info: Microsoft.AspNetCore.Hosting.Diagnostics[2]
      Request finished HTTP/2 GET https://localhost:61361/ - 200 - text/plain;+charset=utf-8 105.5334ms

Note

要求路徑/home不會記錄，因為它包含在屬性中ExcludePathStartsWith。 http.request.header.accept 和 http.response.header.content-type 已由 Microsoft.Extensions.Compliance.Redaction.ErasingRedactor 刪除。

`RequestPathLoggingMode`

RequestPathLoggingMode 會決定如何記錄要求路徑，無論是 Formatted 或 Structured，由 IncomingPathLoggingMode設定：

Formatted：紀錄不帶參數的請求路徑。
Structured：記錄包含參數的要求路徑。

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(o => { });
builder.Services.AddRedaction();

builder.Services.AddHttpLoggingRedaction(op =>
{
    op.RequestPathParameterRedactionMode = HttpRouteParameterRedactionMode.None;
    op.RequestPathLoggingMode = IncomingPathLoggingMode.Formatted;
    op.RequestHeadersDataClasses.Add(HeaderNames.Accept, MyTaxonomyClassifications.Public);
    op.ResponseHeadersDataClasses.Add(HeaderNames.ContentType, MyTaxonomyClassifications.Private);
    op.RouteParameterDataClasses = new Dictionary<string, DataClassification>
    {
        { "one", MyTaxonomyClassifications.Personal },
    };
    // Add the paths that should be filtered, with a leading '/'.
    op.ExcludePathStartsWith.Add("/home");
    op.IncludeUnmatchedRoutes = true;
});

var app = builder.Build();

app.UseHttpLogging();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}
app.UseStaticFiles();

app.MapGet("/", () => "Logged!");
app.MapGet("/home", () => "Not logged!");

app.Run();

`RequestPathParameterRedactionMode`

RequestPathParameterRedactionMode 指定如何遮蔽要求路徑中的路由參數，無論是 Strict、Loose 或 None，都由 HttpRouteParameterRedactionMode 設定：

Strict：要求路由參數被視為敏感資訊，需要明確標註數據分類，且預設會被隱藏。
Loose：根據預設，所有參數都被視為非敏感性，並預設包括在 as-is 中。
None：不論數據分類批註是否存在，路由參數都不會進行修訂。

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(o => { });
builder.Services.AddRedaction();

builder.Services.AddHttpLoggingRedaction(op =>
{
    op.RequestPathParameterRedactionMode = HttpRouteParameterRedactionMode.None;
    op.RequestPathLoggingMode = IncomingPathLoggingMode.Formatted;
    op.RequestHeadersDataClasses.Add(HeaderNames.Accept, MyTaxonomyClassifications.Public);
    op.ResponseHeadersDataClasses.Add(HeaderNames.ContentType, MyTaxonomyClassifications.Private);
    op.RouteParameterDataClasses = new Dictionary<string, DataClassification>
    {
        { "one", MyTaxonomyClassifications.Personal },
    };
    // Add the paths that should be filtered, with a leading '/'.
    op.ExcludePathStartsWith.Add("/home");
    op.IncludeUnmatchedRoutes = true;
});

var app = builder.Build();

app.UseHttpLogging();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}
app.UseStaticFiles();

app.MapGet("/", () => "Logged!");
app.MapGet("/home", () => "Not logged!");

app.Run();

`RequestHeadersDataClasses`

RequestHeadersDataClasses 會將要求標頭對應至其數據分類，以決定其修訂方式：

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(o => { });
builder.Services.AddRedaction();

builder.Services.AddHttpLoggingRedaction(op =>
{
    op.RequestPathParameterRedactionMode = HttpRouteParameterRedactionMode.None;
    op.RequestPathLoggingMode = IncomingPathLoggingMode.Formatted;
    op.RequestHeadersDataClasses.Add(HeaderNames.Accept, MyTaxonomyClassifications.Public);
    op.ResponseHeadersDataClasses.Add(HeaderNames.ContentType, MyTaxonomyClassifications.Private);
    op.RouteParameterDataClasses = new Dictionary<string, DataClassification>
    {
        { "one", MyTaxonomyClassifications.Personal },
    };
    // Add the paths that should be filtered, with a leading '/'.
    op.ExcludePathStartsWith.Add("/home");
    op.IncludeUnmatchedRoutes = true;
});

var app = builder.Build();

app.UseHttpLogging();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}
app.UseStaticFiles();

app.MapGet("/", () => "Logged!");
app.MapGet("/home", () => "Not logged!");

app.Run();

`ResponseHeadersDataClasses`

ResponseHeadersDataClasses，類似於 RequestHeadersDataClasses'，但針對回應標頭：

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(o => { });
builder.Services.AddRedaction();

builder.Services.AddHttpLoggingRedaction(op =>
{
    op.RequestPathParameterRedactionMode = HttpRouteParameterRedactionMode.None;
    op.RequestPathLoggingMode = IncomingPathLoggingMode.Formatted;
    op.RequestHeadersDataClasses.Add(HeaderNames.Accept, MyTaxonomyClassifications.Public);
    op.ResponseHeadersDataClasses.Add(HeaderNames.ContentType, MyTaxonomyClassifications.Private);
    op.RouteParameterDataClasses = new Dictionary<string, DataClassification>
    {
        { "one", MyTaxonomyClassifications.Personal },
    };
    // Add the paths that should be filtered, with a leading '/'.
    op.ExcludePathStartsWith.Add("/home");
    op.IncludeUnmatchedRoutes = true;
});

var app = builder.Build();

app.UseHttpLogging();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}
app.UseStaticFiles();

app.MapGet("/", () => "Logged!");
app.MapGet("/home", () => "Not logged!");

app.Run();

`RouteParameterDataClasses`

RouteParameterDataClasses 將路由參數對應至其資料分類：

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(o => { });
builder.Services.AddRedaction();

builder.Services.AddHttpLoggingRedaction(op =>
{
    op.RequestPathParameterRedactionMode = HttpRouteParameterRedactionMode.None;
    op.RequestPathLoggingMode = IncomingPathLoggingMode.Formatted;
    op.RequestHeadersDataClasses.Add(HeaderNames.Accept, MyTaxonomyClassifications.Public);
    op.ResponseHeadersDataClasses.Add(HeaderNames.ContentType, MyTaxonomyClassifications.Private);
    op.RouteParameterDataClasses = new Dictionary<string, DataClassification>
    {
        { "one", MyTaxonomyClassifications.Personal },
    };
    // Add the paths that should be filtered, with a leading '/'.
    op.ExcludePathStartsWith.Add("/home");
    op.IncludeUnmatchedRoutes = true;
});

var app = builder.Build();

app.UseHttpLogging();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}
app.UseStaticFiles();

app.MapGet("/", () => "Logged!");
app.MapGet("/home", () => "Not logged!");

app.Run();

`ExcludePathStartsWith`

ExcludePathStartsWith 指定應該完全從記錄中排除的路徑：

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(o => { });
builder.Services.AddRedaction();

builder.Services.AddHttpLoggingRedaction(op =>
{
    op.RequestPathParameterRedactionMode = HttpRouteParameterRedactionMode.None;
    op.RequestPathLoggingMode = IncomingPathLoggingMode.Formatted;
    op.RequestHeadersDataClasses.Add(HeaderNames.Accept, MyTaxonomyClassifications.Public);
    op.ResponseHeadersDataClasses.Add(HeaderNames.ContentType, MyTaxonomyClassifications.Private);
    op.RouteParameterDataClasses = new Dictionary<string, DataClassification>
    {
        { "one", MyTaxonomyClassifications.Personal },
    };
    // Add the paths that should be filtered, with a leading '/'.
    op.ExcludePathStartsWith.Add("/home");
    op.IncludeUnmatchedRoutes = true;
});

var app = builder.Build();

app.UseHttpLogging();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}
app.UseStaticFiles();

app.MapGet("/", () => "Logged!");
app.MapGet("/home", () => "Not logged!");

app.Run();

`IncludeUnmatchedRoutes`

IncludeUnmatchedRoutes 允許報告不相符的路由。如果被設定為 true，則會記錄路由所未識別路由的完整路徑，而非記錄路徑屬性的 Unknown 值。

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHttpLogging(o => { });
builder.Services.AddRedaction();

builder.Services.AddHttpLoggingRedaction(op =>
{
    op.RequestPathParameterRedactionMode = HttpRouteParameterRedactionMode.None;
    op.RequestPathLoggingMode = IncomingPathLoggingMode.Formatted;
    op.RequestHeadersDataClasses.Add(HeaderNames.Accept, MyTaxonomyClassifications.Public);
    op.ResponseHeadersDataClasses.Add(HeaderNames.ContentType, MyTaxonomyClassifications.Private);
    op.RouteParameterDataClasses = new Dictionary<string, DataClassification>
    {
        { "one", MyTaxonomyClassifications.Personal },
    };
    // Add the paths that should be filtered, with a leading '/'.
    op.ExcludePathStartsWith.Add("/home");
    op.IncludeUnmatchedRoutes = true;
});

var app = builder.Build();

app.UseHttpLogging();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}
app.UseStaticFiles();

app.MapGet("/", () => "Logged!");
app.MapGet("/home", () => "Not logged!");

app.Run();

意見反應

此頁面對您有幫助嗎？

Last updated on 2025-11-19

共用方式為

ASP.NET Core 中的 HTTP 記錄

啟用 HTTP 記錄

HTTP 記錄選項

LoggingFields

RequestHeaders 和 ResponseHeaders

MediaTypeOptions

MediaTypeOptions 方法

RequestBodyLogLimit 和 ResponseBodyLogLimit

CombineLogs

端點專屬配置

IHttpLoggingInterceptor

記錄組態優先順序

啟用 HTTP 記錄

HTTP 記錄選項

LoggingFields

RequestHeaders

MediaTypeOptions

MediaTypeOptions 方法

RequestBodyLogLimit 和 ResponseBodyLogLimit

編輯或隱藏敏感數據

記錄修訂選項

RequestPathLoggingMode

RequestPathParameterRedactionMode

RequestHeadersDataClasses

ResponseHeadersDataClasses

RouteParameterDataClasses

ExcludePathStartsWith

IncludeUnmatchedRoutes

意見反應

其他資源

`LoggingFields`

`RequestHeaders` 和 `ResponseHeaders`

`MediaTypeOptions`

`MediaTypeOptions` 方法

`RequestBodyLogLimit` 和 `ResponseBodyLogLimit`

`CombineLogs`

`IHttpLoggingInterceptor`

`LoggingFields`

`RequestHeaders`

`MediaTypeOptions`

`MediaTypeOptions` 方法

`RequestBodyLogLimit` 和 `ResponseBodyLogLimit`

`RequestPathLoggingMode`

`RequestPathParameterRedactionMode`

`RequestHeadersDataClasses`

`ResponseHeadersDataClasses`

`RouteParameterDataClasses`

`ExcludePathStartsWith`

`IncludeUnmatchedRoutes`