如何以编程方式更改文件位置?


75

我对Log4net完全陌生。我设法通过添加配置文件和简单的日志记录来解决问题。我已经将值硬编码为,"C:\temp\log.txt"但这还不够好。

日志必须转到特殊文件夹

path = Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData);

并且此路径会根据您使用的是Windows Server 2008,Windows XP还是Vista等而改变...

如何仅以编程方式更改log4net中文件的位置?

这是我所做的:

<configSections>
<section name="log4net"
         type="log4net.Config.Log4NetConfigurationSectionHandler,Log4net"/>
</configSections>
<log4net>         
    <root>
        <level value="DEBUG" />
        <appender-ref ref="LogFileAppender" />
    </root>
    <appender name="LogFileAppender" type="log4net.Appender.RollingFileAppender">
        <param name="File" value="C:\temp\log.txt" />
        <param name="AppendToFile" value="true" />
        <rollingStyle value="Size" />
        <maxSizeRollBackups value="10" />
        <maximumFileSize value="10MB" />
        <staticLogFileName value="true" />
        <layout type="log4net.Layout.PatternLayout">
            <param name="ConversionPattern" value="%-5p%d{yyyy-MM-dd hh:mm:ss} – %m%n" />
        </layout>
    </appender>
</log4net>

class Program
{
    protected static readonly ILog log = LogManager.GetLogger(typeof(Program));

    static void Main(string[] args)
    {
        log4net.Config.XmlConfigurator.Configure();
        log.Warn("Log something");

        path = Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData);


        // How can I change where I log stuff?
    }
}

只需弄清楚如何更改即可将内容记录到我想要的位置。

有什么建议?非常感谢


您需要挖掘记录器的IAppender,并将FileAppender.File设置为所需的输出路径。这是一个很好的例子
凸轮索珀

Answers:


89

log4net可以为您解决这个问题。在这种情况下,可以使用log4net.Util.PatternString选项处理程序格式化字符串类型的任何appender属性。PatternString甚至支持SpecialFolder枚举,该枚举启用以下优雅的配置:

<appender name="LogFileAppender" type="log4net.Appender.RollingFileAppender" >
    <file type="log4net.Util.PatternString" 
        value="%envFolderPath{CommonApplicationData}\\test.txt" />
    ...
</appender>

这是证明布丁的单元测试:

[Test]
public void Load()
{
    XmlConfigurator.Configure();
    var fileAppender = LogManager.GetRepository()
        .GetAppenders().First(appender => appender is RollingFileAppender);

    var expectedFile = 
        Path.Combine(
            Environment.GetFolderPath(
                Environment.SpecialFolder.CommonApplicationData),
                "test.txt");

    Assert.That(fileAppender, 
        Is.Not.Null & Has.Property("File").EqualTo(expectedFile));
}

以下测试将验证log4net实际上是否已写入磁盘(这基本上使该测试成为“集成”测试,而不是单元测试,但我们暂时将其保留):

[Test]
public void Log4net_WritesToDisk()
{
    var expectedFile = 
        Path.Combine(
            Environment.GetFolderPath(
                Environment.SpecialFolder.CommonApplicationData),
                "test.txt");

    if (File.Exists(expectedFile))
        File.Delete(expectedFile);

    XmlConfigurator.Configure();

    var log = LogManager.GetLogger(typeof (ConfigTest));
    log.Info("Message from test");

    LogManager.Shutdown();

    Assert.That(File.ReadAllText(expectedFile), 
        Text.Contains("Message from test"));
}

注意:我强烈建议使用上面示例中演示的紧凑属性语法。删除所有这些“ <property name =“”可以使您的配置更具可读性。


1
嗨,谢谢,我已经尝试过此操作,但仍无法登录应用程序数据。我在网上浏览了一下,发现了一个叫做PatternString的东西,但我不知道如何使用它。有人举榜吗?

@brix-我最初的答案没有用,所以我不得不向自己证明log4net可以做到这一点。PatternString是解决方案:)
Peter Lillevold

2
%envFolderPath {}似乎不是当前(1.2.10)版本的log4net的一部分。我必须从他们的Subversion存储库中拉出r606477才能启用此非常有用的功能。我希望它会包含在下一个(1.2.11)版本中。
罗德尼·舒勒2009年

1
@rschuler:我添加了一个适用于1.2.10的答案,请参见下文
codeulike 2010年

