在ASP.NET MVC中记录原始HTTP请求/响应& IIS7

时间:2009-06-24 13:44:32

标签: asp.net-mvc logging request ihttpmodule

我正在编写一个Web服务(使用ASP.NET MVC),出于支持目的,我们希望能够尽可能接近原始的在线格式记录请求和响应(即包括HTTP方法,路径,所有标题和正文)到数据库中。

我不确定如何以最少的“错位”方式掌握这些数据。通过检查HttpRequest对象的所有属性并从中构建字符串(以及类似的响应),我可以重新构建我认为请求的样子,但我真的想要了解实际情况在线上发送的请求/响应数据。

我很高兴使用任何拦截机制,如过滤器,模块等,解决方案可以特定于IIS7。但是,我更愿意将其保留在托管代码中。

有什么建议吗?

修改:我注意到HttpRequest有一个SaveAs方法,可以将请求保存到磁盘,但是这会使用内部帮助程序从内部状态重建请求无法公开访问的方法(这就是为什么这不允许保存到用户提供的流,我不知道)。所以它开始看起来我必须尽力从对象重建请求/响应文本......呻吟。

编辑2:请注意,我说整个请求包括方法,路径,标题等。当前响应仅查看不包含此内容的正文流信息。

编辑3 :没有人在这里阅读问题吗?到目前为止,有五个答案,但是没有一个答案暗示了一种获得整个原始线上请求的方法。是的,我知道我可以从请求对象中捕获输出流和标题以及URL和所有内容。我已在问题中说过,请参阅:

  

通过检查HttpRequest对象的所有属性并从中构建字符串(以及类似的响应),我可以重新构建我认为请求的样子,但我真的想得到实际的请求在线上发送的/响应数据。

如果你知道完整的原始数据(包括标题,网址,http方法等)根本无法检索,那么知道这将是有用的。同样地,如果你知道如何以原始格式获取所有内容(是的,我仍然意味着包括标题,网址,http方法等),而不必重新构建它,这就是我所问的,那将是非常有用的。但告诉我,我可以从HttpRequest / HttpResponse对象重建它是没有用的。我知道。我已经说过了。


请注意:在任何人开始说这是一个坏主意,或将限制可扩展性等之前,我们还将在分布式环境中实施限制,顺序传递和反重放机制,因此数据库无论如何都需要记录。我不是在寻找关于这是否是一个好主意的讨论,我正在寻找如何做到这一点。

15 个答案:

答案 0 :(得分:87)

绝对使用IHttpModule并实施BeginRequestEndRequest个活动。

HttpRequestHttpResponse之间存在所有“原始”数据,它不是单一的原始格式。以下是构建Fiddler样式转储所需的部分(尽可能接近原始HTTP):

request.HttpMethod + " " + request.RawUrl + " " + request.ServerVariables["SERVER_PROTOCOL"]
request.Headers // loop through these "key: value"
request.InputStream // make sure to reset the Position after reading or later reads may fail

对于回复:

"HTTP/1.1 " + response.Status
response.Headers // loop through these "key: value"

请注意您无法读取响应流,因此您必须向输出流添加过滤器并捕获副本。

BeginRequest中,您需要添加一个响应过滤器:

HttpResponse response = HttpContext.Current.Response;
OutputFilterStream filter = new OutputFilterStream(response.Filter);
response.Filter = filter;

filter存储在EndRequest处理程序中的位置。我建议HttpContext.Items。然后可以在filter.ReadStream()中获得完整的响应数据。

然后使用Decorator模式作为流的包装器实现OutputFilterStream

/// <summary>
/// A stream which keeps an in-memory copy as it passes the bytes through
/// </summary>
public class OutputFilterStream : Stream
{
    private readonly Stream InnerStream;
    private readonly MemoryStream CopyStream;

    public OutputFilterStream(Stream inner)
    {
        this.InnerStream = inner;
        this.CopyStream = new MemoryStream();
    }

