Chd.Library.Logging 10.2.1

Logging library for .Net Core

Chd (cleverly handle difficulty) library helps you cleverly handle difficulty, writing code fastly and do your application stable.

📝 Table of Contents

• About
• Getting Started
• Bug Fixes For Previous Versions
• Prerequisites
• Injection Logger Into The Project For Logging
• Usage
• Apsettings Configurations
• Test Result
• Authors
• Acknowledgments

🧐 About

Logging is an important feature that finding the cause of problem. This package is very simple to use with aspect oriented programming. This library is sink graylog server. You can see logs on graylog run simple step below.

This library use compile time aspects

🏁 Getting Started

We use "Logged" attribute for logging method.

🛠️ Prerequisites

• you must write
• .NET 10 SDK (recommended) or higher
• You must execute "NuGet\Install-Package MethodBoundaryAspect.Fody -Version 2.0.150" command on Package Manager Console
• Having graylog server connection information

Bug Fixes For Previous Versions

This is version 8.6.2 is fixed some bugs. Async methods are now supported with powerful compile-time aspects. This is a major update that improves the stability and performance of the logging library. This asspect is very hight performans from runtime aspects. The performance value than runtime aspects is approximately 300% higher.

💉 Injection Logger Into The Project For Logging

Firstly you must call UseLogger method ("app.UseLogger();") in the program.cs file.

var builder = WebApplication.CreateBuilder(args);
   ....
   ....
   app.UseLogger();

🎈 Usage

You must use Logged attribute on method whice you want to loggging method. Do not forget adding graylog configuration in appsettings.json file. That's it, now you can see the logs of the methods in graylog by using the "logged" attribute in any class you want. You can also see the logs in the directory you specified in the appsettings.json file.

public class LoggingTestController : ControllerBase
    {
        public LoggingTestController()
        {

        }

        [Logged] //For logging method with parameters and return value.
        [Route("Sum")]
        [HttpGet]
        public int? Sum(int a,int b) //For testing on swagger or etc..
        {
            return a + b;
        }

        [Route("Sum")]
        [HttpGet]
        public int? Multiply(int a,int b) //For testing on swagger or etc..
        {
            Logger.LogInformation("Some information messages..."); //For manuel logging 
            return a * b;
        }
    }

Logging the "Sum" method includes compile-time aspects. Compile-time aspects are faster than run-time aspects because they are woven into the code during the build process, reducing the overhead during execution.

⚙️ Apsettings Configurations

You must add code below in appsettings.json if you want to see lines numbers and file names in the logs, only you must add below PropertyGroup in your project file (.csproj).

	<PropertyGroup>
		<DebugType>portable</DebugType>
		<DebugSymbols>true</DebugSymbols>
		<IncludeSymbols>true</IncludeSymbols>
	</PropertyGroup>

you must add below configuration in appsettings.json file.

"LogConfig": {
    "ApplicationName": "Your_Application_Name",
    "Sink": "MSSql",//You can use "Graylog" or "MSSql" or "File"
    "SinkDBConnectionString": "db connection string",//If you use "MSSql" sink, you must enter your database connection string.
    "SinkTableName": "ApplicationLogs"
    "Server": "localhost", // if you use "Graylog" sink, you must enter your graylog server address.
    "Port": "3003", //if you use "Graylog" sink, you must enter your graylog server port.
    "Path": "C:\\Logs\\Your_Application_Name\\log.txt", // 
    "PathFormat": "C:\\Logs\\Your_Application_Name\\log-{Date}.txt"
  },

📑 Test Result

Test result is shown on graylog UI. You can see running method name and included class name with method parameters value. Enter 4 and 7 values in Sum method using swagger. Then look at the greaylog UI. You should see below logs.

• The LoggingTestController.Sum method started working with "[4,7]" parameters.
• The LoggingTestController.Sum method successfully completed its work by returning the result of 11 with the "[4,7]" input parameters. If user logged in the application, you can see who user used the application. If method crashed you can see why the method crashed. Sometime method crashed for some invalid parameters. You can calculate error reason.
• Graylog UI screen shot for this log

⛏️ Built Using

• Graylog - Graylog server

✍️ Authors

• Mehmet Yoldaş - Linkedin

See also the list of contributors who participated in this project.

🎉 Acknowledgements

Thank you for using my library.