.NET Web API - 添加日志记录

时间:2014-06-20 00:01:22

标签: c# .net api logging asp.net-web-api

我正在寻找有关处理API日志记录的最佳方法的一些帮助。我想将所有请求和响应记录到sql或文本文件中,如果这是最好的方法。目前我一直在SQL Server的日志表中插入一行。我使用名为LogAction的静态方法执行此操作,并在Web API中的每个Controller的末尾附近运行它。我还记录了捕获的异常。有没有办法在本机上使用MVC Web API,或者我是在正确的轨道上?

目前它看起来像这样:

// Log API Call
System.Xml.Serialization.XmlSerializer x = new System.Xml.Serialization.XmlSerializer(request.GetType());
StringWriter s = new StringWriter();
x.Serialize(s, request);
Utilities.LogAction(Utilities.LogType.MAIN, false, response.ToString(), s.ToString(), "MainController: Successful");

有没有办法让它本地记录所有API操作?这对我来说是错误的,因为如果在这个静态方法和实际返回响应之间发生了某些事情,那么这个日志就不再有效了。记录API操作的最有效方法是什么?

1 个答案:

答案 0 :(得分:4)

为了记录对API动作的调用,我使用了这样的自定义属性:

public class LogApiRequestAttribute : System.Web.Http.Filters.ActionFilterAttribute
{
    /// <summary>
    /// For Web API controllers
    /// </summary>
    /// <param name="actionExecutedContext"></param>
    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
    {
        base.OnActionExecuted(actionExecutedContext);

        var request = actionExecutedContext.Request;
        var response = actionExecutedContext.Response;
        var actionContext = actionExecutedContext.ActionContext;

        // Log API Call
        ...
    }
}

您可能需要检查actionExecutedContext以查看它是否包含您想要的请求和响应信息。您可能希望改为覆盖OnActionExecuting方法,也可以覆盖。

然后用属性

装饰您的Web API Controller
[LogApiRequest]
public void Post(SomeThingInputModel thing)
{
    // Controller code
    ...
}