Logging

System.out.println 을 이용해 정보를 콘솔(Console)에 출력하는 것.
try {
  System.out.println("Prepare connect to "+ ip +":"+port);
  connect(ip, port);
  System.out.println("Connected");
}
catch(Exception ex) {
  System.out.println("Fail to connect");
  ex.printStackTrace();
}

appender("fileAppender", ch.qos.logback.core.FileAppender) {
   file = "/var/log/myapp.log"
}

  
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184

  
import ch.qos.logback.classic.jul.LevelChangePropagator
import ch.qos.logback.classic.sift.MDCBasedDiscriminator

import com.fasterxml.jackson.core.JsonGenerator
import com.fasterxml.jackson.databind.MappingJsonFactory
import net.logstash.logback.composite.JsonProviders
import net.logstash.logback.composite.loggingevent.*
import net.logstash.logback.decorate.JsonFactoryDecorator

import java.nio.channels.spi.AbstractSelectionKey

import org.slf4j.bridge.SLF4JBridgeHandler


// Logback의 구동을 디버깅하기 위한 리스너 등록. 로그파일 갱신등의 상태 변화를 출력해줌
statusListener(OnConsoleStatusListener)

// JUL(Java Util Logging) to SLF4j 과정에서 발생하는 성능 저하를 막기 위한 조치  ( Ref: http://www.slf4j.org/legacy.html#jul-to-slf4j )
def lcp = new LevelChangePropagator()
lcp.context = context
lcp.resetJUL = true
context.addListener(lcp)

// JUL 대신 SLF4J를 사용하게 하였음
SLF4JBridgeHandler.removeHandlersForRootLogger();
SLF4JBridgeHandler.install();


// 동적으로 로그 설정을 하기 위해 JMX에 등록
jmxConfigurator()

// 로그 파일(logback.groovy)의 변화를 10초에 한번 검사하여 변경이 있을 경우 다시 읽기 한다
scan("10 seconds")


// 하나의 로그 파일로 여러 어플리케이션을 동시에 지원할수도 있음.
// 그럴경우 Application, Stage, Project Name, System Name등의 정보를 이용하여 별도의 파일에 기록하게 할수도 있음
// 하지만 여기에서는 단순하게 기술함

def SYMBOL = "my-app"

def STAGE = "P" // 운영 환경

// 로그 파일을 저장할 폴더. 프로젝트에 맞게 수정
def LOG_PATH_PREFIX = "/var/log/my-app"


// remoteAddr, requestId, programiId, userId 등의 메타 정보가 있어야 로그를 쉽게 분석 할수 있다
// 이런정보는 Servlet Filter나 Spring Interceptor등에서 Logback MDC를 이용해 주입할수 있다
// def CONSOLE_PATTERN = " %date{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%.-1level) %X{remoteAddr} %X{requestId:-00000000000000000000} %-20X{programId:-00000000000000000000} %X{uid} %red(%-17X{userId:-MB000000000000000}) %cyan(%-40.40logger{40}):%-4.4line - %message%n"

// 하지만 그런 설정을 하지 않았다면 단순하게 갈수도 있다
def CONSOLE_PATTERN = " %date{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%.-1level) %cyan(%-40.40logger{40}):%-4.4line - %message%n"


def consoleAppender = null
def CONSOLE = appender("CONSOLE", ConsoleAppender) {
  encoder(PatternLayoutEncoder) {
    pattern = CONSOLE_PATTERN
  }
  consoleAppender = component
}


// 로그를 저장하는 행위가 프로그램의 실행을 block 하지 않기 위해 비동기 Appender를 사용하게 한다
appender("CONSOLE_ASYNC", ch.qos.logback.classic.AsyncAppender) {
   component.addAppender(consoleAppender)
   includeCallerData = true // caller data는 appender에서 수집하게 되어 있다
}

