public static void Error(
this Microsoft.Extensions.Logging.ILogger logger,
EventId eventId,
string message,
params object[] args
)
=> logger.LogError(eventId, message, args);
public static void Error(
this Microsoft.Extensions.Logging.ILogger logger,
Exception exception,
string message,
params object[] args
)
=> logger.LogError(exception, message, args);
public static void Info(
this Microsoft.Extensions.Logging.ILogger logger,
EventId eventId,
Exception exception,
string message,
params object[] args
)
=> logger.LogInformation(eventId, exception, message, args);
protected internal virtual void InitServices(IServiceProvider services)
{
_config = services.GetRequiredService <IConfiguration>();
_client = services.GetRequiredService <DiscordSocketClient>();
_commands = services.GetRequiredService <CommandService>();
_logger = services.GetRequiredService <ILogger <CommandHandler> >();
_serviceProvider = services;
}
public static void Log(this Microsoft.Extensions.Logging.ILogger logger, LogMessage message)
{
var logLevel = message.Severity switch
{
LogSeverity.Critical => LogLevel.Critical,
LogSeverity.Debug => LogLevel.Debug,
LogSeverity.Error => LogLevel.Error,
LogSeverity.Info => LogLevel.Information,
LogSeverity.Verbose => LogLevel.Trace,
LogSeverity.Warning => LogLevel.Warning,
_ => LogLevel.Information
};
if (message.Exception is not null)
{
logger.Error(message.Exception, message.Message);
}
else
{
logger.Log(logLevel, message.Message);
}
}
/// <summary>
/// The program's Main is an <see langword="async"/> Task . Entry point to the Program
/// </summary>
/// <param name="args"></param>
/// <returns></returns>
public static async Task Main(string[] args)
{
#region Startup logger
// Configure a startup logger, prior to getting the Logger configuration from the ConfigurationRoot
// Serilog is the logging provider I picked to provide a logging solution for the Console01 application
// Enable Serilog's internal debug logging. Note that internal logging will not write to any user-defined Sources
// https://github.com/serilog/serilog-sinks-file/blob/dev/example/Sample/Program.cs
Serilog.Debugging.SelfLog.Enable(System.Console.Out);
// Another example is at https://stackify.com/serilog-tutorial-net-logging/
// This brings in the System.Diagnostics.Debug namespace and writes the SelfLog there
Serilog.Debugging.SelfLog.Enable(msg => Debug.WriteLine(msg));
Serilog.Debugging.SelfLog.WriteLine("in Program.Main(Serilog Self Log)");
// Another example is at https://github.com/serilog/serilog-extensions-logging/blob/dev/samples/Sample/Program.cs
// Another is https://nblumhardt.com/2019/10/serilog-in-aspnetcore-3/
// Creating a `LoggerProviderCollection` lets Serilog optionally write events through other dynamically-added MEL ILoggerProviders.
//var providers = new LoggerProviderCollection();
// Setup Serilog's static logger with an initial configuration sufficient to log startup errors
// create a local Serilog logger for use during Program startup
var serilogLoggerConfiguration = new Serilog.LoggerConfiguration()
.MinimumLevel.Verbose()
.Enrich.FromLogContext()
.Enrich.WithThreadId()
.WriteTo.Console(outputTemplate: "Static startup Serilog {Timestamp:HH:mm:ss zzz} [{Level}] ({Name:l}) {Message}{NewLine}{Exception}")
.WriteTo.Seq(serverUrl: "http://*****:*****@"C:\Dropbox\whertzing\GitHub\ATAP.Utilities\devlog\A01Console.{Date}.log", fileSizeLimitBytes: 1024, outputTemplate: "Static Serilog {Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level}] {Message}{NewLine}{Exception}", rollingInterval: RollingInterval.Day, rollOnFileSizeLimit: true, retainedFileCountLimit: 31)
.WriteTo.Debug();
//.Enrich.WithHttpRequestId()
//.Enrich.WithUserName()
//.WithExceptionDetails()
//.WriteTo.Providers(providers)
Serilog.Core.Logger serilogLogger = serilogLoggerConfiguration.CreateLogger();
// Set the Static logger called Log to use this LoggerConfiguration
Serilog.Log.Logger = serilogLogger;
Log.Debug("{Program} {Main}: The program Console01 is starting", "Program", "Main");
Log.Debug("{Program} {Main}: LoggerFactory and local logger defined with a default startup configuration:", "Program", "Main");
// Set the MEL LoggerFactory to use this LoggerConfiguration
Microsoft.Extensions.Logging.ILoggerFactory mELoggerFactory = new Microsoft.Extensions.Logging.LoggerFactory().AddSerilog();
Microsoft.Extensions.Logging.ILogger mELlogger = mELoggerFactory.CreateLogger("Program");
mELlogger.LogDebug("{0} {1}: The program Console01 is starting", "Program", "Main");
mELlogger.LogDebug("{0} {1}: LoggerFactory and local logger defined with a default startup configuration:", "Program", "Main");
#endregion
#region stringLocalizers and optionally resource managers for InternationalizatioN (AKA I18N)
// populate the string localizers for Program
Options = Microsoft.Extensions.Options.Options.Create(new LocalizationOptions());
StringLocalizerFactory = new ResourceManagerStringLocalizerFactory(Options, NullLoggerFactory.Instance);
DebugLocalizer = StringLocalizerFactory.Create(nameof(Resources), "ATAP.Console.Console01");
ExceptionLocalizer = StringLocalizerFactory.Create(nameof(Resources), "ATAP.Console.Console01");
ConfigLCL = StringLocalizerFactory.Create(nameof(Resources), "ATAP.Console.Console01");
UILocalizer = StringLocalizerFactory.Create(nameof(Resources), "ATAP.Console.Console01");
// If localized non-string resources are needed, uncomment the following block
// Load the ResourceManagers from the installation directory. These provide access to all localized resources including non-string resources
// Cannot create more-derived types from a ResourceManager. Gets Invalid cast. See also https://stackoverflow.com/questions/2500280/invalidcastexception-for-two-objects-of-the-same-type/30623970, the invalid cast might be because ResourceManagers are not per-assembly?
// i.e., the following will no compile DebugResourceManager debugResourceManager = (DebugResourceManager)new ResourceManager("ATAP.Console.Console01.Properties.ConsoleDebugResources", typeof(ConsoleDebugResources).Assembly);
// These will compile if needed
//var debugResourceManager = new ResourceManager("ATAP.Console.Console01.Properties.ConsoleDebugResources", typeof(ConsoleDebugResources).Assembly);
//var exceptionResourceManager = new ResourceManager("ATAP.Console.Console01.Properties.ConsoleExceptionResources", typeof(ConsoleExceptionResources).Assembly);
//var uIResourceManager = new ResourceManager("ATAP.Console.Console01.Properties.ConsoleUIResources", typeof(ConsoleUIResources).Assembly);
#endregion region
#region initialStartup and loadedFrom directories
// When running as a Windows service, the initial working dir is usually %WinDir%\System32, but the program (and configuration files) is probably installed to a different directory
// When running as a *nix service, the initial working dir could be anything. The program (and machine-wide configuration files) are probably installed in the location where the service starts. //ToDo: verify this
// When running as a Windows or Linux Console App, the initial working dir could be anything, but the program (and machine-wide configuration files) is probably installed to a different directory.
// When running as a console app, it is very possible that there may be local (to the initial startup directory) configuration files to load
// get the initial startup directory
// get the directory where the executing assembly (usually .exe) and possibly machine-wide configuration files are installed to.
var initialStartupDirectory = Directory.GetCurrentDirectory(); //ToDo: Catch exceptions
mELlogger.LogDebug(DebugLocalizer["{0} {1}: initialStartupDirectory: {2}", "Program", "Main", initialStartupDirectory]);
var loadedFromDirectory = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location); //ToDo: Catch exceptions
mELlogger.LogDebug(DebugLocalizer["{0} {1}: loadedFromDirectory: {2}", "Program", "Main", loadedFromDirectory]);
#endregion region
#region initial genericHostConfigurationBuilder and genericHostConfigurationRoot
// Create the initial genericHostConfigurationBuilder for this genericHost's ConfigurationRoot. This creates an ordered chain of configuration providers. The first providers in the chain have the lowest priority, the last providers in the chain have a higher priority.
// Initial configuration does not take Environment into account.
var genericHostConfigurationBuilder = ConfigurationExtensions.ATAPStandardConfigurationBuilder(
GenericHostDefaultConfiguration.Production, true, null, GenericHostStringConstants.genericHostSettingsFileName,
GenericHostStringConstants.hostSettingsFileNameSuffix, loadedFromDirectory, initialStartupDirectory, hostEnvPrefixes, args, switchMappings);
// Create this program's initial genericHost's ConfigurationRoot
var genericHostConfigurationRoot = genericHostConfigurationBuilder.Build();
#endregion
#region (optional) Debugging the Configuration
// for debugging and education, uncomment this region and inspect the two section Lists (using debugger Locals) to see exactly what is in the configuration
// var sections = genericHostConfigurationRoot.GetChildren();
// List<IConfigurationSection> sectionsAsListOfIConfigurationSections = new List<IConfigurationSection>();
// List<ConfigurationSection> sectionsAsListOfConfigurationSections = new List<ConfigurationSection>();
// foreach (var iSection in sections) sectionsAsListOfIConfigurationSections.Add(iSection);
// foreach (var iSection in sectionsAsListOfIConfigurationSections) sectionsAsListOfConfigurationSections.Add((ConfigurationSection)iSection);
#endregion
#region Environment determination and validation
// ToDo: Before the genericHost is built, have to use a StringConstant for the string that means "Production", and hope the ConfigurationRoot value for Environment matches the StringConstant
// Determine the environment (Debug, TestingUnit, TestingX, QA, QA1, QA2, ..., Staging, Production) to use from the initialGenericHostConfigurationRoot
var envNameFromConfiguration = genericHostConfigurationRoot.GetValue <string>(GenericHostStringConstants.EnvironmentConfigRootKey, GenericHostStringConstants.EnvironmentDefault);
mELlogger.LogDebug(DebugLocalizer["{0} {1}: Initial environment name: {2}", "Program", "Main", envNameFromConfiguration]);
// optional: Validate that the environment provided is one this program understands how to use
// Accepting any string for envNameFromConfiguration might pose a security risk, as it will allow arbitrary files to be loaded into the configuration root
switch (envNameFromConfiguration)
{
case GenericHostStringConstants.EnvironmentDevelopment:
// ToDo: Programmers can add things here
break;
case GenericHostStringConstants.EnvironmentProduction:
// This is the expected leg for Production environment
break;
default:
// IF you want to accept any environment name as OK, just comment out the following throw
// Keep the throw in here if you want to explicitly disallow any environment other than ones specified in the switch
throw new NotImplementedException(ExceptionLocalizer["The Environment {0} is not supported", envNameFromConfiguration]);
}
;
#endregion
#region final (Environment-aware) genericHostConfigurationBuilder and appConfigurationBuilder
// If the initial genericHostConfigurationRoot specifies the Environment is production, then the genericHostConfigurationBuilder is correct "as-is"
// but if not, build a 2nd (final) genericHostConfigurationBuilder, this time including environment-specific configuration providers
if (envNameFromConfiguration != GenericHostStringConstants.EnvironmentProduction)
{
// Recreate the ConfigurationBuilder for this genericHost, this time including environment-specific configuration providers.
mELlogger.LogDebug(DebugLocalizer["{0} {1}: Recreating genericHostConfigurationBuilder for Environment: {2}"], "Program", "Main", envNameFromConfiguration);
genericHostConfigurationBuilder = ConfigurationExtensions.ATAPStandardConfigurationBuilder(GenericHostDefaultConfiguration.Production, false, envNameFromConfiguration,
GenericHostStringConstants.genericHostSettingsFileName, GenericHostStringConstants.hostSettingsFileNameSuffix, loadedFromDirectory, initialStartupDirectory, hostEnvPrefixes, args, switchMappings);
}
// Create the appConfigurationBuilder, either as Production or as some other environment specific
IConfigurationBuilder appConfigurationBuilder;
mELlogger.LogDebug(DebugLocalizer["{0} {1}: Creating appConfigurationBuilder for Environment: {2}"], "Program", "Main", envNameFromConfiguration);
appConfigurationBuilder = ConfigurationExtensions.ATAPStandardConfigurationBuilder(Console01DefaultConfiguration.Production, envNameFromConfiguration == GenericHostStringConstants.EnvironmentProduction, envNameFromConfiguration,
Console01StringConstants.SettingsFileName, Console01StringConstants.SettingsFileNameSuffix, loadedFromDirectory, initialStartupDirectory, appEnvPrefixes, args, switchMappings);
#endregion
#region Configure the genericHostBuilder, including DI-Container, IHostLifetime, services in the services collection, genericHostConfiguration, and appConfiguration
// Make a GenericHostBuilder with the Configuration (as above), and chose a specific instance of an IHostLifetime
var genericHostBuilder = GenericHostExtensions.ATAPStandardGenericHostBuilderForConsoleLifetime(genericHostConfigurationBuilder, appConfigurationBuilder);
// Add the specific IHostLifetime for this program (or service)
//ToDo: implement service and serviced, then see if this can be moved to the ATAPStandardGenericHostBuilder static extension method
genericHostBuilder.ConfigureServices((hostContext, services) => {
services.AddSingleton <IHostLifetime, ConsoleLifetime>();
//services.AddOptions<ConsoleLifetime>(Options => Options.SuppressStatusMessages = true);
});
// in Production, surpress the startup messages appearing on the Console stdout
if (envNameFromConfiguration == GenericHostStringConstants.EnvironmentProduction)
{
//genericHostBuilder.Configure<ConsoleLifetimeOptions>(Options => Options.SuppressStatusMessages = true); //
}
#region Configure the GenericHost logging per the Logging section in ConfigurationRoot
genericHostBuilder.ConfigureLogging((hostContext, loggingBuilder) => {
loggingBuilder.AddConfiguration(genericHostConfigurationRoot.GetSection("Logging"));
//loggingBuilder.UseSerilog
});
// Build the GH configuration
//genericHostConfigurationRoot = genericHostConfigurationBuilder.Build();
//// Create a LoggerFactory, configure it to use Serilog
//loggerConfiguration = genericHostConfigurationRoot.GetSection("Logging");
//// redefine the factory according to the new configuration
//factory = new LoggerFactory();
//factory.AddSerilog(loggerConfiguration.CreateLogger());
//// Set the LogFactory in the ATP.Utilities.Logging class
//LogProvider.SetLogFactory(factory);
//// Set the LogFactory in the DI-Services
//// ToDo: LoggerFactory loggerFactory.SetLogFactory(factory);
//// redefine the local logger from this factory, configured with the startup logging as defined in the Logging section of the configurationRoot
//logger = factory.CreateLogger("Console01");
//serilogLogger.LogDebug(DebugLocalizer["{0} {1}: LoggerFactory and local logger redefined per the Logging section in the configuration settings:"], "Program", "Main");
//// Copy this tour "standard logger
//// Create a LoggerFactory, configure it to use Serilog
//var factory = new LoggerFactory();
//var x = serilogLoggerConfiguration..CreateLoggerF();
//factory.AddSerilog(serilogLoggerConfiguration.CreateLogger());
//LogProvider.SetLogFactory(factory);
//// Create a local logger from this factory, configured with the startup logging defined above
//logger = factory.CreateLogger("Console01");
//// For this program, I've selected Serilog as the underlying serilogLogger.
//genericHostBuilder.UseSerilog();
#endregion
// Add specific services for this application
genericHostBuilder.ConfigureServices((hostContext, services) => {
// Localization for the services
services.AddLocalization(options => options.ResourcesPath = "Resources");
services.AddSingleton <IConsoleSinkHostedService, ConsoleSinkHostedService>();
services.AddSingleton <IConsoleSourceHostedService, ConsoleSourceHostedService>();
//services.AddHostedService<ConsoleMonitorBackgroundService>(); // Only use this service in a GenericHost having a DI-injected IHostLifetime of type ConsoleLifetime.
services.AddHostedService <Console01BackgroundService>(); // Only use this service in a GenericHost having a DI-injected IHostLifetime of type ConsoleLifetime.
//services.AddSingleton<IFileSystemWatchersHostedService, FileSystemWatchersHostedService>();
services.AddSingleton <IObservableResetableTimersHostedService, ObservableResetableTimersHostedService>();
//services.AddSingleton<IFileSystemWatchersAsObservableFactoryService, FileSystemWatchersAsObservableFactoryService>();
});
#endregion
// Build the Host
var genericHost = genericHostBuilder.Build();
// Use the ConfigurationSettings for ConsoleLifetimeOptions.SuppressStatusMessages
//services.Configure<ConsoleLifetimeOptions>(opts opts.SuppressStatusMessages = Configuration["SuppressStatusMessages"] != null)
// Start it going
try {
mELlogger.LogDebug(DebugLocalizer["{0} {1}: \"using\" the genericHost.", "Program", "Main"]);
using (genericHost) {
mELlogger.LogDebug(DebugLocalizer["{0} {1}: Calling StartAsync on the genericHost.", "Program", "Main"]);
// Start the generic host running all its services and setup listeners for stopping
// all the rigamarole in https://andrewlock.net/introducing-ihostlifetime-and-untangling-the-generic-host-startup-interactions/
// Attribution to https://stackoverflow.com/questions/52915015/how-to-apply-hostoptions-shutdowntimeout-when-configuring-net-core-generic-host for OperationCanceledException notes
// ToDo: further investigation to ensure OperationCanceledException should be ignored in all cases (service or console host, kestrel or IntegratedIISInProcessWebHost)
try {
// The RunAsync method exists on a genericHost instance having a DI container instance that resolves a IHostLifetime. There are three "standard" implementations of IHostLifetime, Console, Service (Windows) and Serviced (*nix)
// await genericHost.RunAsync().ConfigureAwait(false);
// From MSMQ process sample at https://github.com/dotnet/extensions/blob/master/src/Hosting/samples/SampleMsmqHost/Program.cs
// start the genericHost
await genericHost.StartAsync().ConfigureAwait(false);
//ToDo: Better understanding - should the primary BackgroundService be run here instead of as a Background service?
// Nothing to do, the HostedServices and BackgroundServices do it all
////// ToDo: Deal with application lifetime? can applications stop, and restart, within the lifetime of the genericHost
//////// Get the CancellationToken stored in IHostApplicationLifetime ApplicationStopping
////// var applicationLifetime = genericHost.Services.GetRequiredService<IHostApplicationLifetime>();
////// var cT = applicationLifetime.ApplicationStopping;
//////// hang out until cancellation is requested
//////while (!cT.IsCancellationRequested) {
////// cT.ThrowIfCancellationRequested();
//////}
// wait for the genericHost to shutdown
await genericHost.WaitForShutdownAsync().ConfigureAwait(false);
}
catch (OperationCanceledException e) {
; // Just ignore OperationCanceledException to suppress it from bubbling upwards if the main program was cancelledOperationCanceledException
// The Exception should be shown in the ETW trace
//ToDo: Add Error level or category to ATAPUtilitiesETWProvider, and make OperationCanceled one of the catagories
// Specifically log the details of the cancellation (where it originated)
// ATAPUtilitiesETWProvider.Log.Information($"Exception in Program.Main: {e.Exception.GetType()}: {e.Exception.Message}");
} // Other kinds of exceptions bubble up to the catch block for the surrounding try, where the Serilog logger records it
finally {
// Dispose of any resources held directly by this program. Resources held by services in the DI-Container will be disposed of by the genericHost as it tears down
//if (DisposeThis != null) { DisposeThis.Dispose(); }
}
// Here, the StartAsync has completed, the Main method is over
// Log Program finishing to ETW if it happens to resume execution here for some reason(as of 06/2019, ILWeaving this assembly results in a thrown invalid CLI Program Exception
// ATAP.Utilities.ETW.ATAPUtilitiesETWProvider.Log(">Program.Main");
mELlogger.LogDebug(DebugLocalizer["{0} {1}: the genericHost has exitied "], "Program", "Main");
}
}
catch (Exception ex) {
MELLogger.LogCritical(ExceptionLocalizer["{0} {1}: genericHost start-up failed. ExceptionMessage: {2}", "Program", "Main", ex.Message]);
throw ex;
}
finally {
// ToDo: How to do something similar for MEL logger?
Log.CloseAndFlush();
}
#region Playing with CSharpSyntaxTree
// Just playing with the CSharpSyntaxTree feature here
//SyntaxTree tree = CSharpSyntaxTree.ParseText(programText);
//CompilationUnitSyntax root = tree.GetCompilationUnitRoot();
// Use the debugger and Locals window to see these objects
#endregion region
mELlogger.LogDebug(DebugLocalizer["{0} {1}: Program:Main is exiting", "Program", "Main"]);
}
public static void Info(this Microsoft.Extensions.Logging.ILogger logger, string message, params object[] args) => logger.LogInformation(message, args);
public static void Verbose(this Microsoft.Extensions.Logging.ILogger logger, string message, params object[] args) => logger.LogTrace(message, args);
