Skip to main content

A Demo On Request Logging Using MediatR IPipelineBehavior In Asp.Net Core Application


Click here for step by step implementation of the CQRS MediatR design pattern.

In this article, we are going to do request logging into an Asp.Net application Core application build on the CQRS MediatR design pattern. The application request logging helps to track the time taken per request. The MediatR provides a pipeline interface that is 'IPipelineBehavior' that helps to implement our logging logic.

IPipelineBehavior:

The 'IPipelineBehavior' exactly works like Asp.Net Core middleware, but its starting execution and ending execution happens within the 'IMediator'. So the 'IMediator.send()' is usually used to invoke the 'Query' or 'Command' handlers. So if we implement 'IPipelineBehavior' then begin logic inside of its start executes then invokes 'Query' or 'Command' handlers, later again go through 'IPipelineBehavior' and executes the end logic.

Create A .Net5 Web API Sample Application:

In this demo our main focus on MediatR IPipelineBehavior implementation. Let's create a sample .Net5 Web API application to accomplish our demo.

Install MediatR Package:

Package Manager Command:
Install-Package MediatR -Version 9.0.0

.Net CLI
dotnet add package MediatR --version 9.0.0

Package Manager Command:
Install-Package MediatR.Extensions.Microsoft.DependencyInjection -Version 9.0.0

.Net CLI
dotnet add package MediatR.Extensions.Microsoft.DependencyInjection --version 9.0.0

Register MediatR Service:

In 'Startup.cs' register the MediatR service, which helps to inject the 'IMediator' interface into the API controller.
Startup.cs:
services.AddMediatR(Assembly.GetExecutingAssembly());

Implement IPipelineBehavior For Request Logging:

Now let's implement our request logging by implementing the 'IPipelineBehavior'. So lets create a folder like 'Pipelines' and a file like 'AppLoggingBehavior.cs'.
Pipelines/AppLoggingBehavior.cs:
using MediatR;
using Microsoft.Extensions.Logging;
using System;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;

namespace CQRSSimpleRequestLog.Learn.Pipelines
{
    public class AppLoggingBehaviour<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
    {
        private readonly ILogger<AppLoggingBehaviour<TRequest, TResponse>> _logger;
        public AppLoggingBehaviour(ILogger<AppLoggingBehaviour<TRequest, TResponse>> logger)
        {
            _logger = logger;
        }
        public async Task<TResponse> Handle(TRequest request, CancellationToken cancellationToken, RequestHandlerDelegate<TResponse> next)
        {
            string requestName = typeof(TRequest).Name;
            string unqiueId = Guid.NewGuid().ToString();
            _logger.LogInformation($"Begin Request Id:{unqiueId}, request name:{requestName}");
            var timer = new Stopwatch();
            timer.Start();
            var response = await next();
            timer.Stop();
            _logger.LogInformation($"Begin Request Id:{unqiueId}, request name:{requestName}, total request time:{timer.ElapsedMilliseconds}");
            return response;
        }
    }
}
  • (Line: 10) Implementing the 'IPipelineBehavior<TRequest, TResponse>'.
  • (Line: 12-16) Injecting the 'ILogger' interface, using this we can either log to 'console', 'file', and 'database'. For this demo, we will target the 'console' log.
  • (Line: 17) The 'Handle' method of 'IPipelineBehvior' will executes automatically.
  • (Line: 19) Name of the request model.
  • (Line: 20) Creating a unique id to determine the starting log and ending log.
  • (Line: 21) Initial log information for our request.
  • (Line: 22-23) Initialized 'StopWatch' instance.
  • (Line: 24) Here awaiting 'RequestHandlerDelegate<TResponse>', so from here code execution either shift to 'IPipelineBehavior' if other exist or shift to the 'Handler'(like Query or Command).
  • (Line: 25) This line of code executes after completion of the 'Handler' execution which means now code executes in the backward direction.
  • (LIne: 26) Finally logging the end request and its time taken into the console.
