Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Add WINDOWS to switch in Serilog HostBuilderExtensions #2492

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: Add WINDOWS to switch in Serilog HostBuilderExtensions #2492

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
194 changes: 97 additions & 97 deletions src/Uno.Extensions.Logging.Serilog/HostBuilderExtensions.cs
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@frogcrush we should avoid making large whitespace changes as part of the PR, just so it's easier to track what are the relevant functional changes made in a commit

Original file line number Diff line number Diff line change
Expand Up @@ -12,129 +12,129 @@ namespace Uno.Extensions;
/// </summary>
public static class HostBuilderExtensions
{
/// <summary>
/// Configures logging to use Serilog with the default configuration.
/// </summary>
/// <param name="hostBuilder">
/// The <see cref="IHostBuilder"/> to configure.
/// </param>
/// <param name="consoleLoggingEnabled">
/// Whether to enable console logging. Optional.
/// </param>
/// <param name="fileLoggingEnabled">
/// Whether to enable file logging. Optional.
/// </param>
/// <param name="configureLogger">
/// Used to provide additional configuration for the logger. Optional.
/// </param>
/// <returns>
/// The <see cref="IHostBuilder"/> that was passed in.
/// </returns>
public static IHostBuilder UseSerilog(this IHostBuilder hostBuilder,
bool consoleLoggingEnabled = false,
bool fileLoggingEnabled = false,
Action<LoggerConfiguration>? configureLogger = null)
{
return hostBuilder.UseSerilog(() => consoleLoggingEnabled, () => fileLoggingEnabled, configureLogger);
}
/// <summary>
/// Configures logging to use Serilog with the default configuration.
/// </summary>
/// <param name="hostBuilder">
/// The <see cref="IHostBuilder"/> to configure.
/// </param>
/// <param name="consoleLoggingEnabled">
/// Whether to enable console logging. Optional.
/// </param>
/// <param name="fileLoggingEnabled">
/// Whether to enable file logging. Optional.
/// </param>
/// <param name="configureLogger">
/// Used to provide additional configuration for the logger. Optional.
/// </param>
/// <returns>
/// The <see cref="IHostBuilder"/> that was passed in.
/// </returns>
public static IHostBuilder UseSerilog(this IHostBuilder hostBuilder,
bool consoleLoggingEnabled = false,
bool fileLoggingEnabled = false,
Action<LoggerConfiguration>? configureLogger = null)
{
return hostBuilder.UseSerilog(() => consoleLoggingEnabled, () => fileLoggingEnabled, configureLogger);
}

/// <summary>
/// Configures logging to use Serilog with the default configuration.
/// </summary>
/// <param name="hostBuilder">
/// The <see cref="IHostBuilder"/> to configure.
/// </param>
/// <param name="consoleLoggingEnabled">
/// Whether to enable console logging.
/// </param>
/// <param name="fileLoggingEnabled">
/// Whether to enable file logging.
/// </param>
/// <param name="configureLogger">
/// Used to provide additional configuration for the logger. Optional.
/// </param>
/// <returns>
/// The <see cref="IHostBuilder"/> that was passed in.
/// </returns>
public static IHostBuilder UseSerilog(this IHostBuilder hostBuilder,
Func<bool> consoleLoggingEnabled,
Func<bool> fileLoggingEnabled,
Action<LoggerConfiguration>? configureLogger = null)
{
return hostBuilder
.ConfigureLogging((context, loggingBuilder) =>
{
var loggerConfiguration = new LoggerConfiguration();
/// <summary>
/// Configures logging to use Serilog with the default configuration.
/// </summary>
/// <param name="hostBuilder">
/// The <see cref="IHostBuilder"/> to configure.
/// </param>
/// <param name="consoleLoggingEnabled">
/// Whether to enable console logging.
/// </param>
/// <param name="fileLoggingEnabled">
/// Whether to enable file logging.
/// </param>
/// <param name="configureLogger">
/// Used to provide additional configuration for the logger. Optional.
/// </param>
/// <returns>
/// The <see cref="IHostBuilder"/> that was passed in.
/// </returns>
public static IHostBuilder UseSerilog(this IHostBuilder hostBuilder,
Func<bool> consoleLoggingEnabled,
Func<bool> fileLoggingEnabled,
Action<LoggerConfiguration>? configureLogger = null)
{
return hostBuilder
.ConfigureLogging((context, loggingBuilder) =>
{
var loggerConfiguration = new LoggerConfiguration();

loggerConfiguration.ReadFrom.Configuration(context.Configuration);
loggerConfiguration.ReadFrom.Configuration(context.Configuration);

if (consoleLoggingEnabled?.Invoke() ?? false)
{
AddConsoleLogging(loggerConfiguration);
}
if (consoleLoggingEnabled?.Invoke() ?? false)
{
AddConsoleLogging(loggerConfiguration);
}

if (fileLoggingEnabled?.Invoke() ?? false)
{
var logPath = GetLogFilePath(context);
if (logPath is not null)
{
AddFileLogging(loggerConfiguration, logPath);
}
}
if (fileLoggingEnabled?.Invoke() ?? false)
{
var logPath = GetLogFilePath(context);
if (logPath is not null)
{
AddFileLogging(loggerConfiguration, logPath);
}
}

configureLogger?.Invoke(loggerConfiguration);
configureLogger?.Invoke(loggerConfiguration);

var logger = loggerConfiguration.CreateLogger();
var logger = loggerConfiguration.CreateLogger();

loggingBuilder.AddSerilog(logger);
});
}
loggingBuilder.AddSerilog(logger);
});
}

private static LoggerConfiguration AddConsoleLogging(LoggerConfiguration configuration)
{
private static LoggerConfiguration AddConsoleLogging(LoggerConfiguration configuration)
{
#pragma warning disable CA1416 // Validate platform compatibility: The net8.0 version is not used on older versions of OS
return configuration
//-:cnd:noEmit
return configuration
//-:cnd:noEmit
#if __ANDROID__
.WriteTo.AndroidLog(outputTemplate: "{Message:lj} {Exception}{NewLine}")
#elif __IOS__
.WriteTo.NSLog(outputTemplate: "{Level:u1}/{SourceContext}: {Message:lj} {Exception}")
.WriteTo.NSLog(outputTemplate: "{Level:u1}/{SourceContext}: {Message:lj} {Exception}")
#else
.WriteTo.Console(outputTemplate: "{Timestamp:MM-dd HH:mm:ss.fffzzz} {Level:u1}/{SourceContext}: {Message:lj} {Exception}{NewLine}")
#endif
.WriteTo.Debug(outputTemplate: "{Timestamp:MM-dd HH:mm:ss.fffzzz} {Level:u1}/{SourceContext}: {Message:lj} {Exception}{NewLine}");
//+:cnd:noEmit
.WriteTo.Debug(outputTemplate: "{Timestamp:MM-dd HH:mm:ss.fffzzz} {Level:u1}/{SourceContext}: {Message:lj} {Exception}{NewLine}");
//+:cnd:noEmit
#pragma warning restore CA1416 // Validate platform compatibility
}
}

private static LoggerConfiguration AddFileLogging(LoggerConfiguration configuration, string logFilePath)
{
//-:cnd:noEmit
#if __ANDROID__ || __IOS__ || NETSTANDARD
return configuration
.WriteTo.File(logFilePath, outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fffzzz} [{Platform}] {Level:u1}/{SourceContext}: {Message:lj} {Exception}{NewLine}", fileSizeLimitBytes: 10485760) // 10mb
private static LoggerConfiguration AddFileLogging(LoggerConfiguration configuration, string logFilePath)
{
//-:cnd:noEmit
#if __ANDROID__ || __IOS__ || NETSTANDARD || __WINDOWS__
return configuration
.WriteTo.File(logFilePath, outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fffzzz} [{Platform}] {Level:u1}/{SourceContext}: {Message:lj} {Exception}{NewLine}", fileSizeLimitBytes: 10485760) // 10mb
#if __ANDROID__
.Enrich.WithProperty("Platform", "Android");
#elif __IOS__
.Enrich.WithProperty("Platform", "iOS");
.Enrich.WithProperty("Platform", "iOS");
#else
.Enrich.WithProperty("Platform", "WASM");
#endif
#else
return configuration;
#endif
//+:cnd:noEmit
}
//+:cnd:noEmit
}

private static string? GetLogFilePath(HostBuilderContext hostBuilderContext)
{
var logDirectory = hostBuilderContext.HostingEnvironment.GetAppDataPath();
if (string.IsNullOrWhiteSpace(logDirectory))
{
return null;
}
private static string? GetLogFilePath(HostBuilderContext hostBuilderContext)
{
var logDirectory = hostBuilderContext.HostingEnvironment.GetAppDataPath();
if (string.IsNullOrWhiteSpace(logDirectory))
{
return null;
}

var assemblyName = Assembly.GetEntryAssembly()?.FullName ?? "unologging";
return Path.Combine(logDirectory, $"{assemblyName}.log");
}
var assemblyName = Assembly.GetEntryAssembly()?.FullName ?? "unologging";
return Path.Combine(logDirectory, $"{assemblyName}.log");
}
}
Loading