    public string ReadStream()
    {
        lock (this.InnerStream)
        {
            if (this.CopyStream.Length <= 0L ||
                !this.CopyStream.CanRead ||
                !this.CopyStream.CanSeek)
            {
                return String.Empty;
            }

            long pos = this.CopyStream.Position;
            this.CopyStream.Position = 0L;
            try
            {
                return new StreamReader(this.CopyStream).ReadToEnd();
            }
            finally
            {
                try
                {
                    this.CopyStream.Position = pos;
                }
                catch { }
            }
        }
    }


    public override bool CanRead
    {
        get { return this.InnerStream.CanRead; }
    }

    public override bool CanSeek
    {
        get { return this.InnerStream.CanSeek; }
    }

    public override bool CanWrite
    {
        get { return this.InnerStream.CanWrite; }
    }

    public override void Flush()
    {
        this.InnerStream.Flush();
    }

    public override long Length
    {
        get { return this.InnerStream.Length; }
    }

    public override long Position
    {
        get { return this.InnerStream.Position; }
        set { this.CopyStream.Position = this.InnerStream.Position = value; }
    }

    public override int Read(byte[] buffer, int offset, int count)
    {
        return this.InnerStream.Read(buffer, offset, count);
    }

    public override long Seek(long offset, SeekOrigin origin)
    {
        this.CopyStream.Seek(offset, origin);
        return this.InnerStream.Seek(offset, origin);
    }

    public override void SetLength(long value)
    {
        this.CopyStream.SetLength(value);
        this.InnerStream.SetLength(value);
    }

    public override void Write(byte[] buffer, int offset, int count)
    {
        this.CopyStream.Write(buffer, offset, count);
        this.InnerStream.Write(buffer, offset, count);
    }
}

答案 1 :(得分:47)

HttpRequest上的以下扩展方法将创建一个可以粘贴到fiddler并重放的字符串。

namespace System.Web
{
    using System.IO;

    /// <summary>
    /// Extension methods for HTTP Request.
    /// <remarks>
    /// See the HTTP 1.1 specification http://www.w3.org/Protocols/rfc2616/rfc2616.html
    /// for details of implementation decisions.
    /// </remarks>
    /// </summary>
    public static class HttpRequestExtensions
    {
        /// <summary>
        /// Dump the raw http request to a string. 
        /// </summary>
        /// <param name="request">The <see cref="HttpRequest"/> that should be dumped.       </param>
        /// <returns>The raw HTTP request.</returns>
        public static string ToRaw(this HttpRequest request)
        {
            StringWriter writer = new StringWriter();

            WriteStartLine(request, writer);
            WriteHeaders(request, writer);
            WriteBody(request, writer);

            return writer.ToString();
        }

        private static void WriteStartLine(HttpRequest request, StringWriter writer)
        {
            const string SPACE = " ";

            writer.Write(request.HttpMethod);
            writer.Write(SPACE + request.Url);
            writer.WriteLine(SPACE + request.ServerVariables["SERVER_PROTOCOL"]);
        }

        private static void WriteHeaders(HttpRequest request, StringWriter writer)
        {
            foreach (string key in request.Headers.AllKeys)
            {
                writer.WriteLine(string.Format("{0}: {1}", key, request.Headers[key]));
            }

            writer.WriteLine();
        }

        private static void WriteBody(HttpRequest request, StringWriter writer)
        {
            StreamReader reader = new StreamReader(request.InputStream);

            try
            {
                string body = reader.ReadToEnd();
                writer.WriteLine(body);
            }
            finally
            {
                reader.BaseStream.Position = 0;
            }
        }
    }
}

答案 2 :(得分:35)

您可以使用ALL_RAW服务器变量来获取随请求一起发送的原始HTTP标头,然后您可以像往常一样获取InputStream:

string originalHeader = HttpHandler.Request.ServerVariables["ALL_RAW"];

