Вы можете настроить log4net в коде вместо использования файла конфигурации?
Я понимаю, почему log4net использует app.config
файлы для настройки ведения журналов - так что вы можете легко изменить порядок регистрации информации без необходимости перекомпилировать ваш код. Но в моем случае я не хочу упаковать app.config
файл с моим исполняемым файлом. И у меня нет желания изменять настройки регистрации.
Есть ли способ для меня настроить регистрацию в коде, а не с помощью app.config
?
Вот мой простой конфигурационный файл:
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
</configSections>
<log4net>
<appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
<file value="Logs\EventLog.txt" />
<appendToFile value="false" />
<rollingStyle value="Size" />
<maxSizeRollBackups value="5" />
<maximumFileSize value="1GB" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date [%thread] %-5level %logger - %message%newline" />
</layout>
</appender>
<appender name="MemoryAppender" type="log4net.Appender.MemoryAppender">
</appender>
<root>
<level value="Info" />
<appender-ref ref="RollingLogFileAppender" />
<appender-ref ref="MemoryAppender" />
</root>
</log4net>
</configuration>
РЕДАКТИРОВАТЬ:
Для полной ясности: моя цель - не иметь XML-файла. Даже не как встроенный ресурс, который я превращаю в поток. Моей целью было определить регистратор полностью программно. Просто любопытно, если это возможно, и если да, то где я мог бы найти пример синтаксиса.
7 ответов
ЗАКЛЮЧИТЕЛЬНОЕ РЕШЕНИЕ:1
Для тех, кто может наткнуться на это в будущем, вот что я сделал. Я сделал статический класс ниже:
using log4net;
using log4net.Repository.Hierarchy;
using log4net.Core;
using log4net.Appender;
using log4net.Layout;
namespace Spectrum.Logging
{
public class Logger
{
public static void Setup()
{
Hierarchy hierarchy = (Hierarchy)LogManager.GetRepository();
PatternLayout patternLayout = new PatternLayout();
patternLayout.ConversionPattern = "%date [%thread] %-5level %logger - %message%newline";
patternLayout.ActivateOptions();
RollingFileAppender roller = new RollingFileAppender();
roller.AppendToFile = false;
roller.File = @"Logs\EventLog.txt";
roller.Layout = patternLayout;
roller.MaxSizeRollBackups = 5;
roller.MaximumFileSize = "1GB";
roller.RollingStyle = RollingFileAppender.RollingMode.Size;
roller.StaticLogFileName = true;
roller.ActivateOptions();
hierarchy.Root.AddAppender(roller);
MemoryAppender memory = new MemoryAppender();
memory.ActivateOptions();
hierarchy.Root.AddAppender(memory);
hierarchy.Root.Level = Level.Info;
hierarchy.Configured = true;
}
}
}
И тогда все, что мне нужно было сделать, это заменить код, в котором я вызвал файл XML, следующим вызовом:
//XmlConfigurator.Configure(new FileInfo("app.config")); // Not needed anymore
Logger.Setup();
1(этот ответ был отредактирован в вопросе ОП, я позволил себе сделать ответ сообщества, см. Здесь, почему)
Вы также можете полностью избежать XML, здесь я написал пример с минимальной программной конфигурацией.
В двух словах, вот что вам нужно
var tracer = new TraceAppender();
var hierarchy = (Hierarchy)LogManager.GetRepository();
hierarchy.Root.AddAppender(tracer);
var patternLayout = new PatternLayout {ConversionPattern = "%m%n"};
patternLayout.ActivateOptions();
tracer.Layout = patternLayout;
hierarchy.Configured = true;
Да, вы можете настроить log4net, позвонив:
log4net.Config.XmlConfigurator.Configure(XmlElement element)
Смотрите документацию log4net.
В качестве альтернативы вы можете создать пользовательский атрибут, который наследуется от log4net.Config.ConfiguratorAttribute и жестко запрограммировать конфигурацию в нем:
using log4net.Appender;
using log4net.Config;
using log4net.Core;
using log4net.Layout;
using log4net.Repository;
using log4net.Repository.Hierarchy;
using System;
using System.Reflection;
namespace ConsoleApplication1
{
[AttributeUsage(AttributeTargets.Assembly)]
public class MyConfiguratorAttribute : ConfiguratorAttribute
{
public MyConfiguratorAttribute()
: base(0)
{
}
public override void Configure(Assembly sourceAssembly, ILoggerRepository targetRepository)
{
var hierarchy = (Hierarchy)targetRepository;
var patternLayout = new PatternLayout();
patternLayout.ConversionPattern = "%date [%thread] %-5level %logger - %message%newline";
patternLayout.ActivateOptions();
var roller = new RollingFileAppender();
roller.AppendToFile = false;
roller.File = @"Logs\EventLog.txt";
roller.Layout = patternLayout;
roller.MaxSizeRollBackups = 5;
roller.MaximumFileSize = "1GB";
roller.RollingStyle = RollingFileAppender.RollingMode.Size;
roller.StaticLogFileName = true;
roller.ActivateOptions();
hierarchy.Root.AddAppender(roller);
hierarchy.Root.Level = Level.Info;
hierarchy.Configured = true;
}
}
}
Затем добавьте следующее в файл.cs:
[assembly: ConsoleApplication1.MyConfigurator]
Для тех, кто не хочет добавлять appender в Root logger, но в текущий / другой logger:
//somewhere you've made a logger
var logger = LogManager.GetLogger("MyLogger");
// now add appender to it
var appender = BuildMyAppender();
((log4net.Repository.Hierarchy.Logger)logger).AddAppender(appender);
logger.Debug("MyLogger with MyAppender must work now");
// and remove it later if this code executed multiple times (loggers are cached, so you'll get logger with your appender attached next time "MyLogger")
((log4net.Repository.Hierarchy.Logger)logger).RemoveAppender(sbAppender);
Хотя принятый ответ работает в большинстве случаев, у него есть несколько недостатков.
- Он хранит только 5 последних журналов.
- Размер журнала установлен на 1 ГБ, что слишком много для открытия большинства приложений блокнота.
- Поскольку он блокирует файл журнала, он не подходит для многопоточных приложений, таких как веб-приложения.
- Поскольку дата предшествует имени файла, ее неудобно использовать в Windows.
- Он перезаписывает журнал каждый раз, когда приложение перезапускается, что опять же не подходит, если вы планируете вести журналы.
- Как упоминалось в комментариях, для правильной работы в некоторых случаях требуются некоторые модификации.
Таким образом, немного более обширная конфигурация. Я создал класс, который немного упрощает ведение журнала. Очевидно, вы можете просто выбрать часть конфигурации, если хотите.
using log4net;
using log4net.Appender;
using log4net.Config;
using log4net.Core;
using log4net.Layout;
using log4net.Repository.Hierarchy;
using System;
using System.Collections.Generic;
using System.Data.SqlClient;
using System.Text;
using System.Web;
public enum LogType { Info, Debug, Warn, Error, Fatal };
public class Logger {
private const string LOG_NAMESPACE = "APP_NAME";
private const string LOG_FILENAME_PREFIX = @"D:\Logs\";
private static readonly Level LOG_LEVEL = Level.Debug;
private static readonly ILog log = LogManager.GetLogger(LOG_NAMESPACE);
#region static Logger()
// Static constructor is called automatically to initialize the class before the first instance is created or any static members are referenced
static Logger() {
Hierarchy hierarchy = (Hierarchy) LogManager.GetRepository();
hierarchy.Root.RemoveAllAppenders(); // Clear all previously added repositories.
hierarchy.Root.Level = LOG_LEVEL; // Set Log level
PatternLayout layout = new PatternLayout() { ConversionPattern = "%d{yyyy-MM-dd HH:mm:ss.fff} %4t %-5p %m%n" }; // Log line format: Include millisecond precision, thread ID, Log type,
layout.ActivateOptions(); // Apply Configuration
RollingFileAppender RFA = new RollingFileAppender();
RFA.Name = LOG_NAMESPACE; // Set name of appender
RFA.File = LOG_FILENAME_PREFIX + LOG_NAMESPACE; // Set file name prefix
RFA.LockingModel = new FileAppender.MinimalLock(); // Minimum lock time required, makes file available for reading
RFA.AppendToFile = true; // Do not overwrite existing logs, append to them.
RFA.DatePattern = ".yyyy.MM.dd'.log'"; // Add file extension here, to preserve the file extension
RFA.Encoding = Encoding.UTF8; // Set format of file to UTF8 for international characters.
RFA.CountDirection = 1; // Increment file name in bigger number is newest, instead of default backward.
RFA.MaximumFileSize = "100MB"; // Maximum size of file that I could open with common notepad applications
RFA.RollingStyle = RollingFileAppender.RollingMode.Composite; // Increment file names by both size and date.
RFA.StaticLogFileName = false;
RFA.MaxSizeRollBackups = -1; // Keep all log files, do not automatically delete any
RFA.PreserveLogFileNameExtension = true; // This plus extension added to DatePattern, causes to rolling size also work correctly
RFA.Layout = layout;
RFA.ActivateOptions(); // Apply Configuration
hierarchy.Root.AddAppender(RFA);
BasicConfigurator.Configure(hierarchy); // Apply Configuration
}
#endregion
#region public static int Log(...)
public static void Log(string Description, LogType logtype = LogType.Info) {
switch (logtype) {
case LogType.Debug:
log.Debug(Description);
break;
case LogType.Info:
log.Info(Description);
break;
case LogType.Warn:
log.Warn(Description);
break;
case LogType.Error:
log.Error(Description);
break;
case LogType.Fatal:
log.Fatal(Description);
break;
}
}
#endregion
#region public static int Log(...)
public static void Log(string Message, Exception ex) {
log.Fatal(Message, ex);
}
#endregion
}
А затем для регистрации сообщений и исключений вызовите его следующим образом:
Logger.Log("I was here", LogType.Debug);
Logger.Log("I am info message");
Logger.Log("An error", LogType.Error);
Logger.Log("An Exception", ex); // ex is of type Exception
Из-за странного способа, которым log4net добавляет скользящие данные к имени файла (добавленному после расширения файла), файлы теряют связь с проводником Windows. Чтобы исправить это
.log
вместо этого был добавлен в DatePattern. Он также будет правильно добавлять приращение файла перед расширением (возможно, из-за ошибки). Проверено на версии.
1.2.11.0
Заметки:
- Внешний вызов для инициализации не требуется, он будет инициализирован при запуске приложения (или при первом вызове Logger.Log).
- Вы можете переместить все константы класса в свой собственный файл конфигурации и сделать этот класс более универсальным и пригодным для повторного использования.
- Обратите внимание, что пространство имен не указано, это сделает класс Logger доступным во всех пространствах имен.
- Log4net предоставляет 5 методов регистрации сообщений, которые немного неудобно запоминать. Таким образом
Logger.Log
метод по умолчанию используетinfo
. - Не связанное с этим примечание: если ваше приложение работает на сервере или в Интернете, храните файлы журнала вне диска ОС и папки приложения.
Принятый ответ работает после того, как я нашел два предостережения:
- Сначала это не работало для меня, но после использования полного абсолютного пути для
roller.File
собственность, это начало работать. - Мне пришлось использовать это в F# (в скрипте fsx), поэтому были некоторые проблемы при конвертации из C#. Если вы заинтересованы в конечном результате (включая способ загрузки пакета nuget для log4net), см. Ниже:
nuget_log4net.fsx:
#!/usr/bin/env fsharpi
open System
open System.IO
open System.Net
#r "System.IO.Compression.FileSystem"
open System.IO.Compression
type DummyTypeForLog4Net () =
do ()
module NetTools =
let DownloadNuget (packageId: string, packageVersion: string) =
use webClient = new WebClient()
let fileName = sprintf "%s.%s.nupkg" packageId packageVersion
let pathToUncompressTo = Path.Combine("packages", packageId)
if (Directory.Exists(pathToUncompressTo)) then
Directory.Delete(pathToUncompressTo, true)
Directory.CreateDirectory(pathToUncompressTo) |> ignore
let fileToDownload = Path.Combine(pathToUncompressTo, fileName)
let nugetDownloadUri = Uri (sprintf "https://www.nuget.org/api/v2/package/%s/%s" packageId packageVersion)
webClient.DownloadFile (nugetDownloadUri, fileToDownload)
ZipFile.ExtractToDirectory(fileToDownload, pathToUncompressTo)
let packageId = "log4net"
let packageVersion = "2.0.5"
NetTools.DownloadNuget(packageId, packageVersion)
let currentDirectory = Directory.GetCurrentDirectory()
// https://stackru.com/a/19538654/6503091
#r "packages/log4net/lib/net45-full/log4net"
open log4net
open log4net.Repository.Hierarchy
open log4net.Core
open log4net.Appender
open log4net.Layout
open log4net.Config
let patternLayout = PatternLayout()
patternLayout.ConversionPattern <- "%date [%thread] %-5level %logger - %message%newline";
patternLayout.ActivateOptions()
let roller = RollingFileAppender()
roller.AppendToFile <- true
roller.File <- Path.Combine(currentDirectory, "someLog.txt")
roller.Layout <- patternLayout
roller.MaxSizeRollBackups <- 5
roller.MaximumFileSize <- "1GB"
roller.RollingStyle <- RollingFileAppender.RollingMode.Size
roller.StaticLogFileName <- true
roller.ActivateOptions ()
let hierarchy = box (LogManager.GetRepository()) :?> Hierarchy
hierarchy.Root.AddAppender (roller)
hierarchy.Root.Level <- Level.Info
hierarchy.Configured <- true
BasicConfigurator.Configure(hierarchy)
let aType = typedefof<DummyTypeForLog4Net>
let logger = LogManager.GetLogger(aType)
logger.Error(new Exception("exception test"))