nanoFramework.Logging 1.0.1-preview.6

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
This is a prerelease version of nanoFramework.Logging.
There is a newer version of this package available.
See the version list below for details.
dotnet add package nanoFramework.Logging --version 1.0.1-preview.6
NuGet\Install-Package nanoFramework.Logging -Version 1.0.1-preview.6
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="nanoFramework.Logging" Version="1.0.1-preview.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add nanoFramework.Logging --version 1.0.1-preview.6
#r "nuget: nanoFramework.Logging, 1.0.1-preview.6"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install nanoFramework.Logging as a Cake Addin
#addin nuget:?package=nanoFramework.Logging&version=1.0.1-preview.6&prerelease

// Install nanoFramework.Logging as a Cake Tool
#tool nuget:?package=nanoFramework.Logging&version=1.0.1-preview.6&prerelease

Quality Gate Status Reliability Rating License NuGet #yourfirstpr Discord

nanoFramework logo


Welcome to the .NET nanoFramework nanoFramework.Logging Library repository

Build status

Component Build Status NuGet Package
nanoFramework.Logging Build Status NuGet
nanoFramework.Logging (preview) Build Status NuGet
nanoFramework.Logging.Serial Build Status NuGet
nanoFramework.Logging.Serial (preview) Build Status NuGet
nanoFramework.Logging.Stream Build Status NuGet
nanoFramework.Logging.Stream (preview) Build Status NuGet

Feedback and documentation

For documentation, providing feedback, issues and finding out how to contribute please refer to the Home repo.

Join our Discord community here.

Credits

The list of contributors to this project can be found at CONTRIBUTORS.

License

The nanoFramework Class Libraries are licensed under the MIT license.

Usage

In your class, make sure you have a global ILogger declared and in your constructor that you call _logger = this.GetCurrentClassLogger();

using Microsoft.Extensions.Logging;
using nanoFramework.Logging;
using System;

namespace UnitTestDebugLogging
{
    internal class MyTestComponent
    {
        private ILogger _logger;

        public MyTestComponent()
        {
            _logger = this.GetCurrentClassLogger();
        }

        public void DoSomeLogging()
        {
            _logger.LogInformation("An informative message");
            _logger.LogError("An error situation");
            _logger.LogWarning(new Exception("Something is not supported"), "With exception context");
        }
    }
}

In your main code, you'll need to create a logger:

LogDispatcher.LoggerFactory = new DebugLoggerFactory();
// Then you can create your object and the logging will happen
MyTestComponent test = new MyTestComponent();
test.DoSomeLogging();

You can have 3 different types of logger: Debug, Serial and Stream.

Debug logger

As presented previously, you can use the Factory pattern:

LogDispatcher.LoggerFactory = new DebugLoggerFactory();
// Then you can create your object and the logging will happen
MyTestComponent test = new MyTestComponent();
test.DoSomeLogging();

You can as well directly create a DebugLogger:

DebugLogger _logger;
_logger = new DebugLogger("test");
_logger.MinLogLevel = LogLevel.Trace; 
_logger.LogTrace("This is a trace");

Serial logger

You can use the Factory pattern:

LogDispatcher.LoggerFactory = new SerialLoggerFactory("COM6");
// Then you can create your object and the logging will happen
MyTestComponent test = new MyTestComponent();
test.DoSomeLogging();

Note that you can adjust the baud speed and all other elements.

Or directly using a SerialLogger:

SerialPort _serial;
_serial = new SerialPort("COM6", 115200);
SerialLogger _logger = new SerialLogger(ref _serial);
_logger.MinLogLevel = LogLevel.Trace; 
_logger.LogTrace("This is a trace");

Important: make sure to refer to the documentation of your board to understand how to properly setup the serial port. The tests include an example with an ESP32.

Stream logger

Similar as for the others, you can either use a FileStream or a Stream in the LoggerFactory:

MemoryStream memoryStream = new MemoryStream();
LogDispatcher.LoggerFactory = new StreamLoggerFactory(memoryStream);
MyTestComponent test = new MyTestComponent();
test.DoSomeLogging();

And you can as well use it directly:

var _stream = new FileStream("D:\\mylog.txt", FileMode.Open, FileAccess.ReadWrite);
StreamLogger _logger = new StreamLogger(_stream);
_logger.MinLogLevel = LogLevel.Trace; 
_logger.LogTrace("This is a trace");

Important: please refer to the documentation for USB and SD Card reader to make sure they are properly setup before trying to setup the logger.

Create your own logger

You can create your own logger using the ILogger and ILoggerFactory interfaces. The DebugLogger is the simplest one.

The Log extensions

Different Log extensions are at your disposal to help you log the way you like. You can simply log a string or having parameters as well as exception and EventId:

_logger.LogTrace("TRACE {0} {1}", new object[] { "param 1", 42 });
_logger.LogDebug("DEBUG {0} {1}", new object[] { "param 1", 42 });
_logger.LogInformation("INFORMATION and nothing else");
_logger.LogWarning("WARNING {0} {1}", new object[] { "param 1", 42 });
_logger.LogError(new Exception("Big problem"), "ERROR {0} {1}", new object[] { "param 1", 42 });
_logger.LogCritical(42, new Exception("Insane problem"), "CRITICAL {0} {1}", new object[] { "param 1", 42 });