3
从下面的@JackAce答案中,重置文件路径后,请确保调用“ .ActivateOptions()”以使其激活。调用.file会设置它,但是直到ActivateOptions调用它才会使用
Jeffrey Knight

46

我在互连网上发现了以下代码的变种:

XmlConfigurator.Configure();
log4net.Repository.Hierarchy.Hierarchy h =
(log4net.Repository.Hierarchy.Hierarchy) LogManager.GetRepository();
foreach (IAppender a in h.Root.Appenders)
{
    if (a is FileAppender)
    {
        FileAppender fa = (FileAppender)a;
        // Programmatically set this to the desired location here
        string logFileLocation = @"C:\MySpecialFolder\MyFile.log";

        // Uncomment the lines below if you want to retain the base file name
        // and change the folder name...
        //FileInfo fileInfo = new FileInfo(fa.File);
        //logFileLocation = string.Format(@"C:\MySpecialFolder\{0}", fileInfo.Name);

        fa.File = logFileLocation;
        fa.ActivateOptions();
        break;
    }
}

这对我有用。我们的应用程序需要将日志文件放在包含基于AssemblyInfo.cs文件的应用程序版本号的文件夹中。

您应该能够以编程方式设置logFileLocation(例如,如果这是一个Web应用程序,则可以使用Server.MapPath())来满足您的需求。


4
我觉得这样可以更好地控制文件位置。
fregas 2012年

16

似乎Peter的答案不适用于Log4net v1.2.10.0。这里介绍一种替代方法。

基本上,该方法是为log4net配置文件实现自定义模式转换器。

首先将此类添加到您的项目中:

public class SpecialFolderPatternConverter : log4net.Util.PatternConverter
{
    override protected void Convert(System.IO.TextWriter writer, object state)
    {
        Environment.SpecialFolder specialFolder = (Environment.SpecialFolder)Enum.Parse(typeof(Environment.SpecialFolder), base.Option, true);
        writer.Write(Environment.GetFolderPath(specialFolder));
    }
}

然后,按如下所示设置FileAppender的File参数:

<file type="log4net.Util.PatternString">
    <converter>
      <name value="folder" />
      <type value="MyAppName.SpecialFolderPatternConverter,MyAppName" />
    </converter>
    <conversionPattern value="%folder{CommonApplicationData}\\SomeOtherFolder\\log.txt" />
  </file>

基本上,%folder它告诉它查看所调用的转换器,该转换器将folder其指向SpecialFolderPatternConverter类。然后Convert,它调用该类,并传入CommonApplicationData(或其他)枚举值。


感谢那。顺便说一句,我认为MyAppName中的App是指Project而不是App。
Jamie Kitson

这是,如果你正在看的变化log4net.config文件(唯一可行的选择logging.apache.org/log4net/release/sdk/html/...
CBP

7

一个简单的怎么样:

XmlConfigurator.LogFullFilename = @"c:\ProgramData\MyApp\Myapp.log";

为什么做一件非常简单的事情如此复杂?


12
因为,路径会根据您是Windows Server 2008,winxp还是vista等而改变。在XP中,没有c:\ ProgramData文件夹,仅在Win7 / Vista中。因此,如果我们要部署此应用程序,则它必须与所有操作系统兼容。:-)硬编码不是一个好习惯。
伊尔沙德(Irshad)

7
我正在使用log4net v2.0.3,并且XmlConfigurator上没有此属性。自发布答案以来,必须已将其删除。
Appetere

感谢Jason纠正我的英语,这不是我的主要语言;)谢谢!
埃里克

@Irshad:是的,但是我们可以从数据库中读取配置(例如)。如果我们可以通过编程更改此路径,有时它的更好
晃龙

4

这对我有用:

  <log4net>
    <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
..
      <file value="${APPDATA}\MyApp\MyApp Client\logs\Log.txt"/>
..
  </log4net>

如果需要写特殊文件夹,我可以在这里找到帮助(第二个和第三个示例)。

编辑:

要回答OP。这适用于“所有用户”区域:

      ...
      <file value="${ALLUSERSPROFILE}\MyApp\MyApp Client\logs\Log.txt"/>
      ...

在Windows的较新版本中,通常为“ C:\ ProgramData”。

也请参见以下内容:
如何为log4net指定通用应用程序数据文件夹?== https://stackoverflow.com/a/1889591/503621和评论

https : //superuser.com/q/405097/47628
https://stackoverflow.com/a/5550502/503621


