Joutsen Logging

Joutsen Logging is a simple framework for the DotNet Core framework that allows to create log output in different formats. It is modular and extensible. Loggers can easily be configured in Json or XML files and used to write to different targets. At the same time it is possible to restrict the output through filters and create different output formats. If desired the scope of a log entry (e.g. a class) can also be considered.

Installation

Simply download the latest assemblies and add them to your project or build them yourself by cloning the repository and build the solution using the dotnet build command.

Example

In order to use the logger in your project simply create a logger instance and add the desired filter and handlers like this:

Logger logger = new DefaultLogger
{
  Filter = new LogLevelFilter(LogLevel.Detailed);
};
logger.AddHandler(new ConsoleHandler(new SimpleFormatter("{SourceClassName}.{SourceMethodName} {Message}")));
Stream fileStream = new FileStream("path/to/logfile");
logger.AddHandler(new StreamHandler(fileStream, new XmlFormatter(), Encoding.UTF8));

Another way to create a logger is by creating a config file that defines the logger, filter, handlers and formatters like this:

{
    "joutsen.logging": {
        "loggers": [{
            "type": "Joutsen.Logging.DefaultLogger, Joutsen.Logging",
            "filter": {
                "type": "logLevel",
                "logLevel": "Info"
            },
            "handlers": [{
                "type": "console",
                "format": {
                    "type": "simple",
                    "outputFormat": "{SourceClassName}.{SourceMethodName} {Message}"
                }               
            }, {
                "type": "file",
                "encoding": "utf-8",
                "filename": "path/to/logfile",
                "format": {
                    "type": "xml"
                }
            }]
        }]
    }
}

The easiest way to retrive the logger from the config file is then to use the Dependency Injection Framework:

IHost host = Host.CreateDefaultBuilder(args)
                 .ConfigureServices(services => { services.AddJoutsenLogging(); })
                 .Build();
Logger logger = host.Services.GetService<Logger>();

Once the logger is created call the methods on the instance to create entries.

logger.Info("Log entry message");

For a type scoped logger it is also possible to use generics to get the scoped logger.

Logger<ExampleType> logger = host.Services.GetService<Logger<ExampleType>>();

See the API documentation for further details.

Documentation

Development documentation can be found here.

API documentation in HTML is available here.

Tests

Tests can be run using NUnit by using the projects in the test folder. For unit test simply run

dotnet test

Build and tests are also automatically run on the Jenkins CI server at https://ci.norsecorby.de/.