BannisterLake.NET.BLSoft 2.0.6

Bannister Lake - BLSoft

This is a library of functions to help create apps with a common base.

Logging

// Enable using a process id as part of the log file name so each launch of the app has a new log file each day
ErrorLog.LogFileUsePID = allSetting.BLSoft.Logging.UseProcessId;

// Enable the display of milliseconds in the logs instead of only seconds
ErrorLog.LogTimeShowMilliseconds = allSetting.BLSoft.Logging.UseMilliseconds;

// Enable the debug type log messages to be written to the log
ErrorLog.EnableLogType(ErrorLogType.Debug, allSetting.BLSoft.Logging.Debug);

// Enable the warning log messages to be written to the log
ErrorLog.EnableLogType(ErrorLogType.Warning, allSetting.BLSoft.Logging.Warning);

// write the current status of the Performance logging enablement to the log file
ErrorLog.Log(ErrorLogType.Info, $"Performance logging is " + (ErrorLog.IsEnabled(ErrorLogType.Performance) ? "enabled." : "disabled."));

Settings

// save the settings to a JSON file
await BLSoft.Utilities.TrySaveJsonSettings(appSettingsFileName, allSettings);

// load settings into a settings class object
private readonly AppSettings allSettings = new();
IConfiguration AppConfig = new ConfigurationBuilder()
    .SetBasePath(Utilities.BaseCommonAppPath())
    .AddJsonFile(appSettingsFileName, optional: true)
    .Build();

AppConfig.Bind("BLSoft", allSettings.BLSoft);


public class AppSettings
{
    public AppSettings() 
    {
        OtherSettings = new();
        BLSoft = new();
    }
    
    public BLSoft.Settings.BLSoftSettings BLSoft { get; set; }
    public MoreSettings OtherSettings { get; set; }
}	

Performance Timer

// the Performance Timer is integrated with the ErrorLog to record how long tasks take
var performance = PerformanceTimer.Start();
try { ... }
finally
{
    // log entry looks like: 
    // 2023-03-24	9:37:12	Performance: 	    19 ms: My task finished in 19 ms.
    performance.StopTimer("My task finished in {0} ms.");
}

// To create a timer that isn't started immediately
var performance = new PerformanceTimer(...);
...
performance.StartTimer();
try 
{	    
    ... 
	performance.StopTimer("Task A completed in {0} ms.");
}
catch (Exception)
{
    performance.StopTimer("Task A failed after {0} ms.");
	...
}