기본 콘텐츠로 건너뛰기

[Logging] NLog 사용법 정리...

SCSF 에는 기본적으로 Enterprise Library가 사용된다.
예전에도 그랬지만 기능은 훌륭하고 많은 부분에서 최적화(?)된 것일지도 모르지만, 역시나 사용하기에는 뭔가 모르게 무겁고, 사용하지 않는 기능이 더 많다라는 느낌을 지울수가 없다.

이번 프로젝트도 SCSF를 기반으로 하고 있지만, Enterprise Library를 걷어내고 각 부분에 전문화된 오픈 소스를 사용하기로 하였다.

예전에는 Log4Net을 사용했지만, 대량 사용자 환경에서는 메모리 누수와 기타 문제점이 존재한다는 MS 컨설턴트(?)의 전해진 말을 들은 후로는 사용하지 않는다.

대안으로 사용하는 것이 NLog 이다. 조금 후에는 3.0 버전도 나온다고 홈 페이지에 기재되어 있지만, 그 때가 되면 프로젝트는 끝나기 때문에 현재 2.1.0 버전을 사용하기로 했다.

[원본 출처] http://cloverink.net/most-useful-nlog-configurations-closed/

위의 참조 자료에는 다양한 정보들이 존재하므로 꼭 링크를 통해서 관련된 정보를 확인하고 이해하는 것이 좋을 듯 하다.

여기서는 당장 필요한 부분만을 정리하도록 한다.

[ Logger 찾기 ]

기본적으로 Logger가 존재하는 클래스를 기반으로 Logger 정보를 구성한다.

Logger logger = LogManager.GetCurrentClassLogger();
주로 Namespace 기반으로 Logger를 설정하는 경우에 유연하게 사용할 수 있다.

또 다른 방법으로는 지정한 문자열로 특정 Logger를 직접 선택하는 방법도 제공된다. 이를 혼용해서 Namespace와 직접 지정 방식을 같이 사용할 수도 있다. 물론 Logger 환경 설정에서 Wildcard (*)를 지정할 수도 있다.

Logger logger = LogManager.GetLogger("Database.Connect");
Logger logger = LogManager.GetLogger("Database.Query");
Logger logger = LogManager.GetLogger("Database.SQL");
Logger logger = LogManager.GetLogger("Analysis.Financial");
Logger logger = LogManager.GetLogger("Analysis.Personnel");
Logger logger = LogManager.GetLogger("Analysis.Inventory");
관련된 Logger 환경 설정은 다음과 같이 하면 된다.

<logger name="Name.Space.Class1" minlevel="Debug" writeTo="f1" /> 
<logger name="Name.Space.Class1" levels="Debug,Error" writeTo="f1" /> 
<logger name="Name.Space.*" writeTo="f3,f4" />
<logger name="Name.Space.*" minlevel="Debug" maxlevel="Error" final="true" /> 
Logger 설정에는 다양한 옵션들이 있기 때문에 관련된 문서를 잘 읽어보고 설정해야 한다. 하나의 사례를 보면 Namespace에 Wildcard를 쓰기 때문에 하나의 Logging 수행 명령에 여러 개의 Logger가 동작할 수도 있다. 즉, FDTWorks.Communication.Ftp.FtpClient 라는 클래스에서 Logging 명령을 수행했을 때 Logger가 "FDTWorks.*" 인 것과 "FDTWorks.Communication.*" 로 되어 있다면 둘 다 해당되기 때문이다.

위와 같은 문제를 해결하기 위한 옵션이 "final" 이다. 즉 해당 (첫번째?) 하는 것만 수행하고 다음에 수행할 것은 제외하는 경우에 사용할 수 있다.

[ 정의한 변수 사용 ]

File 출력 Logging을 구성할 때 빈번하게 사용될 수 있는 것이 동적인 처리 부분이다. 파일 명이나 크기 및 날짜 단위로 파일을 분리하여야 할 경우와 같이 변수화 시켜야 하는 부분들은 아래와 같이 기본 제공되는 변수와 사용자 정의 변수를 구성해서 사용할 수 있다.

