我有一个使用 .net 7 创建的 asp.net Web api。
我启用了 http 日志记录 以在应用程序日志中查看完整的 http 请求和响应。 (我知道它可能包含敏感信息,但考虑到应用程序的性质,这应该不是问题)。
Http 日志记录按预期工作,但我的一个疏忽除外。现在也正在记录 Swagger 响应。因此,每次我导航到 swagger 端点时,它都会使用 swagger HTML 和 swagger json 填充我的日志。像这样的事情:
Connection: keep-alive
Host: localhost:7122
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36
Accept-Encoding: gzip, deflate, br
Accept-Language: en-GB,en
Cookie: [Redacted]
Upgrade-Insecure-Requests: [Redacted]
Sec-GPC: [Redacted]
Sec-Fetch-Site: [Redacted]
Sec-Fetch-Mode: [Redacted]
Sec-Fetch-User: [Redacted]
Sec-Fetch-Dest: [Redacted]
sec-ch-ua: [Redacted]
sec-ch-ua-mobile: [Redacted]
sec-ch-ua-platform: [Redacted]
[14:55:42 INF] Response:
StatusCode: 200
Content-Type: text/html;charset=utf-8
[14:55:42 INF] ResponseBody: <!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="./swagger-ui.css">
<link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
<link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
<style>
html {
box-sizing: border-box;
overflow: -moz-scrollbars-vertical;
overflow-y: scroll;
}
*,
*:before,
*:after {
box-sizing: inherit;
}
body {
margin: 0;
background: #fafafa;
}
</style>
</head>
<body>
<div id="swagger-ui"></div>
<!-- Workaround for https://github.com/swagger-api/swagger-editor/issues/1371 -->
<script>
...
/// Rest left out because I think you get the point...
这不是一个主要问题,因为它在生产中很可能不会淹没日志,因为它不会一直是应用程序触发的主要请求,但在开发过程中它是正在使用的东西相当多,这有点令人恼火,因为它最终会用目前对我来说并不那么重要的信息填充日志。
在阅读有关 HttpLogging 的链接时,我确实看到我可以过滤掉 MediaTypeOptions。因为我只有一个 Web api,所以除了
application/json
之外我不需要任何东西,所以我想我会过滤掉除此之外的所有内容:
services
.AddHttpLogging(options =>
{
options.LoggingFields = HttpLoggingFields.All;
options.RequestBodyLogLimit = 4096;
options.ResponseBodyLogLimit = 4096;
options.MediaTypeOptions.Clear();
options.MediaTypeOptions.AddText("application/json");
})
但这似乎不起作用。我的日志中仍然被大肆输出所困扰。
要明确的是,我不想完全忽略 swagger 请求,我只是想忽略它们被记录在我的 httpLogging 中。
有没有一种简单的方法可以从我的 HttpLogging 中过滤掉 swagger?
任何帮助将不胜感激。
不知道为什么会发生这种情况(对我来说似乎有点误导性文档或错误,稍后会调查),但至少有 2 个解决方法:
大摇大摆后打电话
UseHttpLogging()
:
app.UseSwagger();
app.UseSwaggerUI();
app.UseHttpLogging();
使用条件语句:
app.UseWhen(ctx => !ctx.Request.Path.StartsWithSegments("/swagger"), // assuming default swagger path, if not - adjust accrodingly
appBuilder => appBuilder.UseHttpLogging());
UPD
IHttpLoggingInterceptor
:
builder.Services.AddHttpLoggingInterceptor<CustomHttpLoggingInterceptor>();
class CustomHttpLoggingInterceptor : IHttpLoggingInterceptor
{
public ValueTask OnRequestAsync(HttpLoggingInterceptorContext logContext)
{
if (logContext.HttpContext.Request.Path.StartsWithSegments("/swagger"))
{
logContext.LoggingFields = HttpLoggingFields.None;
}
return ValueTask.CompletedTask;
}
public ValueTask OnResponseAsync(HttpLoggingInterceptorContext logContext) => ValueTask.CompletedTask;
}