Spa.Cbcrc.Logging 1.4.1

Spa.Cbcrc.Logging

Spa.Cbcrc.Logging is the official package of the Software and Platform Architecture team's logging solution for Merlin Template driven applications. The package leverages the Serilog library and supports logging to Files as well as to Azure Log Analytics.

Table of Contents

• Spa.Cbcrc.Logging
  • Table of Contents
  • Installation
  • Usage
    • Configuration
      • appSettings.json
      • App.config or Web.config
      • Configuration Parameters
    • Spa.Cbcrc.Logging classes and interfaces
    • Registering the Spa.Cbcrc.Logging Service for dependency injection
      • .Net 6 and .Net Core
      • .Net 4.8
    • Instantiating the CbcrcLogger class
      • .Net 6
      • .Net Core
      • .Net 4.8
    • Registering the service as ILogger
      • .Net 6
      • .Net 4.8
    • Using the Logging Service
    • Sample Code
  • Contributing
  • License

Installation

Chose one of the following way to install the package:

• Use Visual Studio's Package Manager Console and search for Spa.Cbcrc.Logging

• Navigate to your project's directory and use the following command:

dotnet add package Spa.Cbcrc.Logging

Usage

Spa.Cbcrc.Logging leverages Dependency Injection to provide the logging methods to your own controllers or services. The service needs to be registered in the Program.cs of all of your relevant projects in order to be injected in the constructor or your classes.

The Spa.Cbcrc.Logging CbcrcLogger class can also be instantiated by passing the configuration settings as constructor parameters for use cases where Dependency Injection would be impractical, for example, for Console Application like Windows Services.

In order to configure Spa.Cbcrc.Logging correctly, the proper configuration has to be entered in the project's appSettings.json, App.Config or Web.Config file.

The Serilog Debug Sink is now enabled automatically.

Configuration

appSettings.json

{   
    "ApplicationId": "[Application Name]",
    "Serilog": {
    "MinimumLevel": {
      "Default": "Warning",
      "Override": {
        "Microsoft": "Error",
        "System": "Error"
      }
    },
    "FileSink": {
      "OutputTemplate": "{Timestamp} [{Level}] V{Release} (#{ProcessId}-{ThreadId}) {Message}{NewLine}{Exception}",
      "Path": "c:\\Logs\\[Application Name]\\log-api-.txt",
      "RollingInterval": "Day",
      "RetainedFileCountLimit": 14,
      "MinimumLevel": "Information"
    },
    "AzureLogAnalytics": {
      "MinimumLevel": "Information",
      "WorkspaceId": "d953bda0-1a70-4c32-a98e-9434bd6d8b78",
      "PrimaryKey": "@---ReplaceInCICD-AzureLogAnalyticsKey---@"
    }
    "ConsoleSink": false
  },
}

App.config or Web.config

<add key="ApplicationId" value="[Application Name]" />
<add key="Serilog:MinimumLevel:Default" value="Information" />
<add key="Serilog:MinimumLevel:Override:Microsoft" value="Error" />
<add key="Serilog:MinimumLevel:Override:Error" value="Error" />
<add key="Serilog:FileSink:OutputTemplate" value="{Timestamp} [{Level}] V{Release} (#{ProcessId}-{ThreadId}) {Message}{NewLine}{Exception}" />
<add key="Serilog:FileSink:Path" value="c:\\Logs\\[Application Name]\\log-api-.txt" />
<add key="Serilog:FileSink:RollingInterval" value="Day" />
<add key="Serilog:FileSink:RetainedFileCountLimit" value="14" />
<add key="Serilog:FileSink:MinimumLevel" value="Information" />
<add key="Serilog:AzureLogAnalytics:MinimumLevel" value="Information" />
<add key="Serilog:AzureLogAnalytics:WorkspaceId" value="d953bda0-1a70-4c32-a98e-9434bd6d8b78" />
<add key="Serilog:AzureLogAnalytics:PrimaryKey" value="@---ReplaceInCICD-AzureLogAnalyticsKey---@" />
<add key="Serilog:ConsoleSink" value="false" />

Configuration Parameters

Spa.Cbcrc.Logging classes and interfaces

• Spa.Cbcrc.Logging.ICbcrcLogger <br/> Interface used to define the type of the injected Logging service.

• Spa.Cbcrc.Logging.Settings.SerilogOptions <br/> This class defines the AppSetting properties and is used to construct an Options pattern settings class for your project. Needs to be used to bind to IConfigurationBuilder in the case of console application.

Registering the Spa.Cbcrc.Logging Service for dependency injection

.Net 6 and .Net Core

For projects that use WebApplicationBuilder, like Web APIs and Web Applications, simply register the service in the Program.cs class (or Startup.cs for .Net Core). Note that it is also possible to use dependency injection for Console Applications (Windows Services): https://learn.microsoft.com/en-us/dotnet/core/extensions/dependency-injection-usage