def fileLogger = { PATH, SYMBOL , prudentMode->

  def fileAppender = null
  appender("${SYMBOL}_FILE", RollingFileAppender) {

    // TimeBasedRollingPolicy + prudent=true 에서는 file 속성을 설정하면 않된다. 설정해도 null로 변경함
    file = "${PATH}/${SYMBOL}.log"

    fileAppender = component //  component 는  appender 설정 내부에서 appender 자체를 가르키는 변수. ASYNC 에서 사용하기 위해 외부 변수에 저장해 둔다.
    encoding "UTF-8"

    // prudent가 true이면 여러 JVM이 동시에 로그를 저장할때 로컬 디스크든, 분산환경에서의 네트워크 디스크든 꼬이는 일 없이 저장되게 해주지만, 반대 급부로 막대한 성능 저하가 발생한다.
    // 또한 RollingFileAppender에 지정해준 file 속성은 무시되며 TimebasedRollingPolicy에 지정된 파일명을 사용하게 된다.
    prudent = prudentMode

    // 파일에 저장되는 로그 자체는 JSON 형태로 기록한다
    // JSON이 추후에 field를 추가하거나 중앙으로 수집하여 분석하기에 용이하다
    encoder(net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder) {

      jsonFactoryDecorator = (new JsonFactoryDecorator(){
        public MappingJsonFactory decorate(MappingJsonFactory factory){
          factory.disable(JsonGenerator.Feature.ESCAPE_NON_ASCII)
          return factory;
        }
      })

      def p =  new JsonProviders();

      p.addProvider(  new LoggingEventFormattedTimestampJsonProvider())

      p.addProvider(  new MdcJsonProvider())

      // 어플리케이션이 아니라 환경을 읽어 추가할수 있는 정보를 추가.
      // 실제 어플에서는 필요하지만 샘플에서는 비활성화 해둠
      // def  customFieldsProvider = new GlobalCustomFieldsJsonProvider()
      // customFieldsProvider.customFields =  '{"app":"'+APPLICATION+'","sysNo":"'+ SYSTEM_NO+'"}'
      // p.addProvider(customFieldsProvider)

      p.addProvider(  new LoggerNameJsonProvider())
      p.addProvider(  new LogLevelJsonProvider())
      p.addProvider(  new CallerDataJsonProvider())
      p.addProvider(  new StackTraceJsonProvider())
      p.addProvider(  new MessageJsonProvider())

      providers = p

    }
    rollingPolicy(TimeBasedRollingPolicy) {
      // aux: logback은 %d 로 나타낸 period를 롤링 스케줄로 삼는데 %d가 여럿 있을 때 어떤 것을 무시할지 지정할 때 사용
      // 로그 파일이 너무 커지면 다운 받거나 열어 보기가 힘들기 때문에 롤링 설정을 시간 단위로 하게 설정한다
      fileNamePattern = "${PATH}/backup/%d{yyyy-MM-dd,aux}/${SYMBOL}_%d{yyyy-MM-dd-HH}.log.gz"

      // 최대 몇개의 과거 로그파일을 유지할 것인가
      maxHistory = 24 * 31 * 6 // 롤링을 시간단위로 하기 때문. 6개월간 유지한다
    }
  }

  def asyncAppender = null

  appender("${SYMBOL}_FILE_ASYNC", ch.qos.logback.classic.AsyncAppender) {
    asyncAppender = component
      component.addAppender(fileAppender)
      includeCallerData = true // caller data는 appender에서 수집하게 되어 있다
  }
}

// Application Log

fileLogger(LOG_PATH_PREFIX, SYMBOL, false);




// 어플리케이션, 라이브러리마다 필요한 레벨이 다름

logger "jdbc.resultset" , ERROR
logger "jdbc.connection" , ERROR
logger "jdbc.audit" , ERROR
logger "jdbc.sqlonly" , ERROR
logger "jdbc.resultsettable" , ERROR
logger "jdbc.sqltiming" , ERROR
logger "log4jdbc.debug", ERROR

logger "net.sf.log4jdbc", INFO
logger "org.springframework.web.servlet.handler", WARN
logger "org.springframework", INFO
logger "org.springframework.security.web.util.matcher", WARN
logger "org.springframework.security.web.FilterChainProxy", WARN
logger "org.springframework.context.annotation", INFO

logger "org.mybatis.spring.SqlSessionUtils", ERROR
logger "org.apache.ibatis.io.ResolverUtil", INFO
logger "org.springframework", INFO
logger "org.hibernate",  INFO
logger "org.apache.commons.digester", INFO



//  개발중에만 필요한 로그들에 대한 설정.
if (STAGE != "P"){ //  운영환경에서는 설정되지 않아야 한다.
  logger "jdbc.resultsettable" ,  INFO
  logger "jdbc.sqlonly" ,     INFO
}


//  운영 환경이 아니면 콘솔 출력을  활성화 한다.  운영 환경에서는 중복 로그 기록에 따른 성능 하락을 방지 하기 위해 콘솔 출력을  disable  시킨다.
if (STAGE == "P"){
  root  INFO, ["${SYMBOL}_FILE_ASYNC"]

  //root  INFO, ["${SYMBOL}_FILE_ASYNC", "CONSOLE_ASYNC"]
}
else {
  root  DEBUG, ["${SYMBOL}_FILE_ASYNC",  "CONSOLE"]
}

class MyApp {
  static final Logger log = Logger.getLogger(MyApp.class);

  public void doSomething() {
    log.debug("Enter Do something");
    // do something here
    log.debug("Exit do shometing");
  }
}