如何在运行时使用 NLog 获取当前目标文件的路径？

Question

我在下一个配置中使用 NLog：

  <targets>
    <target xsi:type="File" name="f" fileName="${basedir}/logs/${shortdate}.log"
            layout="${longdate} ${uppercase:${level}} ${message}" />
  </targets>
  <rules>
    <logger name="*" minlevel="Trace" writeTo="f" />
  </rules>

我试图获取FileTarget的FileName属性（我检查过，集合中只有一个 FileTarget）

NLog.LogManager.GetCurrentClassLogger().Info("test");
var logFile = (from t in NLog.LogManager.Configuration.AllTargets
                where t is NLog.Targets.FileTarget
                select (NLog.Targets.FileTarget)t).FirstOrDefault();

但是 logFile.FileName 只包含文件名的模式，正是它在设置中指定的方式。

如何获取当前日志文件的运行时路径？

Answer 1

这对我有用：

var fileTarget = (FileTarget) LogManager.Configuration.FindTargetByName("file");
// Need to set timestamp here if filename uses date. 
// For example - filename="${basedir}/logs/${shortdate}/trace.log"
var logEventInfo = new LogEventInfo {TimeStamp = DateTime.Now}; 
string fileName = fileTarget.FileName.Render(logEventInfo);
if (!File.Exists(fileName))
    throw new Exception("Log file does not exist.");

Answer 2

即使您在NLog XML配置中设置了async="true" （即您的目标由AsyncTargetWrapper包装），此方法也会起作用：

    private string GetLogFileName(string targetName)
    {
        string fileName = null;

        if (LogManager.Configuration != null && LogManager.Configuration.ConfiguredNamedTargets.Count != 0)
        {
            Target target = LogManager.Configuration.FindTargetByName(targetName);
            if (target == null)
            {
                throw new Exception("Could not find target named: " + targetName);
            }

            FileTarget fileTarget = null;
            WrapperTargetBase wrapperTarget = target as WrapperTargetBase;

            // Unwrap the target if necessary.
            if (wrapperTarget == null)
            {
                fileTarget = target as FileTarget;
            }
            else
            {
                fileTarget = wrapperTarget.WrappedTarget as FileTarget;
            }

            if (fileTarget == null)
            {
                throw new Exception("Could not get a FileTarget from " + target.GetType());
            }

            var logEventInfo = new LogEventInfo { TimeStamp = DateTime.Now };
            fileName = fileTarget.FileName.Render(logEventInfo);
        }
        else
        {
            throw new Exception("LogManager contains no Configuration or there are no named targets");
        }

        if (!File.Exists(fileName))
        {
            throw new Exception("File " + fileName + " does not exist");
        }

        return fileName;
    }

Answer 3

目标可以被多次包装（在我的情况下我有一个过滤器），因此下面的代码片段是一种更通用的解包方法，适用于多个级别，并且不会对目标名称进行假设。

Target target = LogManager.Configuration.FindTargetByName(targetName);
while ((target != null) && (target is WrapperTargetBase))
{
    target = (target as WrapperTargetBase).WrappedTarget;
}

Answer 4

这里有一些对我有用的稍微简化的实现——至少对于较新版本的 .Net/NLog 是这样。

如果你只有一个 FileTarget 并且你没有任何异步包装它并且只想要一个简单的文件名：

var file = LogManager.Configuration?.AllTargets.OfType<FileTarget>()
    .Select(x => x.FileName.Render(LogEventInfo.CreateNullEvent()))
    .FirstOrDefault(x => !string.IsNullOrWhiteSpace(x));
Console.WriteLine($"Logging to file: {file}");

Output：

Logging to file: C:\MyApp\logs\2022-05-04.log

或者，这里有一个方法也可以解包异步和缓冲目标：

public static IEnumerable<string> GetNLogFileTargets()
{
    var allTargets = LogManager.Configuration?.AllTargets;
    if (allTargets == null)
    {
        return Enumerable.Empty<string>();
    }

    var wrappedFileTargets = allTargets.OfType<WrapperTargetBase>()
        .Where(x => x.WrappedTarget is FileTarget)
        .Select(x => x.WrappedTarget).Cast<FileTarget>();
    var fileTargets = allTargets.OfType<FileTarget>().Concat(wrappedFileTargets);
    return fileTargets.Select(x => x.FileName.Render(LogEventInfo.CreateNullEvent())).Where(x => !string.IsNullOrWhiteSpace(x));
}

Answer 5

我知道我的答案并没有完全回答这个问题，但最困难的事情是找到合适的目标并正确投射，然后我们就可以访问任何属性了。 我也没有找到适合我答案的问题，因此在这里张贴......

即使您在NLog XML配置中设置了async="true" （即您的目标由AsyncTargetWrapper或任何TargetWrapper包装），此方法也会起作用：

使用NLog版本：3.1.0.0

运行时版本：v4.0.30319

    private Target FindTargetByName(string targetName)
    {
        if (LogManager.Configuration == null)
            return null;

        Target t = LogManager.Configuration.FindTargetByName(targetName);

        if (t is NLog.Targets.Wrappers.WrapperTargetBase)
        {
            var list = LogManager.Configuration.AllTargets.ToList();
            t = list.Find(x => x.Name == targetName + "_wrapped");
            return t;
        }
        else
        {
            return t;
        }
    }

用于名为emailError的MailTarget

var emailError = (MailTarget)FindTargetByName("emailError");
emailError.SmtpServer = "" //you can set or get

Answer 6

这将返回“测试”目标的当前日志文件的路径。 如果还没有文件，将抛出 NUllReferenceException。

  /// <exception cref="NullReferenceException"></exception>
        public static string GetCurrentDebugLogFilePath()
        {
            return (LogManager.Configuration.FindTargetByName("test") as FileTarget).FileName.Render(new LogEventInfo { TimeStamp = DateTime.Now });
        }