Ara3D.Logging 1.4.5

Suggested Alternatives

Ara3D.SDK

Additional Details

The project has been merged into Ara3D.SDK.

The owner has unlisted this package. This could mean that the package is deprecated, has security vulnerabilities or shouldn't be used anymore.
dotnet add package Ara3D.Logging --version 1.4.5
                    
NuGet\Install-Package Ara3D.Logging -Version 1.4.5
                    
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="Ara3D.Logging" Version="1.4.5" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Ara3D.Logging" Version="1.4.5" />
                    
Directory.Packages.props
<PackageReference Include="Ara3D.Logging" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Ara3D.Logging --version 1.4.5
                    
#r "nuget: Ara3D.Logging, 1.4.5"
                    
#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.
#:package Ara3D.Logging@1.4.5
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Ara3D.Logging&version=1.4.5
                    
Install as a Cake Addin
#tool nuget:?package=Ara3D.Logging&version=1.4.5
                    
Install as a Cake Tool

Ara3D.Logging

NuGet Version

Ara3D.Logging is a very simple cross-platform library for logging and reporting. It was designed particularly for desktop application.

How to use it

  1. Create a logger providing a custom or default log writer
  2. Call log on it.

Enjoy having more insights into what your code is doing and how long it takes.

How to Implement a Log Writer

A log writer is any class that implements the ILogWriter interface:

    public interface ILogWriter 
    {
        void Write(LogEntry logEntry);
    }

A generic log writer class (LogWriter) is provided that can be customized via an action passed to the constructor.

A default static instance which writes to the console and the debug log.

    public class LogWriter 
    {
        public LogWriter(Action<TimeSpan, LogEntry> onLogEntry);
        public static ILogWriter Create(Action<string> onLogMessage);
        public static ILogWriter Default;
    }

Why no Global Static Logger?

You may find yourself looking for a static "Log" function that you can call, or are tempted to write one yourself.

Resist the urge!*

Well-structured software does not use global mutable state.

Your code will be easier to reuse and refactor it you explicitly pass an ILogger to every component that might want to use it.

If you find that you are passing too many values to each component, consider using an IJob which bundles many commonly related concerns together.

More than just Logging

When we start introducing logging into an application other related concerns tend to creep in, like progress reporting, and cancelation.

Ara3D.Logging introduces a special interface called IJob which combines these concerns.

Job Management

A job is like a high-level task that has a name, can be canceled, provides status and progress reports, an error handler event, and a completion handler event. Jobs can have sub-jobs, and link to the previous job. Jobs also have results.

    public interface IJob 
        : ICancelable
        , IProgress
        , ILogger
        , INamed
        , IStatus<JobStatus>
        , IErrorHandler
        , ICompletionHandler
    {
        IReadOnlyList<IJob> SubJobs { get; }
        void Start();
        void Stop();
        void Pause();
        void Resume();
        object Result { get; }
        IJob PreviousJob { get; }
    }

Interfaces

  • ICancelable
  • ICompletionHandler
  • IErrorReporting
  • IJob
  • ILogger
  • ILogWriter
  • IProgress
  • IStatus

That's a lot. Luckily you can use Job instances which implement most of these interfaces for you.

Appendix: Compared to Serilog

The most well-known C# logging framework is called Serilog.

Serilog is for structured object logging, where you can serialize various data objects and control the formatting.

Serilog has an embedded DSL, and a lot of features, whereas Ara3D.Logging is designed to be easily used and extended like any code.

When you are only logging strings, and time stamps, Ara3D.Logging is an alternative this is much simpler, easier to customize, and more performant.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Ara3D.Logging:

Package Downloads
Speckle.Importers.Ifc

Package Description

Speckle.WebIfc.Importer

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated