Thank you for sharing your file logger.
I would like to use this in a WinForm app. My business layer uses EF Core, so I have been using Microsoft.Extension.Logging.Console in development and wanted to add file logging.
WinForm apps use the XML-based App.config file instead of appsetting.json, so I was looking to include the logging configuration in App.config.
Configurable settings are normally defined in the VS-generated .Properties.Settings class. I defined an XML node for the logging parameters and loaded them via ConfigurationBuilder().AddXmlStream(stream).Build(). Console logging works OK using those settings, but filelogger raises exceptions when I call CreateLogger().
Do you have any examples or guidance for using XML configuration, particularly within App.config?
Below are some snippets for context, but the simple test project is at WFAppLogger if you want to reproduce the exception.
Program.cs:
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using System;
using System.IO;
using System.Windows.Forms;
using WFAppLogger.Properties;
namespace WFAppLogger
{
internal class Program
{
// Global Service Collection for dependency injection
static IServiceCollection services;
/// <summary>
/// The main entry point for the application.
/// </summary>
[STAThread]
static void Main()
{
// FYI: the roaming configuration that applies to the current user is at
// %LOCALAPPDATA%\\<Company Name>\<appdomainname>_<eid>_<hash>\<version>\user.config
//string userConfig = System.Configuration.ConfigurationManager.OpenExeConfiguration(
// System.Configuration.ConfigurationUserLevel.PerUserRoamingAndLocal).FilePath;
// If no user.config file exists, then the application.exe.config file is used
//string appConfig = System.Configuration.ConfigurationManager.OpenExeConfiguration(
// System.Configuration.ConfigurationUserLevel.None).FilePath;
// Get logging configuration from settings in app.config (or user.config)
var loggingConfig = Settings.Default.LoggingConfig;
var stream = new MemoryStream();
loggingConfig.Save(stream);
stream.Position = 0;
var configuration = new ConfigurationBuilder()
.AddXmlStream(stream)
.Build();
var config = configuration.GetSection("Logging");
// Initialize application logging via dependency injection
services = new ServiceCollection();
services.AddLogging(builder =>
{
builder.AddConfiguration(config);
builder.AddConsole();
builder.AddFile(o => o.RootPath = AppContext.BaseDirectory);
});
// Create logger for Program class and log that we're starting up
var logger = CreateLogger<Program>();
logger.LogInformation($"Starting {Application.ProductName}...");
Application.EnableVisualStyles();
Application.SetCompatibleTextRenderingDefault(false);
// Run the application
Application.Run(new Form1(CreateLogger<Form1>()));
// Log that we're exiting
logger.LogInformation($"Exiting {Application.ProductName}.");
}
/// <summary>
/// Creates a new Microsoft.Extensions.Logging.ILogger instance using the full name of the given type
/// </summary>
/// <typeparam name="T">The class type to create a logger for</typeparam>
/// <returns>The Microsoft.Extensions.Logging.ILogger that was created</returns>
public static ILogger<T> CreateLogger<T>()
{
// Create and return Logger instance for the given type using global dependency injection for logger factory
using (ServiceProvider sp = services.BuildServiceProvider())
{
return sp.GetRequiredService<ILoggerFactory>().CreateLogger<T>();
}
}
}
}
Snippet from App.config
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<configSections>
<sectionGroup name="userSettings" type="System.Configuration.UserSettingsGroup, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
<section name="WFAppLogger.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" allowExeDefinition="MachineToLocalUser" requirePermission="false" />
</sectionGroup>
</configSections>
<!-- some sections omitted for brevity ... !-->
<userSettings>
<WFAppLogger.Properties.Settings>
<setting name="DefaultLogMessage" serializeAs="String">
<value>Sample log message</value>
</setting>
<setting name="LoggingConfig" serializeAs="Xml">
<value>
<Root>
<Logging>
<LogLevel>
<Default>Debug</Default>
<WFAppLogger>Trace</WFAppLogger>
<Microsoft>Warning</Microsoft>
<System>Warning</System>
</LogLevel>
<Console>
<IncludeScopes>true</IncludeScopes>
</Console>
<File>
<IncludeScopes>true</IncludeScopes>
<BasePath>Logs</BasePath>
<Files>
<Path><appname>-<counter:000>.log</Path>
<MaxFileSize>10000</MaxFileSize>
</Files>
</File>
</Logging>
</Root>
</value>
</setting>
</WFAppLogger.Properties.Settings>
</userSettings>
</configuration>
```
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4