HttpClient使用時のリクエスト/レスポンスメッセージのロギング


114

以下のようなPOSTを行うメソッドがあります

var response = await client.PostAsJsonAsync(url, entity);

if (response.IsSuccessStatusCode)
{
        // read the response as strongly typed object
        return await response.Content.ReadAsAsync<T>();
}

私の質問は、エンティティオブジェクトから投稿された実際のJSONを取得する方法です。POSTEDを取得したJSONをログに記録したいので、jsonを自分でシリアル化しなくてもそれを取得できると便利です。

回答:


196

これを行う方法の例:

いくつかのメモ:

  • LoggingHandlerリクエストを処理する前にインターセプトし、HttpClientHandler最終的にワイヤに書き込みます。

  • PostAsJsonAsync拡張機能は内部でを作成し、ObjectContentReadAsStringAsync()呼び出されると、LoggingHandler内部のフォーマッターObjectContentがオブジェクトをシリアル化するため、jsonでコンテンツが表示されます。

ロギングハンドラー:

public class LoggingHandler : DelegatingHandler
{
    public LoggingHandler(HttpMessageHandler innerHandler)
        : base(innerHandler)
    {
    }

    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        Console.WriteLine("Request:");
        Console.WriteLine(request.ToString());
        if (request.Content != null)
        {
            Console.WriteLine(await request.Content.ReadAsStringAsync());
        }
        Console.WriteLine();

        HttpResponseMessage response = await base.SendAsync(request, cancellationToken);

        Console.WriteLine("Response:");
        Console.WriteLine(response.ToString());
        if (response.Content != null)
        {
            Console.WriteLine(await response.Content.ReadAsStringAsync());
        }
        Console.WriteLine();

        return response;
    }
}

上記のLoggingHandlerをHttpClientでチェーンします

HttpClient client = new HttpClient(new LoggingHandler(new HttpClientHandler()));
HttpResponseMessage response = client.PostAsJsonAsync(baseAddress + "/api/values", "Hello, World!").Result;

出力:

Request:
Method: POST, RequestUri: 'http://kirandesktop:9095/api/values', Version: 1.1, Content: System.Net.Http.ObjectContent`1[
[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], Headers:
{
  Content-Type: application/json; charset=utf-8
}
"Hello, World!"

Response:
StatusCode: 200, ReasonPhrase: 'OK', Version: 1.1, Content: System.Net.Http.StreamContent, Headers:
{
  Date: Fri, 20 Sep 2013 20:21:26 GMT
  Server: Microsoft-HTTPAPI/2.0
  Content-Length: 15
  Content-Type: application/json; charset=utf-8
}
"Hello, World!"

3
これは、リクエストの詳細が必要な場合に便利ですが、サーバーに正確なリクエストを送信するのに失敗します。すべてのバイトをサーバーに送信する必要がある場合は、この方法では機能しません。
mathk 2014年

1
なぜnew HttpClientHandler()?これは、公式ドキュメントに存在していない:docs.microsoft.com/en-us/aspnet/web-api/overview/advanced/...
ZERO3

1
ああ、どうやら内部ハンドラーがnullであるという例外を取得しないことが必要です...
Zero3

3
また、上書きすることができますMessageProcessingHandler基本的に呼び出すProcessRequestと、ProcessResponse前と後のあなたのためのメソッドをSendAsyncコールします。
IllusiveBrian 2018

1
以下の@RamiAの答えは、コードを変更する必要がないため、より優れています。デバッグが完了したら、構成からトレースを削除します。これで完了です。新しいビルドを作成する必要はありません。
Tsahi Asher、2018

50

見る http://mikehadlow.blogspot.com/2012/07/tracing-systemnet-to-debug-http-clients.htmlをください

コンソールとログファイルの両方に出力するようにSystem.Netリスナーを構成するには、アセンブリ構成ファイルに以下を追加します。

<system.diagnostics>
  <trace autoflush="true" />
  <sources>
    <source name="System.Net">
      <listeners>
        <add name="MyTraceFile"/>
        <add name="MyConsole"/>
      </listeners>
    </source>
  </sources>
  <sharedListeners>
    <add
      name="MyTraceFile"
      type="System.Diagnostics.TextWriterTraceListener"
      initializeData="System.Net.trace.log" />
    <add name="MyConsole" type="System.Diagnostics.ConsoleTraceListener" />
  </sharedListeners>
  <switches>
    <add name="System.Net" value="Verbose" />
  </switches>
</system.diagnostics>

2
これは素晴らしい解決策です。調査と共有を行っていただきありがとうございます。
ピワフ2017

それはどのように機能しますか?下にコピー<system.diagnostics>app.configました<configuration>が、binフォルダーにはログファイルがなく、コンソール出力にも何も表示されません。何が欠けていますか?
Muflix

1
@Muflix、私の回答の上部に参照されているページにリンクされているドキュメントを読むことができます。initializeData属性で指定されたファイル名は、実行中の実行可能ファイルの現在の作業ディレクトリに作成されると思います。そのため、環境内のパスを確認する必要があります。
ラミA.

11

ネットワークトレースは、次のオブジェクトでも使用できます(msdnの記事を参照

  • System.Net.Sockets Socket、TcpListener、TcpClient、およびDnsクラスのいくつかのパブリックメソッド
  • System.Net HttpWebRequest、HttpWebResponse、FtpWebRequest、およびFtpWebResponseクラスのいくつかのパブリックメソッド、およびSSLデバッグ情報(無効な証明書、欠落している発行者リスト、およびクライアント証明書エラー)。
  • System.Net.HttpListener HttpListener、HttpListenerRequest、およびHttpListenerResponseクラスのいくつかのパブリックメソッド。
  • System.Net.Cache System.Net.Cacheの 一部のプライベートメソッドと内部メソッド。
  • System.Net.Http HttpClient、DelegatingHandler、HttpClientHandler、HttpMessageHandler、MessageProcessingHandler、およびWebRequestHandlerクラスのいくつかのパブリックメソッド。
  • System.Net.WebSockets.WebSocket ClientWebSocketクラスとWebSocketクラスのいくつかのパブリックメソッド。

次のコード行を構成ファイルに追加します

<configuration>  
  <system.diagnostics>  
    <sources>  
      <source name="System.Net" tracemode="includehex" maxdatasize="1024">  
        <listeners>  
          <add name="System.Net"/>  
        </listeners>  
      </source>  
      <source name="System.Net.Cache">  
        <listeners>  
          <add name="System.Net"/>  
        </listeners>  
      </source>  
      <source name="System.Net.Http">  
        <listeners>  
          <add name="System.Net"/>  
        </listeners>  
      </source>  
      <source name="System.Net.Sockets">  
        <listeners>  
          <add name="System.Net"/>  
        </listeners>  
      </source>  
      <source name="System.Net.WebSockets">  
        <listeners>  
          <add name="System.Net"/>  
        </listeners>  
      </source>  
    </sources>  
    <switches>  
      <add name="System.Net" value="Verbose"/>  
      <add name="System.Net.Cache" value="Verbose"/>  
      <add name="System.Net.Http" value="Verbose"/>  
      <add name="System.Net.Sockets" value="Verbose"/>  
      <add name="System.Net.WebSockets" value="Verbose"/>  
    </switches>  
    <sharedListeners>  
      <add name="System.Net"  
        type="System.Diagnostics.TextWriterTraceListener"  
        initializeData="network.log"  
      />  
    </sharedListeners>  
    <trace autoflush="true"/>  
  </system.diagnostics>  
</configuration>  

-14

最も簡単な解決策は、Wiresharkを使用してHTTP tcpフローをトレースすることです。


8
これらのタイプの接続のほとんどが実際にはHTTPSである世界を想像してみてください。
フレット
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.