Note that all log level extensions have a minimum of string logging upo to EventId, string, parameters and exception. You are responsible to format properly the string when there are parameters.

Log level

You can adjust the log level in all the predefined logger. For example:

DebugLogger _logger;
_logger = new DebugLogger("test");
_logger.MinLogLevel = LogLevel.Trace;
_logger.LogTrace("This will be displayed");
_logger.LogCritical("Critical message will be displayed");
_logger.MinLogLevel = LogLevel.Critical;
_logger.LogTrace("This won't be displayed, only critical will be");
_logger.LogCritical("Critical message will be displayed");

Create your own formatting

You can use a custom formatter which will give you the name of the logger, the log level, the event ID, the message itself and a potential exception. The function definition should follow the following pattern:

public interface IMessageFormatter
{     
    string MessageFormatter(string className, LogLevel logLevel, EventId eventId, string state, Exception exception);
}

Important: this function will be called directly, without instantiating the class it is part of. So make sure either this function is a static, either it's part of the class using the logger. The static option always works. The interface is given for convenience and to give the format.

To setup the formatting, just use the following line. The type of the class containing the function and the exact name of the function are required.

LoggerExtensions.MessageFormatter = typeof(MyFormatter).GetType().GetMethod("MessageFormatterStatic");

public class MyFormatter
{        
    public string MessageFormatterStatic(string className, LogLevel logLevel, EventId eventId, string state, Exception exception)
    {
        string logstr = string.Empty;
        switch (logLevel)
        {
            case LogLevel.Trace:
                logstr = "TRACE: ";
                break;
            case LogLevel.Debug:
                logstr = "I love debug: ";
                break;
            case LogLevel.Warning:
                logstr = "WARNING: ";
                break;
            case LogLevel.Error:
                logstr = "ERROR: ";
                break;
            case LogLevel.Critical:
                logstr = "CRITICAL:";
                break;
            case LogLevel.None:
            case LogLevel.Information:
            default:
                break;
        }

        string eventstr = eventId.Id != 0 ? $" Event ID: {eventId}, " : string.Empty;
        string msg = $"[{className}] {eventstr}{logstr} {state}";
        if (exception != null)
        {
            msg += $" {exception}";
        }

        return msg;
    }
}

You are free to use anything you'd like and format as you like the message.

Note: It is not necessary to add a \r\n at the end, this is done by each logger.

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behaviour in our community. For more information see the .NET Foundation Code of Conduct.

.NET Foundation

This project is supported by the .NET Foundation.

Product Compatible and additional computed target framework versions.
.NET Framework net is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (14)

Showing the top 5 NuGet packages that depend on nanoFramework.Logging:

Package Downloads
nanoFramework.Logging.Stream The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package includes the nanoFramework.Logging.Stream assembly (Stream Logging only) for .NET nanoFramework C# projects. There is also a package with the Serial Logger only and another with the basic Debug Logger.

nanoFramework.Logging.Serial The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package includes the nanoFramework.Logging.Serial assembly (Serial Logging only) for .NET nanoFramework C# projects. There is also a package with the Stream Logging only and another with the basic Debug Logging.

nanoFramework.Iot.Device.Mfrc522 The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package includes the .NET IoT Core binding Iot.Device.Mfrc522 for .NET nanoFramework C# projects.

nanoFramework.Iot.Device.Pn532 The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package includes the .NET IoT Core binding Iot.Device.Pn532 for .NET nanoFramework C# projects.

nanoFramework.Iot.Device.Pn5180 The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package includes the .NET IoT Core binding Iot.Device.Pn5180 for .NET nanoFramework C# projects.

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on nanoFramework.Logging:

