Skip to content

Free, open-source Windows optimization tool for performance, privacy, and simplicity.

fix: improve logging and remove ununnecessary logging

fatDuck36f80a8ffe71
diff --git a/optimizerDuck/Domain/Execution/ExecutionScope.cs b/optimizerDuck/Domain/Execution/ExecutionScope.cs
index 344f66c..cae959d 100644
--- a/optimizerDuck/Domain/Execution/ExecutionScope.cs
+++ b/optimizerDuck/Domain/Execution/ExecutionScope.cs
@@ -76,7 +76,7 @@ public sealed class ExecutionScope : IDisposable
if (_stats.IsEmpty)
{
- Logger.LogInformation(
+ Logger.LogDebug(
"Completed in {Time} (no operations tracked)",
_stopwatch.Elapsed.ToString(@"mm\:ss\.fff")
);
@@ -88,7 +88,7 @@ public sealed class ExecutionScope : IDisposable
_stats.Select(kv => $"{kv.Key}: +({kv.Value.Success}) -({kv.Value.Fail})")
);
- Logger.LogInformation(
+ Logger.LogDebug(
"Completed in {Time} | {Summary}",
_stopwatch.Elapsed.ToString(@"mm\:ss\.fff"),
summary
@@ -96,7 +96,7 @@ public sealed class ExecutionScope : IDisposable
}
if (!LoggingOnly)
- Logger.LogInformation(
+ Logger.LogDebug(
"Steps: {Total} ({Success} success, {Failed} failed)",
_executedSteps.Count,
_executedSteps.Count(s => s.Success),
diff --git a/optimizerDuck/Domain/Optimizations/Categories/SecurityAndPrivacy.cs b/optimizerDuck/Domain/Optimizations/Categories/SecurityAndPrivacy.cs
index 079751e..00f8c56 100644
--- a/optimizerDuck/Domain/Optimizations/Categories/SecurityAndPrivacy.cs
+++ b/optimizerDuck/Domain/Optimizations/Categories/SecurityAndPrivacy.cs
@@ -147,17 +147,11 @@ public class SecurityAndPrivacy : IOptimizationCategory
// @formatter:on
foreach (var task in tasksToDelete)
- try
- {
- if (!ScheduledTaskService.IsTaskEnabled(task))
- continue;
- ScheduledTaskService.DisableTask(task);
- context.Logger.LogInformation("Disabled task {Task}", task);
- }
- catch (Exception ex)
- {
- context.Logger.LogWarning(ex, "Failed to disable task {Task}", task);
- }
+ {
+ if (!ScheduledTaskService.IsTaskEnabled(task))
+ continue;
+ ScheduledTaskService.DisableTask(task);
+ }
return CompleteFromScope();
}
@@ -202,16 +196,11 @@ public class SecurityAndPrivacy : IOptimizationCategory
};
foreach (var task in tasksToDelete)
- try
- {
- if (!ScheduledTaskService.IsTaskEnabled(task))
- continue;
- ScheduledTaskService.DisableTask(task);
- }
- catch (Exception ex)
- {
- context.Logger.LogWarning(ex, "Failed to disable task {Task}", task);
- }
+ {
+ if (!ScheduledTaskService.IsTaskEnabled(task))
+ continue;
+ ScheduledTaskService.DisableTask(task);
+ }
context.Logger.LogInformation(
"Disabled Windows Error Reporting and Compatibility Assistant"
@@ -430,15 +419,8 @@ public class SecurityAndPrivacy : IOptimizationCategory
)
);
- try
- {
- if (ScheduledTaskService.IsTaskEnabled(@"\Microsoft\Windows\Maps\MapsUpdateTask"))
- ScheduledTaskService.DisableTask(@"\Microsoft\Windows\Maps\MapsUpdateTask");
- }
- catch (Exception ex)
- {
- context.Logger.LogWarning(ex, "Failed to disable maps update task");
- }
+ if (ScheduledTaskService.IsTaskEnabled(@"\Microsoft\Windows\Maps\MapsUpdateTask"))
+ ScheduledTaskService.DisableTask(@"\Microsoft\Windows\Maps\MapsUpdateTask");
context.Logger.LogInformation(
"Disabled location tracking, sensors and offline maps updates"
diff --git a/optimizerDuck/Services/Configuration/ConfigManager.cs b/optimizerDuck/Services/Configuration/ConfigManager.cs
index cc69011..6ec1f66 100644
--- a/optimizerDuck/Services/Configuration/ConfigManager.cs
+++ b/optimizerDuck/Services/Configuration/ConfigManager.cs
@@ -225,6 +225,7 @@ public class ConfigManager(IConfiguration configuration, ILogger<ConfigManager>
SetValueIgnoreCase(current, parts[^1], value);
await SaveConfigAsync().ConfigureAwait(false);
+ logger.LogInformation("Config key {Key} set to {Value}", key, value);
}
finally
{
@@ -254,6 +255,7 @@ public class ConfigManager(IConfiguration configuration, ILogger<ConfigManager>
RemoveIgnoreCase(current, parts[^1]);
await SaveConfigAsync().ConfigureAwait(false);
+ logger.LogInformation("Config key {Key} removed", key);
}
finally
{
@@ -274,13 +276,32 @@ public class ConfigManager(IConfiguration configuration, ILogger<ConfigManager>
Directory.CreateDirectory(configDir);
if (!File.Exists(_configPath))
+ {
+ logger.LogInformation("Config file not found, starting with empty config");
return new JObject();
+ }
var content = await File.ReadAllTextAsync(_configPath).ConfigureAwait(false);
- return string.IsNullOrWhiteSpace(content)
- ? new JObject()
- : JsonConvert.DeserializeObject<JObject>(content) ?? new JObject();
+ if (string.IsNullOrWhiteSpace(content))
+ {
+ logger.LogInformation("Config file is empty, starting with empty config");
+ return new JObject();
+ }
+
+ var config = JsonConvert.DeserializeObject<JObject>(content);
+ if (config == null)
+ {
+ logger.LogInformation("Config file is invalid, starting with empty config");
+ return new JObject();
+ }
+
+ var propertyCount = config.Properties().Count();
+ logger.LogInformation(
+ "Loaded config with {Count} top-level sections",
+ propertyCount
+ );
+ return config;
}
catch (Exception ex)
{
@@ -401,6 +422,10 @@ public class ConfigManager(IConfiguration configuration, ILogger<ConfigManager>
if (!File.Exists(configPath))
{
File.WriteAllText(configPath, "{}");
+ global::System.Diagnostics.Trace.TraceInformation(
+ "Created default empty config file: {Path}",
+ configPath
+ );
return;
}
@@ -408,6 +433,10 @@ public class ConfigManager(IConfiguration configuration, ILogger<ConfigManager>
if (string.IsNullOrWhiteSpace(content))
{
File.WriteAllText(configPath, "{}");
+ global::System.Diagnostics.Trace.TraceWarning(
+ "Config file was empty, reset to empty: {Path}",
+ configPath
+ );
return;
}
@@ -416,6 +445,10 @@ public class ConfigManager(IConfiguration configuration, ILogger<ConfigManager>
if (!trimmed.StartsWith('{') || !trimmed.EndsWith('}'))
{
File.WriteAllText(configPath, "{}");
+ global::System.Diagnostics.Trace.TraceWarning(
+ "Config file was not valid JSON, reset to empty: {Path}",
+ configPath
+ );
return;
}
@@ -424,6 +457,10 @@ public class ConfigManager(IConfiguration configuration, ILogger<ConfigManager>
catch
{
File.WriteAllText(configPath, "{}");
+ global::System.Diagnostics.Trace.TraceWarning(
+ "Config file was corrupted, reset to empty: {Path}",
+ configPath
+ );
}
}
}
diff --git a/optimizerDuck/Services/Customize/CustomizeRegistry.cs b/optimizerDuck/Services/Customize/CustomizeRegistry.cs
index 688d3ed..d59f2a1 100644
--- a/optimizerDuck/Services/Customize/CustomizeRegistry.cs
+++ b/optimizerDuck/Services/Customize/CustomizeRegistry.cs
@@ -1,5 +1,6 @@
using System.Collections.ObjectModel;
using System.Reflection;
+using Microsoft.Extensions.Logging;
using optimizerDuck.Common.Helpers;
using optimizerDuck.Domain.Abstractions;
using optimizerDuck.Domain.Attributes;
@@ -10,12 +11,21 @@ namespace optimizerDuck.Services.Customize;
public class CustomizeRegistry
{
+ private readonly ILogger<CustomizeRegistry> _logger;
+
+ public CustomizeRegistry(ILogger<CustomizeRegistry> logger)
+ {
+ _logger = logger;
+ }
+
/// <summary>Gets the registered customize categories. Each category contains its child customize settings. Populated after calling <see cref="RegisterCategories"/>.</summary>
public ICustomizeCategory[] Categories { get; private set; } = [];
/// <summary>Discovers all customize setting categories and their child settings via reflection, then populates <see cref="Categories"/>.</summary>
public void RegisterCategories()
{
+ _logger.LogInformation("Discovering customize setting categories...");
+
var categories = ReflectionHelper
.FindImplementationsInLoadedAssemblies<ICustomizeCategory>()
.Select(t =>
@@ -55,6 +65,12 @@ public class CustomizeRegistry
.ToArray();
Categories = categories;
+
+ _logger.LogInformation(
+ "Registered {CategoryCount} customize categories with {SettingCount} total settings",
+ categories.Length,
+ categories.Sum(c => c.Features.Count)
+ );
}
/// <summary>Builds the navigation items for the UI from the registered categories. Calls <see cref="RegisterCategories"/> if not yet registered.</summary>
diff --git a/optimizerDuck/Services/Optimization/OptimizationService.cs b/optimizerDuck/Services/Optimization/OptimizationService.cs
index 179ff4c..4751dbf 100644
--- a/optimizerDuck/Services/Optimization/OptimizationService.cs
+++ b/optimizerDuck/Services/Optimization/OptimizationService.cs
@@ -152,6 +152,13 @@ public class OptimizationService(
var optLogger = loggerFactory.CreateLogger(optimization.GetType());
using var scope = ExecutionScope.Begin(optimization, optLogger);
+ _logger.LogInformation(
+ "Starting apply of {Name} ({Key}) with ID {Id}",
+ optimization.Name,
+ optimization.OptimizationKey,
+ optimization.Id
+ );
+
progress.Report(
new ProcessingProgress
{
@@ -237,6 +244,13 @@ public class OptimizationService(
CancellationToken cancellationToken = default
)
{
+ _logger.LogInformation(
+ "Starting revert of {Name} ({Key}) with ID {Id}",
+ optimization.Name,
+ optimization.OptimizationKey,
+ optimization.Id
+ );
+
progress?.Report(
new ProcessingProgress
{
diff --git a/optimizerDuck/Services/Optimization/Providers/ShellService.cs b/optimizerDuck/Services/Optimization/Providers/ShellService.cs
index 613230a..e339751 100644
--- a/optimizerDuck/Services/Optimization/Providers/ShellService.cs
+++ b/optimizerDuck/Services/Optimization/Providers/ShellService.cs
@@ -165,13 +165,23 @@ public static class ShellService
if (timedOut)
{
+ ExecutionScope.LogWarning(
+ "Process timed out, attempting to kill: PID {ProcessId}",
+ process.Id
+ );
+
try
{
process.Kill(entireProcessTree: true);
+ ExecutionScope.LogInfo("Killed process: PID {ProcessId}", process.Id);
}
catch (Exception ex)
{
- ExecutionScope.LogError(ex, "Failed to kill process for timeout");
+ ExecutionScope.LogError(
+ ex,
+ "Failed to kill process for timeout (sync), PID: {ProcessId}",
+ process.Id
+ );
}
try
@@ -180,7 +190,11 @@ public static class ShellService
}
catch (Exception ex)
{
- ExecutionScope.LogError(ex, "Failed to wait for process exit after kill");
+ ExecutionScope.LogError(
+ ex,
+ "Failed to wait for process exit after kill (sync), PID: {ProcessId}",
+ process.Id
+ );
}
// Force kill if still running after grace period
@@ -188,6 +202,10 @@ public static class ShellService
{
try
{
+ ExecutionScope.LogWarning(
+ "Process still running after grace period, force killing: PID {ProcessId}",
+ process.Id
+ );
process.Kill(entireProcessTree: true);
if (!process.HasExited)
{
@@ -196,7 +214,11 @@ public static class ShellService
}
catch (Exception ex)
{
- ExecutionScope.LogError(ex, "Failed to force kill process after timeout");
+ ExecutionScope.LogError(
+ ex,
+ "Failed to force kill process after timeout (sync), PID: {ProcessId}",
+ process.Id
+ );
}
}
}
diff --git a/optimizerDuck/Services/Revert/RevertManager.cs b/optimizerDuck/Services/Revert/RevertManager.cs
index a61ccbf..6bc0b41 100644
--- a/optimizerDuck/Services/Revert/RevertManager.cs
+++ b/optimizerDuck/Services/Revert/RevertManager.cs
@@ -207,6 +207,14 @@ public class RevertManager(ILogger<RevertManager> _logger, ILoggerFactory _logge
data.SchemaVersion = SchemaVersion;
await WriteJsonAtomicAsync(filePath, data);
+
+ var totalSteps = data.Steps.Count(s => s != null);
+ _logger.LogInformation(
+ "Upserted revert step at index {Index} for {Id} (total: {Total} steps)",
+ stepIndex,
+ id,
+ totalSteps
+ );
}
finally
{
diff --git a/optimizerDuck/UI/ViewModels/Pages/SettingsViewModel.cs b/optimizerDuck/UI/ViewModels/Pages/SettingsViewModel.cs
index 6062c2b..08eaa62 100644
--- a/optimizerDuck/UI/ViewModels/Pages/SettingsViewModel.cs
+++ b/optimizerDuck/UI/ViewModels/Pages/SettingsViewModel.cs
@@ -253,7 +253,7 @@ public partial class SettingsViewModel(
new SymbolIcon { Symbol = SymbolRegular.ErrorCircle24, Filled = true },
TimeSpan.FromSeconds(5)
);
- logger.LogError(ex, "Failed to open page");
+ logger.LogWarning(ex, "Failed to open page");
}
}