<variable name="brief" value="${longdate} | ${level} | ${logger} | ${message}"/>
<variable name="verbose" value="${longdate} | ${machine} | ${processid} | ${processname} | ${level} | ${logger} | ${message}"/>
<targets>
  <target name="file" xsi:type="File" layout="${verbose}" fileName="${basedir}/${shortdate}.log" />
  <target name="console" xsi:type="ColoredConsole" layout="${brief}" />
</targets>
또한 변수들의 집합(Context)을 구성할 수도 있다.

<variable name="mycontext" value="${gdc:item=appname} , ${mdc:item=threadprop}"/>
<variable name="fmt1withcontext" value="${longdate} | ${level} | ${logger} | [${mycontext}] |${message}"/>
<variable name="fmt2withcontext" value="${shortdate} | ${level} | ${logger} | [${mycontext}] |${message}"/>
또한 기본 제공되는 변수에 포맷등을 적용하여 변수화도 가능하다.

<variable name="day" value="${date:format=dddd}"/>
<variable name="month" value="${date:format=MMMM}"/>
<variable name="fmt" value="${longdate} | ${level} | ${logger} | ${day} | ${month} | ${message}"/>
<targets>
  <target name="console" xsi:type="ColoredConsole" layout="${fmt}" />
</targets>
위와 같은 변수화를 통해서 쉽게 Rolling File Logger 설정이 가능하다.

<variable name="day" value="${date:format=dddd}"/>
<targets>
  <target name="file" xsi:type="File" layout="${verbose}" fileName="${basedir}/${day}.log" />
</targets>
[ 사용자 정의 Layout Renderer ]

NLog 에서 제공되는 Renderer 클래스를 상속해서 쉽게 적용이 가능하다. 이 클래스를 식별하기 위해서 아래의 코드에서 보이는 것과 같이 Trace.CorrelationManager.ActivityId 를 추가하면 된다.

[LayoutRenderer("ActivityId")]
class ActivityIdLayoutRenderer : LayoutRenderer
{
  int estimatedSize = Guid.Empty.ToString().Length;

  protected override void Append(StringBuilder builder, LogEventInfo logEvent)
  {
    builder.Append(Trace.CorrelationManager.ActivityId);
  }

  protected override int GetEstimatedBufferSize(LogEventInfo logEvent)
  {
    return estimatedSize;
  }
}
그리고 환경 설정에서는 아래와 같이 해당 클래스가 존재하는 어셈블리를 설정하면 된다.

<extensions>
  <add assembly="MyNLogExtensions"/>
</extensions>
그리고 Logger에서는 아래와 같이 ActivityId를 이용해서 사용하면 된다.

<variable name="fmt" value="${longdate} | ${ActivityId} | ${message}"/>
[ 부하 측면 ]

실제 대량의 사용자 환경에서 Logging을 하는 것은 상당한 부하를 줄 수 있다. 그것이 동기화된 Logging이라면 더 민감해질 수 밖에는 없다.

이 부분 때문에 NLog를 선택한 것이기도 하지만 비 동기 방식의 Logging을 지원하고 있다. 물론 요즘의 다른 Logging 툴들도 제공하기는 한다. 쉽기도 하지만, 추가 및 사용 방법이 다양하게 지원된다.

아래와 같이 지정하면 된다.

<nlog>
  <targets async="true">
    <!-- all targets in this section will automatically be asynchronous -->
  </targets>
</nlog>
기본적으로 사용할 비 동기 Wrapper를 지정해서 모두 적용될 수 있도록 지정이 가능하다.

<nlog>  
  <targets>  
    <default-wrapper xsi:type="BufferingWrapper" bufferSize="100"/>  
    <target name="f1" xsi:type="File" fileName="f1.txt"/>  
    <target name="f2" xsi:type="File" fileName="f2.txt"/>  
  </targets>  
  <targets>  
    <default-wrapper xsi:type="AsyncWrapper">  
      <wrapper xsi:type="RetryingWrapper"/>  
    </default-wrapper>  
    <target name="n1" xsi:type="Network" address="tcp://localhost:4001"/>  
    <target name="n2" xsi:type="Network" address="tcp://localhost:4002"/>  
    <target name="n3" xsi:type="Network" address="tcp://localhost:4003"/>  
  </targets>  
