Audit.NET中为HttpClient审计添加自定义字段的方法

在使用Audit.NET进行HTTP请求审计时，开发人员经常需要记录额外的上下文信息。本文将详细介绍如何在使用HttpClient进行API调用时添加自定义字段到审计日志中。

核心问题分析

当使用Audit.NET的HttpClient审计功能时，标准的配置方式如下：

var httpClient = Audit.Http.ClientFactory.Create(_ => _
    .IncludeRequestBody()
    .IncludeResponseHeaders()
    .FilterByRequest(req => req.Method.Method == "GET"));

这种方式虽然能很好地记录HTTP请求和响应的详细信息，但缺乏添加业务相关自定义字段的能力。常见的需求包括记录文档ID、用户信息或其他业务上下文数据。

解决方案

Audit.NET提供了通过Http请求选项传递附加信息到审计事件的方法。以下是实现这一功能的详细步骤：

1. 创建自定义配置

var httpClient = Audit.Http.ClientFactory.Create(_ => _
    .IncludeRequestBody()
    .IncludeResponseHeaders()
    .FilterByRequest(req => req.Method.Method == "GET")
    .WithCreationPolicy(EventCreationPolicy.Manual));

2. 设置自定义字段

在发起HTTP请求时，可以通过AuditScope设置自定义字段：

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.example.com/documents");
var auditOptions = new AuditHttpClientOptions
{
    EventType = "DocumentRequest",
    IncludeResponseHeaders = true,
    IncludeRequestBody = true
};

using (var auditScope = AuditScope.Create(auditOptions.EventType, null, 
    new { DocumentId = docId, UserId = userId }))
{
    auditOptions.AuditScope = auditScope;
    request.SetAuditOptions(auditOptions);
    
    var response = await httpClient.SendAsync(request);
}

3. 高级配置选项

对于更复杂的场景，还可以：

1. 动态字段设置：根据请求内容动态决定要记录的字段
2. 敏感数据过滤：配置数据遮蔽规则保护敏感信息
3. 条件记录：基于特定条件决定是否记录某些字段

实现原理

Audit.NET的HttpClient审计功能底层通过消息处理器(HttpMessageHandler)实现。当设置自定义字段时，这些信息会被附加到审计事件的CustomFields集合中，与HTTP请求/响应数据一起持久化。

最佳实践建议

1. 命名规范：为自定义字段使用一致的命名约定
2. 性能考虑：避免记录过大的数据对象
3. 安全考虑：注意不要记录敏感信息
4. 结构化数据：尽量使用结构化数据而非纯文本

通过这种方式，开发人员可以在审计日志中同时获得HTTP层面的技术细节和业务层面的上下文信息，显著增强了日志的实用性和可追溯性。