结帐:http://msdn.microsoft.com/en-us/library/ms524602%28VS.90%29.aspx

答案 3 :(得分:16)

好吧,我正在开发一个项目,使用请求参数做了一个日志,也许不是太深,

看看:

public class LogAttribute : ActionFilterAttribute
{
    private void Log(string stageName, RouteData routeData, HttpContextBase httpContext)
    {
        //Use the request and route data objects to grab your data
        string userIP = httpContext.Request.UserHostAddress;
        string userName = httpContext.User.Identity.Name;
        string reqType = httpContext.Request.RequestType;
        string reqData = GetRequestData(httpContext);
        string controller = routeData["controller"];
        string action = routeData["action"];

        //TODO:Save data somewhere
    }

    //Aux method to grab request data
    private string GetRequestData(HttpContextBase context)
    {
        StringBuilder sb = new StringBuilder();

        for (int i = 0; i < context.Request.QueryString.Count; i++)
        {
            sb.AppendFormat("Key={0}, Value={1}<br/>", context.Request.QueryString.Keys[i], context.Request.QueryString[i]);
        }

        for (int i = 0; i < context.Request.Form.Count; i++)
        {
            sb.AppendFormat("Key={0}, Value={1}<br/>", context.Request.Form.Keys[i], context.Request.Form[i]);
        }

        return sb.ToString();
    }

您可以装饰控制器类以完全记录它:

[Log]
public class TermoController : Controller {...}

或仅记录一些单独的行动方法

[Log]
public ActionResult LoggedAction(){...}

答案 4 :(得分:11)

您需要将其保存在托管代码中的任何原因吗?

值得一提的是,如果您不想重新发明轮子,可以在IIS7中启用Failed Trace logging。这会记录标题,请求和响应正文以及许多其他内容。

Failed Trace Logging

答案 5 :(得分:8)

我选择了McKAMEY的方法。这是我写的一个模块,可以帮助您入门,希望能为您节省一些时间。您需要使用适合您的东西显然插入Logger:

public class CaptureTrafficModule : IHttpModule
{
    public void Init(HttpApplication context)
    {
        context.BeginRequest += new EventHandler(context_BeginRequest);
        context.EndRequest += new EventHandler(context_EndRequest);
    }

    void context_BeginRequest(object sender, EventArgs e)
    {
        HttpApplication app = sender as HttpApplication;

        OutputFilterStream filter = new OutputFilterStream(app.Response.Filter);
        app.Response.Filter = filter;

        StringBuilder request = new StringBuilder();
        request.Append(app.Request.HttpMethod + " " + app.Request.Url);
        request.Append("\n");
        foreach (string key in app.Request.Headers.Keys)
        {
            request.Append(key);
            request.Append(": ");
            request.Append(app.Request.Headers[key]);
            request.Append("\n");
        }
        request.Append("\n");

        byte[] bytes = app.Request.BinaryRead(app.Request.ContentLength);
        if (bytes.Count() > 0)
        {
            request.Append(Encoding.ASCII.GetString(bytes));
        }
        app.Request.InputStream.Position = 0;

        Logger.Debug(request.ToString());
    }

    void context_EndRequest(object sender, EventArgs e)
    {
        HttpApplication app = sender as HttpApplication;
        Logger.Debug(((OutputFilterStream)app.Response.Filter).ReadStream());
    }

    private ILogger _logger;
    public ILogger Logger
    {
        get
        {
            if (_logger == null)
                _logger = new Log4NetLogger();
            return _logger;
        }
    }

    public void Dispose()
    {
        //Does nothing
    }
}

答案 6 :(得分:5)

好的,所以看起来答案是“你不能得到原始数据,你必须从解析对象的属性重建请求/响应”。哦,我完成了重建工作。

答案 7 :(得分:3)

使用IHttpModule

    namespace Intercepts
{
    class Interceptor : IHttpModule
    {
        private readonly InterceptorEngine engine = new InterceptorEngine();