Program.cs

builder.Services.AddCbcrcLogger();

.Net 4.8

For Full Framework projects, you may use a dependency injection library like Ninject, Simple Injector or Autofac to register and inject the Logging service. Please note that you will have to provide the NameValueCollection object from ConfigurationManager to the CbcrcLogger class constructor.

Registering the Logging service with Ninject

private static void RegisterServices(IKernel kernel)
{
  // The ConfigurationManager.AppSettings property provides a NameValueCollection object
  var appSettings = ConfigurationManager.AppSettings;
  kernel.Bind<ICbcrcLogger>().ToConstructor(arg => new CbcrcLogger(appSettings));
}   

Instantiating the CbcrcLogger class

For certain Console Application projects, like Windows Services, where dependency injection may prove impractical, you can instantiate a CbcrcLogger class in order to pass it down child classes as a parameter. A configuration settings object will need to be passed to the class constructor.

.Net 6

A IConfigurationRoot object must be instantiated. Then, using this object, instantiate the CbcrcLogger class in the Program.cs class.

Program.cs

// Instantiate appSettings object for configuration
IConfigurationRoot configuration = builder.Configuration;

//Configure Serilog
_logger = new CbcrcLogger(configuration);

.Net Core

A IConfigurationRoot object must be instantiated. Then, using this object, instantiate the CbcrcLogger class in the Startup.cs class (or Startup.cs for .Net Core).

Startup.cs

// Instantiate appSettings object for configuration
IConfigurationRoot configuration = new ConfigurationBuilder().Build()

//Configure Serilog
_logger = new CbcrcLogger(configuration);

.Net 4.8

For .Net 4.8 projects, a NameValueCollection object must be instantiated from the ConfigurationManager class. Then, using this object, instantiate the CbcrcLogger class in the Program.cs class (or Startup.cs for .Net Core).

Startup.cs

// The ConfigurationManager.AppSettings property provides a NameValueCollection object
NameValueCollection appSettings = ConfigurationManager.AppSettings;

_cbcrcLogger = new CbcrcLogger(appSettings);

Registering the service as ILogger

If you need to register the Logging service as a custom ILogger provider, use the following instructions.

.Net 6

In the Program.cs class, the UseCbcrcLogger() extension can be used with the host builder.

Program.cs

var builder = WebApplication.CreateBuilder(args);
IConfigurationRoot configuration = builder.Configuration;
builder.Host.UseCbcrcLogger(configuration);
var app = builder.Build();

.Net 4.8

In the Startup.cs class, use the UseCbcrcLogger() static method with the LoggerFactory() class.

Startup.cs

var loggerFactory = new LoggerFactory();
var appSettings = ConfigurationManager.AppSettings;
Registration.UseCbcrcLogger(loggerFactory,appSettings);

var logger = loggerFactory.CreateLogger<Startup>();

Using the Logging Service

Simply declare an ICbcrcLogger variable in your class and assign the injected services from the class constructor to the variable like so:

public class MyController : ApiBaseController
{
    private readonly ICbcrcLogger _logger;

    public MyController(ICbcrcLogger logger)
    {
        _logger = logger;
    }
}

Please note that for Console Application like Windows services, the Logging service can be passed as a parameter to the different classes that require it.

_logger = new CbcrcLogger(configuration);

new Worker(serviceInterval, serviceName, _logger);

The ICbcrcLogger service can then be used with it's different methods that refer to all of the available logging levels. For example:

try
{
  // Your code here...
}
catch(Exception ex)
{
    _logger.Error("MyController", ex);
}

Here are the available logging methods. Note that the non mandatory "assemblyName" parameter is used to enable or disable concatenating the project name to the Scope property of the log events. Ex: [Service], [Api]

public interface ICbcrcLogger
{
    void Debug(string scope, string msg, string email = "", bool assemblyName = true);

    void Verbose(string scope, string msg, string email = "", bool assemblyName = true);

    void Info(string scope, string msg, string email = "", bool assemblyName = true);

    void Warning(string scope, string msg, string email = "", bool assemblyName = true);

    void Error(string scope, Exception ex, string email = "", bool assemblyName = true);

    void Fatal(string subFilter, Exception ex, string email = "", bool assemblyName = true);
}

As a last resort, the MyLog static class can be used as well.

using Spa.Cbcrc.Logging.Static;

try
{
  // Your code here...
}
catch(Exception ex)
{
    MyLog.Error("MyController", ex);
}

Sample Code

The Merlin Template repository integrates the Spa.Cbcrc.Logging package. <br/> it-apps-merlin-template

Contributing

Pull requests are welcome. For major changes, please contact the SPA team to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT