如何使用 Sustainsys.Saml2 设置 NLog

Question

我有一个 ASP.Net Web 表单应用程序，我刚刚在其中集成了 Sustainsys.Saml2 库。

我从未使用过任何类型的日志记录机制，我正试图弄清楚如何为其troubleshooting 页面上所述的库添加或创建ILoggerAdapter。

我已经决定使用 NLog（请随意推荐一个不同的），或者我不太了解这一点，或者没有使用正确的关键字来搜索我需要/想要的内容，或者他们不是有很多关于它的文档。

目前，我使用的是HttpModule 版本的Sustainsys.Saml2。根据要求提供的任何其他信息。

任何帮助都会很棒。

目前，我正在通过 web.config 和 global.asax 文件配置 Sustainsys.Saml2 库。这是我 global.asax 调用的类：

public class Saml2Config {
    private static bool _alreadyInitialized;
    private static readonly object Lock = new object();

    public static void Initialize() {
        if (_alreadyInitialized) {
            return;
        }

        lock (Lock) {
            if (_alreadyInitialized) {
                return;
            }

            var domain = PageHelper.GetDomainURL(true);

            Sustainsys.Saml2.Configuration.Options.FromConfiguration.SPOptions.EntityId.Id = $"{domain}/federation/Saml2";
            Sustainsys.Saml2.Configuration.Options.FromConfiguration.SPOptions.ModulePath = "/federation/Saml2";
            Sustainsys.Saml2.Configuration.Options.FromConfiguration.SPOptions.ReturnUrl = new Uri($"{domain}/mybarry");
            Sustainsys.Saml2.Configuration.Options.FromConfiguration.SPOptions.PublicOrigin = new Uri($"{domain}");

            Sustainsys.Saml2.Configuration.Options.FromConfiguration.SPOptions.Logger = new NullLoggerAdapter();

            _alreadyInitialized = true;
        }
    }
}

Answer 1

The interface 非常简单

public interface ILoggerAdapter
{
    void WriteInformation(string message);

    void WriteError(string message, Exception ex);

    void WriteVerbose(string message);
}

我会按如下方式实现：

public class NLogAdapter : ILoggerAdapter
{
    private static Logger Logger = LogManager.GetLogger("Saml2");

    public void WriteInformation(string message)
    {
        Logger.Info(message);
    }

    public void WriteError(string message, Exception ex)
    {
        Logger.Error(ex, message);
    }

    public void WriteVerbose(string message)
    {
        Logger.Debug(message);
    }
}

最后设置它：

Sustainsys.Saml2.Configuration.Options.FromConfiguration.SPOptions.Logger = new NLogAdapter();

Answer 2

ILoggerAdapter 包含不同日志级别的方法。创建一个实现ILoggerAdapter 并写入NLog 的适配器类。然后将SPOptions.Logger 设置为您的适配器类的一个实例。

如果您想要一个示例，您可以查看 Asp.Net Core 的适配器，该适配器记录到 Asp.Net Core 日志系统，它是 Sustainsys.Saml2.AspNetCore2 包的默认设置：https://github.com/Sustainsys/Saml2/blob/master/Sustainsys.Saml2.AspNetCore2/AspNetCoreLoggerAdapter.cs

对于Sustainsys.Saml2.HttpModule 库，默认值为NullLoggerAdapter，它只是丢弃所有日志。使用它的唯一原因是不必在任何使用它的地方对 Logger 属性进行空检查（该代码是在引入 ?. 语法之前编写的。）