        #region IHttpModule Members

        void IHttpModule.Dispose()
        {
        }

        void IHttpModule.Init(HttpApplication application)
        {
            application.EndRequest += new EventHandler(engine.Application_EndRequest);
        }
        #endregion
    }
}

    class InterceptorEngine
    {       
        internal void Application_EndRequest(object sender, EventArgs e)
        {
            HttpApplication application = (HttpApplication)sender;

            HttpResponse response = application.Context.Response;
            ProcessResponse(response.OutputStream);
        }

        private void ProcessResponse(Stream stream)
        {
            Log("Hello");
            StreamReader sr = new StreamReader(stream);
            string content = sr.ReadToEnd();
            Log(content);
        }

        private void Log(string line)
        {
            Debugger.Log(0, null, String.Format("{0}\n", line));
        }
    }

答案 8 :(得分:3)

如果偶尔使用,绕过一个狭窄的角落,如下粗暴的东西怎么样?

Public Function GetRawRequest() As String
    Dim str As String = ""
    Dim path As String = "C:\Temp\REQUEST_STREAM\A.txt"
    System.Web.HttpContext.Current.Request.SaveAs(path, True)
    str = System.IO.File.ReadAllText(path)
    Return str
End Function

答案 9 :(得分:1)

您可以在DelegatingHandler中使用Stream.CopyToAsync()函数在不使用.NET 4.5中其他答案中提到的OutputFilter的情况下完成此操作。

我不确定细节,但它不会触发您尝试直接读取响应流时发生的所有不良事件。

示例:

public class LoggingHandler : DelegatingHandler
{
    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        DoLoggingWithRequest(request);
        var response = await base.SendAsync(request, cancellationToken);
        await DoLoggingWithResponse(response);
        return response;
    }

    private async Task DologgingWithResponse(HttpResponseMessage response) {
        var stream = new MemoryStream();
        await response.Content.CopyToAsync(stream).ConfigureAwait(false);     
        DoLoggingWithResponseContent(Encoding.UTF8.GetString(stream.ToArray()));

        // The rest of this call, the implementation of the above method, 
        // and DoLoggingWithRequest is left as an exercise for the reader.
    }
}

答案 10 :(得分:0)

HttpRequestHttpResponse之前的MVC曾经有GetInputStream()GetOutputStream()可用于此目的。没有在MVC中查看这些部分,所以我不确定它们是否可用,但可能是一个想法:)

答案 11 :(得分:0)

同意FigmentEngine,IHttpModule似乎是要走的路。

查看httpworkerrequestreadentitybodyGetPreloadedEntityBody

要获得httpworkerrequest,您需要执行此操作:

(HttpWorkerRequest)inApp.Context.GetType().GetProperty("WorkerRequest", bindingFlags).GetValue(inApp.Context, null);

其中inApp是httpapplication对象。

答案 12 :(得分:0)

我知道它不是托管代码,但我建议使用ISAPI过滤器。自从我有了“维护自己的ISAPI”的乐趣以来已经过去了几年,但据我所知,你可以访问所有这些内容,无论是在ASP.Net之前还是之后都做到了。

http://msdn.microsoft.com/en-us/library/ms524610.aspx

如果HTTPModule不能满足您的需求,那么我认为没有任何托管方式可以在所需的详细信息中执行此操作。尽管如此,这将是一种痛苦。

答案 13 :(得分:0)

我同意其他人的意见,使用IHttpModule。看一下这个问题的答案,这几乎和你要问的一样。它记录请求和响应,但没有标题。

How to trace ScriptService WebService requests?

答案 14 :(得分:0)

最好在您的应用程序之外执行此操作。您可以设置反向代理来执行此类操作(以及更多)。反向代理基本上是位于服务器机房中的Web服务器,位于Web服务器和客户端之间。见http://en.wikipedia.org/wiki/Reverse_proxy