Console log
1
var consoleLog = new ConsoleLog();
2
var configuredConsoleLog = new ConsoleLog(new ConsoleLogSettings());
Copied!
​
Features
- Customizable per-level message colors.
Logmethod is nonblocking: log events are placed into an internal queue, grouped into batches and efficiently written to console output stream in the background.
​
Configuration
Here's what
ConsoleLogSettings have to offer:Option
Default value
Description
ColorsEnabledfalseEnables/disables coloring of log messages.
ColorMappingDebug => Gray, Info => White, Warn => Yellow, Error => Red, Fatal => DarkRedProvides a mapping from log levels to console colors.
All configuration parameters are optional.
​
Global configuration
There's also static global configuration that affects all
ConsoleLog instances in the application. It is accessed as follows:1
ConsoleLog.UpdateGlobalSettings(new ConsoleLogGlobalSettings());
Copied!
This configuration exposes following parameters worth mentioning:
Option
Default value
Description
EventsQueueCapacity50000Maximum count of log events in internal queue.
OutputBufferSize65536Size of the buffer used when writing log messages to console output stream (in bytes).
Note that changes in these global configuration parameters only take effect if performed before any actual logging.
​
Usage tips
- Keep in mind that log messages are rendered in the background. Use
FlushorFlushAsyncmethods ofConsoleLogto ensure that all logged events have been written to console when the application shuts down.​ - Internal queue with limited capacity implies that log messages may be lost in the event of overflow (see guarantees section for more on this topic). Use
EventsLostproperty of a singleConsoleLoginstance or staticTotalEventsLostproperty to check if any events have been discarded.​ - If any log events are lost due to internal queue overflow,
ConsoleLogemits a special diagnostic message that looks like this:- 1[ConsoleLog] Buffer overflow. 100 log events were lost (events queue capacity = 50000).Copied!
​
Synchronous version
There are certain scenarios where it's not feasible to use an asynchronous log, such as logging in unit tests or simple console utilities. These use cases are better served by an alternative synchronous implementation that writes to console immediately in
Log method:1
var synchronousLog = new SynchronousConsoleLog();
Copied!
It's performance is vastly inferior to that of
ConsoleLog due to lack of buffering, but it removes the need to flush and works well in test environments where Console.Out cannot be safely cached.Last modified 3yr ago