TriDevs.TriEngine.Logging.LogManager Class Reference

Class to manage logging. ILog interfaces should be obtained from this class' methods, as opposed to calling default log4net methods. More...

Static Public Member Functions
static void	LoadConfig (string file=null)
	Load a config to use with log4net. More...
static ILog	GetLogger (object sender)
	Gets an ILog object for the specified object. More...
static void	SetupConsole ()
	Set up a new console for this process. Will not set up a console if a debugger is attached. This method does nothing if DEBUG is not #defined. More...
static void	DestroyConsole ()
	Destroys the console associated with the process, if loaded. This method does nothing if DEBUG is not #defined. More...
static void	ClearOldLogs (int daysOld=7, string logsDir="logs")
	Clear logs that are older than the specified amount of days. More...

Detailed Description

Class to manage logging. ILog interfaces should be obtained from this class' methods, as opposed to calling default log4net methods.

Member Function Documentation

static void TriDevs.TriEngine.Logging.LogManager.ClearOldLogs ( int  daysOld = 7, string  logsDir = "logs"  )

static

Clear logs that are older than the specified amount of days.

Parameters

daysOld	Logs older than this amount of days will be deleted.
logsDir	The directory to clear.

        {
            var log = GetLogger(typeof(LogManager));

            log.InfoFormat(">> ClearOldLogs({0}, \"{1}\")", daysOld, logsDir);

            if (!Directory.Exists(logsDir))
            {
                log.InfoFormat("Directory {0} not found, no logs to clear", logsDir);
                log.Info("<< ClearOldLogs()");
                return;
            }

            var now = DateTime.Now;
            var max = new TimeSpan(daysOld, 0, 0, 0);
            var count = 0;
            foreach (var file in from file in Directory.GetFiles(logsDir)
                                 let modTime = File.GetLastAccessTime(file)
                                 let age = now.Subtract(modTime)
                                 where age > max
                                 select file)
            {
                try
                {
                    File.Delete(file);
                    log.InfoFormat("Deleted old log file: {0}", file);
                    count++;
                }
                catch (IOException ex)
                {
                    log.WarnFormat("Failed to delete log file: {0} ({1})", file, ex.Message);
                }
            }

            log.InfoFormat("Done! Cleared {0} log files.", count);
            log.Info("<< ClearOldLogs()");
        }

static void TriDevs.TriEngine.Logging.LogManager.DestroyConsole ( )

static

Destroys the console associated with the process, if loaded. This method does nothing if DEBUG is not #defined.

        {
#if DEBUG
            if (_consoleLoaded)
                WinAPI.FreeConsole();
#endif
        }

static ILog TriDevs.TriEngine.Logging.LogManager.GetLogger ( object  sender )

static

Gets an ILog object for the specified object.

To get the logger object for a static class, or from static context, call GetLogger(typeof(YourClass)).

Parameters

sender

The object or Type to get an ILog object for.

Returns

The ILog object.

        {
            if (!_loaded)
                LoadConfig();

            return log4net.LogManager.GetLogger(sender.GetType().ToString() == "System.RuntimeType" ? (Type)sender : sender.GetType());
        }

static void TriDevs.TriEngine.Logging.LogManager.LoadConfig ( string  file = null )

static

Load a config to use with log4net.

LoadConfig will first try to load the specified file, if not null. If it is unable to find the specified file, it will call itself again with file set to null. If no file is specified, it will attempt to load a config file following the pattern: "(AssemblyName).config" If it is unable to load the config, it will default to BasicConfigurator.

Parameters

file	The config file to load, null if automatic loading is preferred.

        {
            if (file == null)
            {
                if (File.Exists(AppDomain.CurrentDomain.FriendlyName + ".config"))
                    XmlConfigurator.Configure();
                else
                    BasicConfigurator.Configure();
            }
            else
            {
                if (File.Exists(file))
                    XmlConfigurator.Configure(new FileInfo(file));
                else
                {
                    LoadConfig();
                    return;
                }
            }

            _loaded = true;
        }

static void TriDevs.TriEngine.Logging.LogManager.SetupConsole ( )

static

Set up a new console for this process. Will not set up a console if a debugger is attached. This method does nothing if DEBUG is not #defined.

        {
#if DEBUG
            if (System.Diagnostics.Debugger.IsAttached)
                return;

            WinAPI.AllocConsole();
            var stdHandle = WinAPI.GetStdHandle(WinAPI.STD_OUTPUT_HANDLE);
            var safeFileHandle = new SafeFileHandle(stdHandle, true);
            var fileStream = new FileStream(safeFileHandle, FileAccess.Write);
            var encoding = Encoding.GetEncoding(WinAPI.CODE_PAGE);
            var stdOut = new StreamWriter(fileStream, encoding) { AutoFlush = true };
            Console.SetOut(stdOut);
            _consoleLoaded = true;
#endif
        }

---

The documentation for this class was generated from the following file:

• TriDevs.TriEngine/Logging/LogManager.cs