Logging with OnRequestCompleted

When constructing the connection settings to pass to the client, you can pass a callback of type Action to the OnRequestCompleted method that can eavesdrop every time a response(good or bad) is received.

If you have complex logging needs this is a good place to add that in since you have access to both the request and response details.

In this example, we’ll use OnRequestCompleted on connection settings to increment a counter each time it’s called.

		var counter = 0;
var client = new ElasticClient(new AlwaysInMemoryConnectionSettings().OnRequestCompleted(r => counter++));

client.RootNodeInfo();
counter.Should().Be(1);

await client.RootNodeInfoAsync();
counter.Should().Be(2);

	

Construct a client
Make a synchronous call and assert the counter is incremented
Make an asynchronous call and assert the counter is incremented

OnRequestCompleted is called even when an exception is thrown, so it can be used even if the client is configured to throw exceptions

		var counter = 0;
var client = FixedResponseClient.Create(
    new { },
    500,
    connectionSettings => connectionSettings
        .ThrowExceptions()
        .OnRequestCompleted(r => counter++)
);

Assert.Throws(() => client.RootNodeInfo());
counter.Should().Be(1);

await Assert.ThrowsAsync(async () => await client.RootNodeInfoAsync());
counter.Should().Be(2);

	

Configure a client with a connection that **always returns a HTTP 500 response
Always throw exceptions when a call results in an exception
Assert an exception is thrown and the counter is incremented

Here’s an example using OnRequestCompleted() for more complex logging

Note

By default, the client writes directly to the request stream and deserializes directly from the response stream.

If you would also like to capture the request and/or response bytes, you also need to set .DisableDirectStreaming() to true.

var list = new List();
var connectionPool = new SingleNodeConnectionPool(new Uri("http://localhost:9200"));

var settings = new ConnectionSettings(connectionPool, new InMemoryConnection())
    .DefaultIndex("default-index")
    .DisableDirectStreaming()
    .OnRequestCompleted(apiCallDetails =>
    {
        // log out the request and the request body, if one exists for the type of request
        if (apiCallDetails.RequestBodyInBytes != null)
        {
            list.Add(
                $"{apiCallDetails.HttpMethod} {apiCallDetails.Uri} " +
                $"{Encoding.UTF8.GetString(apiCallDetails.RequestBodyInBytes)}");
        }
        else
        {
            list.Add($"{apiCallDetails.HttpMethod} {apiCallDetails.Uri}");
        }

        // log out the response and the response body, if one exists for the type of response
        if (apiCallDetails.ResponseBodyInBytes != null)
        {
            list.Add($"Status: {apiCallDetails.HttpStatusCode}" +
                     $"{Encoding.UTF8.GetString(apiCallDetails.ResponseBodyInBytes)}");
        }
        else
        {
            list.Add($"Status: {apiCallDetails.HttpStatusCode}");
        }
    });

var client = new ElasticClient(settings);

var syncResponse = client.Search