Repository Stars
nanoframework/Samples
🍬 Code samples from the nanoFramework team used in testing, proof of concepts and other explorational endeavours
nanoframework/nanoFramework.IoT.Device
📦 This repo includes .NET nanoFramework implementations for various sensors, chips, displays, hats and drivers
Version Downloads Last updated
1.1.81 1,903 2/1/2024
1.1.79 798 1/26/2024
1.1.76 4,718 11/16/2023
1.1.74 1,975 11/10/2023
1.1.63 15,600 1/4/2023
1.1.60 1,730 12/28/2022
1.1.58 952 12/28/2022
1.1.47 3,894 10/28/2022
1.1.45 1,371 10/26/2022
1.1.43 1,074 10/26/2022
1.1.41 2,220 10/25/2022
1.1.39 1,105 10/25/2022
1.1.37 1,397 10/24/2022
1.1.35 1,149 10/24/2022
1.1.33 1,182 10/24/2022
1.1.31 1,405 10/23/2022
1.1.29 1,140 10/23/2022
1.1.27 1,933 10/22/2022
1.1.25 3,303 10/10/2022
1.1.23 2,553 10/7/2022
1.1.19 2,649 9/22/2022
1.1.17 2,273 9/16/2022
1.1.15 1,245 9/15/2022
1.1.13 1,257 9/15/2022
1.1.9 1,291 9/15/2022
1.1.7 1,252 9/15/2022
1.1.2 5,303 8/5/2022
1.0.1.29 6,249 6/17/2022
1.0.1.27 2,089 6/16/2022
1.0.1.25 2,056 6/14/2022
1.0.1.23 2,019 6/13/2022
1.0.1.21 1,254 6/9/2022
1.0.1.19 1,276 6/8/2022
1.0.1.15 2,234 5/27/2022
1.0.1.13 2,686 5/19/2022
1.0.1.12 2,153 5/4/2022
1.0.1 5,625 3/28/2022
1.0.1-preview.32 122 3/28/2022
1.0.1-preview.31 116 3/28/2022
1.0.1-preview.30 118 3/28/2022
1.0.1-preview.28 193 3/18/2022
1.0.1-preview.27 124 3/17/2022
1.0.1-preview.26 132 3/15/2022
1.0.1-preview.25 137 3/14/2022
1.0.1-preview.24 136 3/11/2022
1.0.1-preview.23 196 2/25/2022
1.0.1-preview.21 196 2/17/2022
1.0.1-preview.19 156 2/11/2022
1.0.1-preview.18 147 2/8/2022
1.0.1-preview.17 153 2/4/2022
1.0.1-preview.16 175 1/28/2022
1.0.1-preview.15 152 1/28/2022
1.0.1-preview.14 165 1/28/2022
1.0.1-preview.13 159 1/27/2022
1.0.1-preview.12 133 1/26/2022
1.0.1-preview.11 132 1/25/2022
1.0.1-preview.10 148 1/25/2022
1.0.1-preview.9 153 1/21/2022
1.0.1-preview.8 136 1/21/2022
1.0.1-preview.6 179 1/14/2022
1.0.1-preview.4 196 1/4/2022
1.0.1-preview.3 138 12/29/2021
1.0.0 1,520 12/5/2021
1.0.0-preview.142 152 12/5/2021
1.0.0-preview.141 148 12/5/2021
1.0.0-preview.137 281 10/19/2021
1.0.0-preview.135 196 10/18/2021
1.0.0-preview.133 347 10/15/2021
1.0.0-preview.131 290 9/30/2021
1.0.0-preview.129 186 9/27/2021
1.0.0-preview.127 259 9/26/2021
1.0.0-preview.122 903 7/18/2021
1.0.0-preview.120 245 7/17/2021
1.0.0-preview.118 554 7/16/2021
1.0.0-preview.116 170 7/15/2021
1.0.0-preview.114 195 7/14/2021
1.0.0-preview.110 252 6/29/2021
1.0.0-preview.108 257 6/27/2021
1.0.0-preview.106 166 6/21/2021
1.0.0-preview.104 188 6/20/2021
1.0.0-preview.102 142 6/19/2021
1.0.0-preview.100 153 6/19/2021
1.0.0-preview.98 208 6/9/2021
1.0.0-preview.96 171 6/8/2021
1.0.0-preview.94 161 6/7/2021
1.0.0-preview.92 190 6/7/2021
1.0.0-preview.90 169 6/6/2021
1.0.0-preview.88 260 6/5/2021
1.0.0-preview.86 158 6/4/2021
1.0.0-preview.84 142 6/3/2021
1.0.0-preview.82 181 6/3/2021
1.0.0-preview.80 156 6/2/2021
1.0.0-preview.78 186 6/1/2021
1.0.0-preview.76 185 5/31/2021
1.0.0-preview.74 191 5/31/2021
1.0.0-preview.72 188 5/31/2021
1.0.0-preview.70 221 5/30/2021
1.0.0-preview.68 186 5/30/2021
1.0.0-preview.66 154 5/29/2021
1.0.0-preview.64 157 5/27/2021
1.0.0-preview.62 165 5/26/2021
1.0.0-preview.60 303 5/25/2021
1.0.0-preview.58 285 5/23/2021
1.0.0-preview.56 178 5/22/2021
1.0.0-preview.54 211 5/21/2021
1.0.0-preview.52 220 5/20/2021
1.0.0-preview.50 154 5/19/2021
1.0.0-preview.48 182 5/19/2021
1.0.0-preview.46 272 5/16/2021
1.0.0-preview.44 163 5/15/2021
1.0.0-preview.42 160 5/14/2021
1.0.0-preview.40 169 5/13/2021
1.0.0-preview.38 152 5/12/2021
1.0.0-preview.36 217 5/7/2021
1.0.0-preview.34 214 5/6/2021
1.0.0-preview.32 157 5/5/2021
1.0.0-preview.30 163 5/4/2021
1.0.0-preview.28 156 5/4/2021
1.0.0-preview.26 174 4/23/2021
1.0.0-preview.25 161 4/12/2021
1.0.0-preview.24 171 4/10/2021
1.0.0-preview.21 670 4/9/2021
1.0.0-preview.19 170 4/9/2021
1.0.0-preview.17 182 4/8/2021
1.0.0-preview.14 179 4/8/2021
1.0.0-preview.13 182 4/8/2021