troubleshooting/debugging

[giscus[bot]]

troubleshooting/debugging

Find or configure application logs to find runtime issues.

https://docs.velopack.io/troubleshooting/debugging

[A9G-Data-Droid]

This documentation doesn't appear to match version 0.0.1298

1. VelopackApp.Run(ILogger) doesn't exist, the Run method takes no arguments.
2. UpdateManager doesn't accept a logger argument either.
3. public VelopackApp SetLogger(IVelopackLogger logger) appears to be the correct way to do it now but it expects a IVelopackLogger, which I don't know how to make one of those from my ILogger

[Keboo]

Thank you, Fixed!

[A9G-Data-Droid]

Previously the documentation said we could use a generic Microsoft ILogger and that is ideal for interop with all of the various logging libraries. Instead of everyone writing their own custom log adapter for Velopack, a generic ILogger implementation could be provided as a reference implementation.

I offer mine so that anyone can get started right away. Let me know if this is something that should be included in the main project and I can open a PR.

using System;
using Microsoft.Extensions.Logging;
using Velopack.Logging;

public class VelopackLoggerAdapter(ILogger logger) : IVelopackLogger
{
    private const string? Velopack = "Velopack";

    private static readonly Action<ILogger, string, Exception?> s_logTrace =
        LoggerMessage.Define<string>(LogLevel.Trace, new EventId((int)LogLevel.Trace, Velopack), "Velopack: {Message}");

    private static readonly Action<ILogger, string, Exception?> s_logDebug =
        LoggerMessage.Define<string>(LogLevel.Debug, new EventId((int)LogLevel.Debug, Velopack), "Velopack: {Message}");

    private static readonly Action<ILogger, string, Exception?> s_logInfo =
        LoggerMessage.Define<string>(LogLevel.Information, new EventId((int)LogLevel.Information, Velopack), "Velopack: {Message}");

    private static readonly Action<ILogger, string, Exception?> s_logWarning =
        LoggerMessage.Define<string>(LogLevel.Warning, new EventId((int)LogLevel.Warning, Velopack), "Velopack: {Message}");

    private static readonly Action<ILogger, string, Exception?> s_logError =
        LoggerMessage.Define<string>(LogLevel.Error, new EventId((int)LogLevel.Error, Velopack), "Velopack: {Message}");

    private static readonly Action<ILogger, string, Exception?> s_logCritical =
        LoggerMessage.Define<string>(LogLevel.Critical, new EventId((int)LogLevel.Critical, Velopack), "Velopack: {Message}");

    public void Log(VelopackLogLevel logLevel, string? message, Exception? exception = null)
    {
        if (message is null && exception is null) return;

        string safeMessage = message ?? string.Empty;

        switch (logLevel)
        {
            case VelopackLogLevel.Debug:
                s_logDebug(logger, safeMessage, exception);
                break;
            case VelopackLogLevel.Information:
                s_logInfo(logger, safeMessage, exception);
                break;
            case VelopackLogLevel.Warning:
                s_logWarning(logger, safeMessage, exception);
                break;
            case VelopackLogLevel.Error:
                s_logError(logger, safeMessage, exception);
                break;
            case VelopackLogLevel.Critical:
                s_logCritical(logger, safeMessage, exception);
                break;
            case VelopackLogLevel.Trace:
            default:
                s_logTrace(logger, safeMessage, exception);
                break;
        }
    }
}

[caesay]

I would love to provide an adapter, but the reason we no longer use a Microsoft ILogger in the core project is we cannot have a dependency on that library. We target legacy NetFramework TFM's, and because Microsoft.Extensions.Logging references System.Memory etc it's a huge dependency. At some point I'd like to provide a separate library/assembly e.g. Velopack.Extensions.Logging or something like that, and have adapters and easy extension methods to register it there. Until we spin out a new library this won't be possible to include in the project.