CtxLog.Abstractions 0.1.0

CtxLog.Abstractions

Logging is more useful when you apply structured logging. Structured logging means that every log event adds custom properties depending on de context of the application or component. To make sure you use the same properties everytime, type-safe context objects give control over this.

Log Context

A Log Context is a situation where certain properties in the logging are expected. For instance, when you are in an order system, you may want to log what the status is of the order, the order number, numbers of items in the order and a client reference id. These are properties you may want to log.

Using this libary, you can create an object using these properties. By adding methods for the builder pattern, this library helps you to easily create a log context in the order handling component.

E.g.:

public class OrderLogContext : LogContext
    {
        public OrderLogContext()
        { }

        public string OrderStatus { get; set; }
        public int OrderNumber { get; set; }
        public int OrderLines { get; set; }
        public string ClientReference { get; set; }
        public override string ContextPrefix { get; protected set; } = "OrderInfo";

        protected override void AddPropertiesToContext()
        {
            base.AddPropertiesToContext();
            AddStringProperty(nameof(OrderStatus), OrderStatus);
            AddProperty(nameof(OrderNumber), OrderNumber);
            AddProperty(nameof(OrderLines), OrderLines);
            AddStringProperty(nameof(ClientReference), ClientReference);
        }
    }

Using this log context would be like this:

// You can also build up the context along the method
var ctx = LogContext.BuildLogContext<OrderLogContext>()
             .WithOrderNumber(2200152)
             .WithOrderLines(3)
             .WithStatus("InCart")
             .WithClientRef("C22XAGSF")
             .Context;
         using (logger.BeginScope(ctx) 
         {
             logger.LogInformation("Sending user to payment page");
         }