Environment.SpecialFolder.CommonApplicationData$(APPDATA)不是同一文件夹
塞巴斯蒂安·内格拉苏斯

您也可以尝试使用“ $ {ALLUSERSPROFILE}”。。
bshea

3

也要更改错误日志的路径(基于JackAce的回答):

private static void SetLogPath(string path, string errorPath)
{
    XmlConfigurator.Configure();
    log4net.Repository.Hierarchy.Hierarchy h =
    (log4net.Repository.Hierarchy.Hierarchy)LogManager.GetRepository();
    foreach (var a in h.Root.Appenders)
    {
        if (a is log4net.Appender.FileAppender)
        {
            if (a.Name.Equals("LogFileAppender"))
            { 
                log4net.Appender.FileAppender fa = (log4net.Appender.FileAppender)a;                    
                string logFileLocation = path; 
                fa.File = logFileLocation;                   
                fa.ActivateOptions();
            }
            else if (a.Name.Equals("ErrorFileAppender"))
            {
                log4net.Appender.FileAppender fa = (log4net.Appender.FileAppender)a;
                string logFileLocation = errorPath;
                fa.File = logFileLocation;
                fa.ActivateOptions();
            }
        }
    }
}

3

JackAce的答案,使用Linq更为简洁:

C#

XmlConfigurator.Configure();
var appender = (LogManager.GetRepository() as Hierarchy).Root.Appenders
    .OfType<FileAppender>()
    .First();

appender.File = logPath;
appender.ActivateOptions();

VB.NET

XmlConfigurator.Configure()
Dim appender = CType(LogManager.GetRepository(), Hierarchy).Root.Appenders _
    .OfType(FileAppender)() _
    .First()

appender.File = logPath
appender.ActivateOptions()

2

LINQOfType<T>过滤器的绝佳用例:

/// <summary>
/// Applies a transformation to the filenames of all FileAppenders.
/// </summary>
public static void ChangeLogFile(Func<string,string> transformPath)
{
    // iterate over all FileAppenders
    foreach (var fileAppender in LogManager.GetRepository().GetAppenders().OfType<FileAppender>())
    {
        // apply transformation to the filename
        fileAppender.File = transformPath(fileAppender.File);
        // notify the logging subsystem of the configuration change
        fileAppender.ActivateOptions();
    }
}

如果app.config中的文件名是,log.txt则将日志输出更改为logs/some_name_log.txt

ChangeLogFile(path => Path.Combine("logs", $"some_name_{Path.GetFileName(path)}"));

回答OP的原始问题是:

ChangeLogFile(path => Path.Combine(
    Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData), path));

当我这样做时,它只是简单地用新名称重新创建了一个空文件,但随后Logger.GetLogger继续写入旧名称。
杰伊·沙利文

1

作为以编程方式执行此操作的替代方法,可以在配置文件中使用环境变量和可自定义的模式。 看到这个回答类似的问题

Log4Net V1.2.10发行说明中查看“用于基于模式的配置的PatternString” 。

另外,如果您打算写入诸如Enviroment.SpecialFolder.CommonApplicationData之类的目录,则需要考虑以下事项:

  • 所有用户的应用程序实例是否都具有对该日志文件的写访问权限?例如,我不相信非管理员用户将无法写入Enviroment.SpecialFolder.CommonApplicationData。

  • 如果您的应用程序的多个实例(针对相同或不同的用户)正在尝试访问同一文件,则争用。您可以使用“最小锁定模型”(请参见http://logging.apache.org/log4net/release/config-examples.html允许多个进程写入同一日志文件,但可能会对性能产生影响。或者,您可以为每个进程提供不同的日志文件,例如,使用可自定义的模式在文件名中包含进程ID。


1

在当前版本的Log4Net(2.0.8.0)中,您可以简单地<file value="${ProgramData}\myFolder\LogFiles\" />用于C:\ProgramData\..${LocalAppData}用于C:\Users\user\AppData\Local\


0

如果必须部署到未知系统,并且即使在不同的特殊文件夹下也要使用Philipp M的简单解决方案,则可以在加载log4net配置之前检索所需的特殊文件夹路径并设置自定义env变量。 string localData = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData); Environment.SetEnvironmentVariable("MY_FOLDER_DATA", localData); XmlConfigurator.Configure( ...

...只是为了确保env变量存在并具有所需的值。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.