Now register our 'AppLoggingBehavior' in the 'Startup.cs'
Startup.cs:
services.AddTransient(typeof(IPipelineBehavior<,>), typeof(AppLoggingBehaviour<,>))

Create A Test Endpoint:

Now let's implement an endpoint using the CQRS MediatR pattern to determine how our IPipelineBehavior works. In this demo I briefly show the CQRS MediatR pattern, please click here for step by step implementation of CQRS MediatR

Let's create a response model like 'ProductResponseModel.cs' in the 'ResponseModels' folder.
ResponseModels/ProductResponseModel.cs:
namespace CQRSSimpleRequestLog.Learn.ResponseModels
{
    public class ProductResponseModel
    {
        public int Id { get; set; }
        public string Name { get; set; }
        public decimal Price { get; set; }
    }
}
Let's create a request model like 'GetProductRequestModel' in the 'RequestModels' folder.
RequestModels/GetProductRequestModel.cs:
using CQRSSimpleRequestLog.Learn.ResponseModels;
using MediatR;

namespace CQRSSimpleRequestLog.Learn.RequestModels
{
    public class GetProductRequestModel : IRequest<ProductResponseModel>
    {

    }
}
Now add our query handler file like 'GetProductQueryHandler.cs' in the 'Handlers/Query' folder
Handlers/Query/GetProductQueryHandler.cs:
using CQRSSimpleRequestLog.Learn.RequestModels;
using CQRSSimpleRequestLog.Learn.ResponseModels;
using MediatR;
using System.Threading;
using System.Threading.Tasks;

namespace CQRSSimpleRequestLog.Learn.Handlers
{
    public class GetProductQueryHandler : IRequestHandler<GetProductRequestModel, ProductResponseModel>
    {
        public async Task<ProductResponseModel> Handle(GetProductRequestModel request, CancellationToken cancellationToken)
        {
            await Task.FromResult(0);
            return new ProductResponseModel
            {
                Id = 1,
                Name = "Remote Car",
                Price = 200
            };
        }
    }
}
Let's add an action method to invoke our query handler as below.
Controllers/ProductController.cs:
using CQRSSimpleRequestLog.Learn.RequestModels;
using MediatR;
using Microsoft.AspNetCore.Mvc;
using System.Threading.Tasks;

namespace CQRSSimpleRequestLog.Learn.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class ProductController : ControllerBase
    {
        private readonly IMediator _mediator;
        public ProductController(IMediator mediator)
        {
            _mediator = mediator;
        }

        [HttpGet]
        [Route("get")]
        public async Task<IActionResult> GetProducts()
        {
            var result = await _mediator.Send(new GetProductRequestModel());
            return Ok(result);
        }
    }
}
  • (Line: 22) The '_mediator.Send()' method entry point of the mediator. Here it first executes all the 'IPipelineBehavior' implementations request logic and then executes the 'Handlers' and then again executes all the 'IPipelineBehvior' implementation response logic.
Now run the application and access the endpoint then we can observe the request log in the console as below.

Video Session:

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on the MediatR IPipelineBehavior implementation in Asp.Net Core. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

Popular posts from this blog

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http

GraphQL API Integration In Asp.Net Core Application

Introduction: GraphQL is a query language for your API and a server-side runtime for executing queries by using a type system you define for your data. GraphQL can be integrated into any framework like ASP.NET, Java, NestJs, etc and it isn't tied to any specific database or storage engine and is instead backed by your existing code and data. How GraphQL API Different From Rest API: GraphQL exposes a single end-point or route for the entire application, regardless of its responses or actions. HTTP-POST is the only Http verb recommended by the GraphQL. The client applications (consumers of API) can give instructions to GraphQL API about what type of properties to be returned in the response. Building Blocks Of GraphQL API: The main building blocks of GraphQL API is Schemas and Types.  A 'Schema' in GrpahQL API describes the functionality available to the clients connect to API. Schema mostly consists of GraphQL Object Types, Queries, Mutations, etc. T