</nlog>
[ 부가적인 옵션들 ]

<nlog autoReload="true" />
환경 설정이 변경되면 (저장 시점) 자동으로 환경 설정 정보를 다시 적용한다.

<nlog throwExceptions="true" />
<nlog internalLogFile="file.txt" />
<nlog internalLogLevel="Trace|Debug|Info|Warn|Error|Fatal" />
<nlog internalLogToConsole="false|true" />
<nlog internalLogToConsoleError="false|true" />
NLog 자체에서 발생하는 문제도 별도의 로그나 예외로 구성할 수 있다.

기타 다른 라이브러리들도 좋은 것들이 많이 제공되고 있으니 사용할 환경에 적합한 것들을 고르면 된다.

[ 구성 사례 ]

<configuration>
  <configSections>
    <section name="nlog"
             type="NLog.Config.ConfigSectionHandler, NLog"/>
  </configSections>
 
  <nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        autoReload="true"
        throwExceptions="false">

    <variable name="appName"
              value="EventLog에 사용할 어플리케이션 등의 식별 이름" />

    <targets async="true">
      <target xsi:type="File"
              name="default"
              layout="${longdate} - ${level:uppercase=true}: ${message}${onexception:${newline}EXCEPTION\: ${exception:format=ToString}}"
              fileName="${specialfolder:ApplicationData}\${appName}\Debug.log"
              keepFileOpen="false"
              archiveFileName="${specialfolder:ApplicationData}\${appName}\Debug_${shortdate}.{##}.log"
              archiveNumbering="Sequence"
              archiveEvery="Day"
              maxArchiveFiles="30" />

      <target xsi:type="EventLog"
              name="eventlog"
              source="${appName}"
              layout="${message}${newline}${exception:format=ToString}"/>
    </targets>
    <rules>
      <logger name="*"
              writeTo="default"
              minlevel="Info" />
      <logger name="*"
              writeTo="eventlog"
              minlevel="Error" />
    </rules>
  </nlog>
</configuration>
위의 설정은 Event Log 와 File Log를 설정한 것이다.

오픈 소스들을 찾아보면 Log Monitoring 툴들이 존재한다. Sentinel 이나 Harvester 등이다. 그리고 해당 사이트에 가면 NLog와 연동하는 방법이 나와있다.

아래는 Sentinel 을 기준으로 NLog와 연동한 설정이다.

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <targets>
    <target xsi:type="NLogViewer"
            name="viewer"
            address="udp://127.0.0.1:9999"/>
  </targets>
  <rules>
    <logger name="*"
            minlevel="Debug"
            writeTo="viewer" />
  </rules>
</nlog>

위의 같이 Target 과 Logger 설정을 연결하면 된다. UDP를 사용하므로 관련된 Address를 설정해 주면 된다.

또 다른 방법으로는 아래와 같이 내부적으로 사용할 수 있는 LoggerHelper와 같은 클래스를 사용해도 된다.

using NLog;
using NLog.Config;
using NLog.Targets;

namespace appName.Logging
{
  internal static class Log
  {
    public static Logger Instance { get; private set; }
    static Log()
    {
#if DEBUG
      // Setup the logging view for Sentinel - http://sentinel.codeplex.com
      var sentinelTarget = new NLogViewerTarget()
      {
        Name = "sentinel",
        Address = "udp://127.0.0.1:9999"
      };
      var sentinelRule = new LoggingRule("*", LogLevel.Trace, sentinalTarget);
      LogManager.Configuration.AddTarget("sentinel", sentinelTarget);
      LogManager.Configuration.LoggingRules.Add(sentinelRule);

      // Setup the logging view for Harvester - http://harvester.codeplex.com
      var harvesterTarget = new OutputDebugStringTarget()
      { 
        Name = "harvester",
        Layout = new Log4JXmlEventLayout()
      };
      var harvesterRule = new LoggingRule("*", LogLevel.Trace, harvesterTarget);
      LogManager.Configuration.AddTarget("harvester", harvesterTarget);
      LogManager.Configuration.LoggingRules.Add(harvesterRule);
#endif
      LogManager.ReconfigExistingLoggers();
      Instance = LogManager.GetCurrentClassLogger();
    }
  }
}

