如何使用App.config和System.Diagnostics动态设置日志文件?

时间:2012-10-10 00:52:26

标签: c# logging app-config system.diagnostics

当我看到一篇文章(http://www.daveoncsharp.com/2009/09/create-a-logger-using-the-trace-listener-in-csharp/)谈到使用System.Diagnostics和App.config通过Trace方法记录时,我一直在寻找一种解决方案来提供我最新项目的日志记录。我能够成功实现类和App.config,但我真的希望能够动态分配日志文件的值/位置(在initializeData内),我不知道如何做到这一点。如果您有任何建议,请随时发布!

App.config中:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <system.diagnostics>
    <trace autoflush="true" indentsize="4">
      <listeners>
        <add name="myListener" 
             type="System.Diagnostics.TextWriterTraceListener" 
             initializeData="fileSizeThreshold=512, fileSizeUnit=kilobytes, 
             fileAgeThreshold=1, fileAgeUnit=months, fileNameTemplate='{0}\MyApp-{1:MMM-yy}.log'"/>
        <remove name="Default" />
      </listeners>
    </trace>
  </system.diagnostics>
</configuration>

记录器类:

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Text;


namespace MyCurrentProject
{
    class Logger
    {
        public void Error(string module, string message)
        {
            WriteEntry(message, "ERROR:", module);
        }

        public void Error(Exception ex, string module)
        {
            WriteEntry(ex.Message, "ERROR:", module);
        }

        public void Warning(string module, string message)
        {
            WriteEntry(message, "WARNING:", module);
        }

        public void Info(string module, string message)
        {
            WriteEntry(message, "INFO:", module);
        }

        private void WriteEntry(string message, string type, string module)
        {
            Trace.WriteLine(
                    string.Format("{0} {1} [{2}] {3}",
                                  DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"),
                                  type,
                                  module,
                                  message));
        }
    }
}

RE:抱歉不清楚...为了清楚,我需要保存日志文件输出的文件路径以进行动态设置。我想要保存到%AppData%中的位置的路径。我对配置的问题是,一旦我设置'initializeData'的值,我就找不到改变或动态设置/重置该值的方法。说实话......此时我只想要一个有效的解决方案,并允许我管理日志文件的位置。

2 个答案:

答案 0 :(得分:6)

这是一个使用Systems.Diagnostics的工作示例,它比非基类库有两个优点。它始终是允许的(在大型组织中),始终可用,并且在开发人员熟悉基类库的情况下,下一批维护开发人员将听说过它。

using System.Diagnostics;

namespace DynamicTraceLog
{
    class Program
    {
        static void Main(string[] args)
        {
            //Use TraceSource, not Trace, they are easier to turn off
            TraceSource trace = new TraceSource("app");
            //SourceSwitches allow you to turn the tracing on and off.
            SourceSwitch level =new SourceSwitch("app");
            //I assume you want to be dynamic, so probalby some user input would be here:
            if(args.Length>0 && args[0]=="Off")
                level.Level= SourceLevels.Off;
            else
                level.Level = SourceLevels.Verbose;
            trace.Switch = level;
            //remove default listner to improve performance
            trace.Listeners.Clear();
            //Listeners implement IDisposable
            using (TextWriterTraceListener file = new TextWriterTraceListener("log.txt"))
            using (ConsoleTraceListener console = new ConsoleTraceListener())
            {
                //The file will likely be in /bin/Debug/log.txt
                trace.Listeners.Add(file);
                //So you can see the results in screen
                trace.Listeners.Add(console);
                //Now trace, the console trace appears immediately.
                trace.TraceInformation("Hello world");
                //File buffers, it flushes on Dispose or when you say so.
                file.Flush();
            }
            System.Console.ReadKey();
        }
    }
}

Re:如何格式化输出 尝试使用Systems.Diagnostics类实现模板化跟踪格式化/输出的跟踪侦听器中的任何一个: http://essentialdiagnostics.codeplex.comhttp://ukadcdiagnostics.codeplex.com/ Systems.Diagnostics不提供标准令牌的任何特定格式化或输出。

答案 1 :(得分:1)

我知道我可能会为此投票,但我要离开牧场一会儿,我建议你使用工具箱中的其他工具。 Log4Net是一个非常强大而简洁的日志框架。例如,下面是一个使用它的控制台应用程序,它可以完全正常运行。

using Com.Foo;

// Import log4net classes.
using log4net;
using log4net.Config;

public class MyApp 
{
    // Define a static logger variable so that it references the
    // Logger instance named "MyApp".
    private static readonly ILog log = LogManager.GetLogger(typeof(MyApp));

    static void Main(string[] args) 
    {
        // Set up a simple configuration that logs on the console.
        BasicConfigurator.Configure();

        log.Info("Entering application.");
        Bar bar = new Bar();
        bar.DoIt();
        log.Info("Exiting application.");
    }
}

但是,假设我们想要使用配置文件,就像你暗示你想要使用它一样。 嗯,这很直接!以下是我们在App.config中完成同样事情的配置:

<log4net>
    <!-- A1 is set to be a ConsoleAppender -->
    <appender name="A1" type="log4net.Appender.ConsoleAppender">

        <!-- A1 uses PatternLayout -->
        <layout type="log4net.Layout.PatternLayout">
            <conversionPattern value="%-4timestamp [%thread] %-5level %logger %ndc - %message%newline" />
        </layout>
    </appender>

    <!-- Set root logger level to DEBUG and its only appender to A1 -->
    <root>
        <level value="DEBUG" />
        <appender-ref ref="A1" />
    </root>
</log4net>

然后可以像这样使用该配置:

using Com.Foo;

// Import log4net classes.
using log4net;
using log4net.Config;

public class MyApp 
{
    private static readonly ILog log = LogManager.GetLogger(typeof(MyApp));

    static void Main(string[] args) 
    {
        // BasicConfigurator replaced with XmlConfigurator.
        XmlConfigurator.Configure(new System.IO.FileInfo(args[0]));

        log.Info("Entering application.");
        Bar bar = new Bar();
        bar.DoIt();
        log.Info("Exiting application.");
    }
}

不要让模式的东西让你措手不及,它只是配置你上面编码的内容,这样你就可以在消息中保持一致。它确实很容易,因为你需要记录的只是需要插入模式的信息,然后将模式封装起来。


这是Log4Net中的速成课程,但我之所以推荐它是因为在上面的两个例子中你看到他们登录到控制台,但你有无数可能的记录器,只看这个列表:

log4net.Appender.AdoNetAppender :使用预准备语句或存储过程将日志记录事件写入数据库。

log4net.Appender.AnsiColorTerminalAppender :将颜色突出显示的记录事件写入ANSI终端窗口。

log4net.Appender.AspNetTraceAppender :将日志记录事件写入ASP跟踪上下文。然后可以在ASP页面的末尾或ASP跟踪页面上呈现它们。

log4net.Appender.ColoredConsoleAppender :将颜色突出显示的日志记录事件写入应用程序的Windows控制台。

log4net.Appender.ConsoleAppender :将日志记录事件写入应用程序的控制台。事件可以是标准流或标准错误流。

log4net.Appender.DebugAppender :将日志记录事件写入.NET系统。

log4net.Appender.EventLogAppender :将日志记录事件写入Windows事件日志。

log4net.Appender.FileAppender :将日志记录事件写入文件系统中的文件。

log4net.Appender.LocalSyslogAppender :将日志记录事件写入本地syslog服务(仅限UNIX)。

log4net.Appender.MemoryAppender :将记录事件存储在内存缓冲区中。

log4net.Appender.NetSendAppender :将日志记录事件写入Windows Messenger服务。这些消息显示在用户终端的对话框中。

log4net.Appender.OutputDebugStringAppender :将日志记录事件写入调试器。如果应用程序没有调试器,系统调试器将显示该字符串。如果应用程序没有调试器且系统调试器未处于活动状态,则忽略该消息。

log4net.Appender.RemoteSyslogAppender :使用UDP网络将日志记录事件写入远程syslog服务。

log4net.Appender.RemotingAppender :使用.NET远程处理将记录事件写入远程接收器。

log4net.Appender.RollingFileAppender :将日志记录事件写入文件系统中的文件。 RollingFileAppender可以配置为根据日期或文件大小限制记录到多个文件。

log4net.Appender.SmtpAppender :将记录事件发送到电子邮件地址。

log4net.Appender.SmtpPickupDirAppender :将日志记录事件发送到电子邮件地址,但将电子邮件写入可配置目录,而不是直接通过SMTP发送。

log4net.Appender.TelnetAppender :客户端通过Telnet连接以接收日志记录事件。

log4net.Appender.TraceAppender :将日志记录事件写入.NET跟踪系统。

log4net.Appender.UdpAppender :使用UdpClient将记录事件作为无连接UDP数据报发送到远程主机或多播组。


所以,正如你所看到的,它是非常强大的OOB。我希望这篇文章有所帮助。