기본 콘텐츠로 건너뛰기

[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 설정에는 다양한 옵션들이 있기 때문에 관련된 문서를 잘 읽어보고 설정해야 한다. 하나의 사례를 보면 Namespace에 Wildcard를 쓰기 때문에 하나의 Logging 수행 명령에 여러 개의 Logger가 동작할 수도 있다. 즉, FDTWorks.Communication.Ftp.FtpClient 라는 클래스에서 Logging 명령을 수행했을 때 Logger가 “FDTWorks." 인 것과 "FDTWorks.Communication.” 로 되어 있다면 둘 다 해당되기 때문이다.

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

[ 정의한 변수 사용 ]

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

또한 변수들의 집합(Context)을 구성할 수도 있다.

또한 기본 제공되는 변수에 포맷등을 적용하여 변수화도 가능하다.

위와 같은 변수화를 통해서 쉽게 Rolling File Logger 설정이 가능하다.

[ 사용자 정의 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;
  }
}

그리고 환경 설정에서는 아래와 같이 해당 클래스가 존재하는 어셈블리를 설정하면 된다.

그리고 Logger에서는 아래와 같이 ActivityId를 이용해서 사용하면 된다.

[ 부하 측면 ]

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

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

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

기본적으로 사용할 비 동기 Wrapper를 지정해서 모두 적용될 수 있도록 지정이 가능하다.

[ 부가적인 옵션들 ]

환경 설정이 변경되면 (저장 시점) 자동으로 환경 설정 정보를 다시 적용한다.

NLog 자체에서 발생하는 문제도 별도의 로그나 예외로 구성할 수 있다.

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

[ 구성 사례 ]

위의 설정은 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

태그

라벨:

댓글

댓글 쓰기

이 블로그의 인기 게시물

OData 에 대해서 알아보자.

얼마 전에 어떤 회사에 인터뷰를 하러 간 적이 있었다. 당시 그 회사는 자체 솔루션을 개발할 기술인력을 찾고 있었고 내부적으로 OData를 사용한다고 했다. 좀 창피한 이야기일 수도 있지만 나름 기술적인 부분에서는 많은 정보를 가지고 있다고 했던 것이 무색하게 OData란 단어를 그 회사 사장님에게서 처음 들었다. 작고, 단순한 사이트들만을 계속해서 작업을 하다 보니 어느덧 큰 줄기들을 잃어버린 것을 느끼기 시작했다. 명색이 개발이 좋고, 기술적인 기반을 만들려고 하는 인간이 단어조차도 모른다는 것은 있을 수 없는 것이라서 다시 새로운 단어들과 개념들을 알아보는 시간을 가지려고 한다. OData (Open Data Protocol) 란? 간단히 정리하면 웹 상에서 손쉽게 데이터를 조회하거나 수정할 수 있도록 주고 받는 웹(프로토콜)을 말한다. 서비스 제공자 입장에서는 웹으로 데이터를 제공하는 방식으로 각 포탈 사이트들이 제공하는 OPEN API 포맷을 독자적인 형식이 아니라 오픈된 공통규약으로 제공 가능하며, 개발자는 이 정보를 다양한 언어의 클라이언트 라이브러리로 어플리케이션에서 소비할 수 있도록 사용하면 된다. 공식 사이트는 www.odata.org 이며 많은 언어들을 지원하고 있다. 좀더 상세하게 정의를 해 보면 OData는 Atom Publishing Protocol  (RFC4287) 의 확장 형식이고 REST (REpresentational State Transfer) Protocol 이다. 따라서 웹 브라우저에서 OData 서비스로 노출된 데이터를 볼 수 있다. 그리고 AtomPub 의 확장이라고 했듯이 데이터의 조회만으로 한정되는 것이 아니라 CRUD 작업이 모두 가능하다. Example 웹 브라우저에서 http://services.odata.org/website/odata.svc 를 열어 보도록 하자. This XML file does not appear to have any style in...
댓글 6개
자세한 내용 보기

C# 에서 Timer 사용할 때 주의할 점.

예전에 알고 지내시던 분의 질문을 받았다. Windows Forms 개발을 하는데, 주기적 (대략 1분)으로 데이터 요청을 하는 프로그램을 작성하기 위해서 Timer 를 사용하는데, 어떤 기능을 처리해야 하기 때문에 Sleep 을 같이 사용했다고 한다. 여기서 발생하는 문제는 Sleep 5초를 주었더니, Timer 까지 5초 동안 멈춘다는 것이다. Timer 라는 것은 기본적으로 시간의 흐름을 측정하는 기능이기 때문에 Sleep 을 했다고 해서 Timer 가 멈추는 일은 생겨서는 안된다. 그러나 실제 샘플을 만들어 보면 ... Timer 가 Sleep 만큼 동작이 멈추는 것을 확인할 수 있다. Windows Forms 는 UI Thread 를 사용하는 것으로 최적화 되어 있으며 여기서 Timer 를 쓰면 UI Thread 에 최적화된 System.Windows.Forms.Timer 가 사용된다. 여기서 문제의 발생이 시작되는 것이다. Sleep 을 사용하게 되면 UI Thread 가 Sleep 이 걸리기 때문에 여기에 속한 Timer 까지도 멈추는 것이다. 이런 문제를 해결하기 위해서는 System.Threading.Timer 를 사용해야 한다. 이 Timer 는 별도의 Thread 에서 동작하기 때문에 Sleep 의 영향을 받지 않는다. 언뜻 보면 쉬운 해결 방법인 것 같지만 Thread 가 분리되었기 때문에 Timer 가 돌아가는 Thread 에서 UI Thread 의 메서드나 컨트롤에 접근하기 위해서는 별도의 명령을 사용해야 하는 문제가 존재한다. 자~ 그럼 여기서 Timer 에 대해서 다시 한번 정리해 보도록 하자. .NET 에서 제공하는 Timer 들 .NET 에서는 기본적으로 3가지 Timer를 제공하고 있다. (MSDN) System.Windows.Forms.Timer - 사용자가 지정한 간격마다 이벤트를 발생시키며 Windows Forms 응용 프로그램에서 사용할 수 있도록 최적화 되어 있다. System...
댓글 7개
자세한 내용 보기