Audit.NET 实战：如何优化API请求日志记录与异常处理

引言

在现代Web应用开发中，完善的日志记录系统对于问题排查和系统监控至关重要。Audit.NET作为一个强大的审计日志框架，为.NET开发者提供了灵活的日志记录能力。本文将深入探讨如何优化API请求的日志记录策略，特别是针对不同HTTP方法和响应状态码的特殊处理。

核心问题分析

在实现API请求日志记录时，我们通常会遇到几个典型问题：

1. 对于GET和HEAD等只读请求，是否需要记录完整的请求和响应体
2. 对于204 No Content响应，如何处理响应体记录
3. 如何避免因日志数据过大导致的存储异常

解决方案实现

1. 选择性日志记录策略

通过Audit.NET的配置，我们可以精确控制哪些请求需要被记录：

app.UseAuditMiddleware(cfg =>
{
    // 排除GET和HEAD方法的请求
    cfg.FilterByRequest(rq => rq.Method != HttpMethods.Get && rq.Method != HttpMethods.Head)
        .WithEventType("{verb}.{controller}.{action}")
        .IncludeRequestBody()
        // 排除204状态码的响应体
        .IncludeResponseBody(c => c.Response.StatusCode != (int)HttpStatusCode.NoContent);
});

2. 使用全局过滤器替代中间件

更优雅的解决方案是使用AuditApiGlobalFilter，它提供了更精细的控制：

options.Filters.Add(new AuditApiGlobalFilter(f => f
    .LogRequestIf(rq => rq.Method != HttpMethods.Get && rq.Method != HttpMethods.Head)
    .WithEventType("{verb}.{controller}.{action}")
    .IncludeRequestBody()
    .IncludeResponseBody(p => p.HttpContext.Response.StatusCode != (int)HttpStatusCode.NoContent)
));

这种方法避免了不必要的中间件处理，直接在动作过滤器层面实现日志控制。

3. 大数据量处理策略

对于可能产生大体积请求/响应体的场景，我们需要实现智能截断：

Configuration.AddCustomAction(ActionType.OnEventSaving, scope =>
{
    var action = scope.GetWebApiAuditAction();

    // 处理超大请求体
    if (action?.RequestBody?.Value != null && action.RequestBody.Length > 32000)
    {
        action.RequestBody.Value = action.RequestBody.Value is string stringValue 
            ? (ExtractFileNameFromContent(stringValue) == "unknown" 
                ? "Request content too long..." 
                : $"File: {fileName}")
            : "Request content too long...";
    }

    // 处理超大响应体
    if (action?.ResponseBody?.Value != null && action.ResponseBody.Length > 16384)
    {
        action.ResponseBody.Value = "too long...";
    }
    
    // 其他可能的大数据字段处理
    action.Exception = action.Exception?[0..1000];
    
    // 处理表单变量
    foreach (var k in action.FormVariables.Keys)
    {
        if (action.FormVariables[k].Length > 1000)
        {
            action.FormVariables[k] = action.FormVariables[k][0..1000];
        }
    }
    
    // 处理请求头
    foreach (var k in action.Headers.Keys)
    {
        if (action.Headers[k].Length > 1000)
        {
            action.Headers[k] = action.Headers[k][0..1000];
        }
    }
});

最佳实践建议

1. 性能考量：对于高频API，建议完全排除GET/HEAD方法的日志记录，减少I/O压力
2. 存储优化：实现智能截断策略前，应先分析典型请求大小分布，设置合理的阈值
3. 异常处理：确保日志系统本身不会因记录日志而引发新的异常
4. 上下文保留：即使截断大内容，也应保留足够的问题诊断信息
5. 安全考虑：敏感信息应在记录前进行脱敏处理

总结

通过合理配置Audit.NET，我们可以构建一个既全面又高效的API请求日志系统。关键在于理解不同HTTP方法和状态码的特点，并针对性地实施记录策略。大数据量的智能处理和安全考量也是不可忽视的重要环节。本文提供的解决方案在实际项目中经过验证，能够有效平衡日志完整性和系统性能的需求。

对于更复杂的场景，开发者可以进一步扩展自定义动作，实现更精细的日志控制策略，如基于用户角色、API端点等维度的差异化记录配置。