Log 관리

1. 개요

본문서는 Bitbucket 6.8.0 버전 기준으로, Bitbucket 에서 사용자가 정의한 Log 를 관리 할 수 있는 방법을 설명 한다.

2. How to do

2.1. log4j.properties  파일 수정

• 파일 위치 : <Bitbucket Install directory>/app/WEB-INF/classes/logback.xml
• 수정 내용 : logback.xml 맨 하단에 아래 형식에 맞게 수정 한다.

• 수정 대상 

  수정 대상	설명	예
  XXXlogName	사용자가 정의할 Log 이름	kic.bb.sample
  XXXlogFileFullName	log 내용이 저장될 파일 full 이름 (확장자 포함)	kic-bb-sample.log
  XXXlogFileFullName	log 내용이 저장될 파일이름 (확장자 없음)	kic-bb-sample
  XXXpackagePath	log 대상이 되는 pakcage 경로	com.kic.bitbucket.plugin

  형식

  <!-- Log 에 대한 설명 -->
  <appender name="XXXlogName" class="ch.qos.logback.core.rolling.RollingFileAppender">
  	<encoder>
  		<charset>UTF-8</charset>
  		<pattern>${log.format}</pattern>
  	</encoder>
  	<file>${log.dir}/XXXlogFileFullName</file>
  	<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
  <fileNamePattern>${log.dir}/XXXlogFileName-%d.%i.log</fileNamePattern>
  <maxFileSize>25MB</maxFileSize>
  <maxHistory>10</maxHistory>
  </rollingPolicy>
  </appender>
  
  <logger name="XXXpackagePath" level="DEBUG" additivity="false">
  	<appender-ref ref="XXXlogName" />
  </logger>
  

2.2. Service 재시작

• logback.xml 수정 후 Bitbucket Service 를 재시작 해야 한다.

2.3. Sample 예제

• 2.1 의 형식에서  XXXlogName, XXXlogFileFullName, XXXlogFileName, XXXpackagePath에 해당 하는 값이 아래와 같은 경우

  XXXlogName	kic.bb.sample	XXXlogFileFullName	kic-bb-sample.log
  XXXlogFileName	kic-bb-sample	XXXpakcagePath	com.kic.bitbucket.plugin

<!-- Log 에 대한 설명 -->
<appender name="kic.bb.sample" class="ch.qos.logback.core.rolling.RollingFileAppender">
	<encoder>
		<charset>UTF-8</charset>
		<pattern>${log.format}</pattern>
	</encoder>
	<file>${log.dir}/kic-bb-sample.log</file>
	<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log.dir}/kic-bb-sample-%d.%i.log</fileNamePattern>
<maxFileSize>25MB</maxFileSize>
<maxHistory>10</maxHistory>
</rollingPolicy>
</appender>

<logger name="com.kic.bitbucket.plugin" level="DEBUG" additivity="false">
	<appender-ref ref="kic.bb.sample" />
</logger>

2.4. 사용자 정의 log 파일 위치

• 위치 : <Bitbucket Home Directory>/log