추가적인 사항으로 Database에 Log를 남겨야 하는 경우는 다음과 같이 로그 테이블을 설정한다. (MS SQL을 대상으로 하는 기본 설정이므로 상황에 맞도록 조정은 필요하다.)

CREATE TABLE [dbo].[system_logging] ( 
    [system_logging_guid] [uniqueidentifier] ROWGUIDCOL  NOT NULL, 
    [entered_date] [datetime] NULL, 
    [log_application] [varchar](200) NULL, 
    [log_date] [varchar](100) NULL, 
    [log_level] [varchar](100) NULL, 
    [log_logger] [varchar](8000) NULL, 
    [log_message] [varchar](8000) NULL, 
    [log_machine_name] [varchar](8000) NULL, 
    [log_user_name] [varchar](8000) NULL, 
    [log_call_site] [varchar](8000) NULL, 
    [log_thread] [varchar](100) NULL, 
    [log_exception] [varchar](8000) NULL, 
    [log_stacktrace] [varchar](8000) NULL, 
CONSTRAINT [PK_system_logging] PRIMARY KEY CLUSTERED 
( 
    [system_logging_guid] ASC 
) WITH (PAD_INDEX  = OFF, STATISTICS_NORECOMPUTE  = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS  = ON, ALLOW_PAGE_LOCKS  = ON) ON [PRIMARY] 
) ON [PRIMARY]
GO

ALTER TABLE [dbo].[system_logging] ADD  CONSTRAINT [DF_system_logging_system_logging_guid]  DEFAULT (newid()) FOR [system_logging_guid] 
GO
ALTER TABLE [dbo].[system_logging] ADD  CONSTRAINT [DF_system_logging_entered_date]  DEFAULT (getdate()) FOR [entered_date] 
GO

만일 로그가 저장되면서 Nofify Mail 을 같이 처리하여야 하는 경우는 다음과 같이 Tigger를 이용해서 Database에서 메일 처리를 수행할 수 있도록 연계하면 된다.

ALTER TRIGGER [dbo].[LogEmail] 
   ON  [dbo].[system_logging] 
   AFTER insert 
AS 
BEGIN 
    -- SET NOCOUNT ON added to prevent extra result sets from 
    -- interfering with SELECT statements. 
    SET NOCOUNT ON; 
    Declare @ToEmail varchar(100) 
    Declare @Title varchar(100) 
    Declare @logmessage varchar(8000) 
    declare @loglevel as varchar(100)    
    set @ToEmail = 'youremailaddress' 
    set @Title = 'Error' 
    set @loglevel = (select log_level from inserted) 
    set @logmessage = (select 
    'User Date:' + char(9) + char(9) + log_date + char(13) + char(10) + 
    'Computer:'+ char(9) + log_machine_name + char(13) + char(10) +  
    'User:' + char(9) + char(9) + log_user_name + char(13) + char(10) +  
    'Level:' + char(9)+ log_level + char(13) + char(10) +  
    'Logger:' + char(9)+ log_logger + char(13) + char(10) + 
    'Thread:'+ char(9) + log_thread + char(13) + char(10) +    
    'StackTrace:'+ char(9) + log_stacktrace + char(13) + char(10) +  
    'CallSite:'+ char(9) + log_call_site + char(13) + char(10) + 
    'Message:' + char(9) + log_message + char(13) + char(10) +  
    'Exception:'+ char(9) + log_exception as 'emailmessage'    
    from inserted) 
    if @loglevel <>'Info' 
    EXEC msdb.dbo.sp_send_dbmail @recipients=@ToEmail, @body= @logmessage,  @subject = @Title, @profile_name = 'default'
END

개인적으로는 Trigger를 그다지 좋아하지 않기 때문에 굳이 사용을 하지 않지만, 이미 구축된 시스템에 적용하는 경우라면... 위의 같이 적용이 가능하다.

그리고 "sp_send_dbmail" 의 경우는 권한이 없어서 처리가 안될 수도 있으므로 관련된 권한을 설정해 주어야 한다.

EXEC msdb.dbo.sp_addrolemember @rolename = 'DatabaseMailUserRole' 
    ,@membername = '사용자명'; 
GO

댓글

댓글 쓰기