如何以编程方式更改文件位置?
我对Log4net完全陌生。
我已经设法通过添加configuration文件和简单的日志logging来进行一些操作。
我已经硬编码的值是"C:\temp\log.txt"
但是这不够好。
日志必须转到特殊文件夹
path = Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData);
并且此path会根据您使用的是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? } }
只需要弄清楚如何改变日志到我想要的地方。
有什么build议么? 非常感谢
log4net可以为你处理。 任何string的appender属性都可以被格式化,在这种情况下,使用log4net.Util.PatternString选项处理程序。 PatternString甚至支持SpecialFolder枚举,它使下面的优雅configuration成为可能:
<appender name="LogFileAppender" type="log4net.Appender.RollingFileAppender" > <file type="log4net.Util.PatternString" value="%envFolderPath{CommonApplicationData}\\test.txt" /> ... </appender>
这是一个certificate布丁的unit testing:
[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)); }
下面的testingvalidation了log4net实际上写入磁盘(基本上这是一个“集成”testing,而不是unit testing,但现在我们暂且不谈):
[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")); }
注意:我强烈build议使用上面示例中演示的compact属性语法。 删除所有这些“<property name =”使您的configuration更具可读性。
我在interwebs中发现了这个代码的一个变种:
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())来满足您的需求。
看起来彼得的答案不适用于Log4net v1.2.10.0。 这里介绍另一种方法。
基本上这个方法是为log4netconfiguration文件实现一个自定义模式转换器。
首先将这个类添加到你的项目中:
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(或其他)枚举值。
如何简单:
XmlConfigurator.LogFullFilename = @"c:\ProgramData\MyApp\Myapp.log";
为什么做一个非常简单的事情是如此复杂?
这对我工作:
<log4net> <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender"> .. <file value="${APPDATA}\MyApp\MyApp Client\logs\Log.txt"/> .. </log4net>
如果需要写入特殊文件夹,我在这里find了帮助(第二和第三个例子)。
编辑:
回答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
也要更改错误日志的path(基于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(); } } } }
作为以编程方式执行此操作的替代方法,您可以在configuration文件中使用环境variables和可自定义的模式。 看到这个回答类似的问题 。
在Log4Net V1.2.10发行说明中查看“PatternString for pattern based configuration”。
另外,如果您正在考虑写入诸如Enviroment.SpecialFolder.CommonApplicationData之类的目录,则需要考虑:
-
所有用户的应用程序的所有实例是否都具有写入日志文件的权限? 例如我不相信非pipe理员将能够写入Enviroment.SpecialFolder.CommonApplicationData。
-
如果您的应用程序的多个实例(针对相同或不同的用户)试图访问相同的文件,则为争用。 您可以使用“最小locking模型”(请参阅http://logging.apache.org/log4net/release/config-examples.html),以允许多个进程写入相同的日志文件,但可能会对性能产生影响。或者你可以给每个进程一个不同的日志文件,例如通过使用可定制的模式在文件名中包含进程ID。;
如果您必须部署到未知系统,并且想要使用Philipp M的简单解决scheme,甚至可以使用不同的特殊文件夹,则可以在加载log4netconfiguration之前检索所需的特殊文件夹path并设置自定义envvariables。 string localData = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData); Environment.SetEnvironmentVariable("MY_FOLDER_DATA", localData); XmlConfigurator.Configure( ...
…只是为了确保envvariables存在并具有您想要的值。
LINQ的OfType OfType<T>
filter的很好的用例:
/// <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));