[Spring] log4j2 사용법, 로그남기기, 파일 저장

반응형

목차

1. 개요

2. 환경

3. 라이브러리

4. 예제

5. 실행결과

---

1. 개요

 log4j2 = log lib

 log를 남기는 이유는 여러 가지가 있는데 대표적으로 [에러 추적, 디버깅] 또는 [통계]나 [기록]을 목적으로 해!

 어쨌든간에 어렵지 않은 내용이니 한번 따라 해 보자고~

 So~~~~~~~ Ez.

---

2. 환경

이클립스	MARS
JDK	1.7
comcat	7 (그저갓)

---

3. 라이브러리

 이거 다 받아서 프로젝트의 lib폴더에 넣자. 프로젝트를 컴파일하면 lib폴더에 있는 jar파일을 class파일로 만들어 사용하기 때문에 여기다 넣어도 된단다! 예외가 몇 개 있지만 요 녀석들은 해당되지 않아! 어서 다운로드하으렴

log4j-api-2.0.2.jar

0.12MB

log4j-core-2.0.2.jar

0.75MB

log4j-over-slf4j-1.7.7.jar

0.02MB

log4j-slf4j-impl-2.0.2.jar

0.02MB

log4j-web-2.0.2.jar

0.02MB

slf4j-api-1.7.7.jar

0.03MB

slf4j-ext-1.7.7.jar

0.04MB

---

4. 예제

 다운로드한 파일을 프로젝트 폴더의 lib(경로는 WEB-INF/lib) 폴더에 넣었다면 본격적인 예제를 작성해볼 건데, 그냥 로그를 뿌리는 것보다 뭔가 상황이 주어지면 맛깔날 것 같아서 대충 시나리오를 준비했어.

 ※ 시나리오

  1) 나는 서버 개발자

  2) x초보 서버 개발자

  3) controller가 아닌! Servlet을 이용.

  4) 클라이언트가 Servlet에 설정된 Url로 요청

  5) log출력.

 

웹 프로젝트는 생성했다고 가정하고 post, get 통신을 받는 서블릿 패키지 및 클래스를 만들어보자.

 

  4.1) 서블릿 생성

  File -> New -> Servlet 클릭

  나는 패키지 이름을 one, 클래스 이름을 andTwo로 설정했어.

서블릿 패키지 및 클래스 생성

   4.2) andTwo.java

package one;
 
import java.io.IOException;
 
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
 
import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;
 
/**
 * Servlet implementation class andTwo
 */
@WebServlet("/andTwo")
public class andTwo extends HttpServlet {
    private static final long serialVersionUID = 1L;
    private Logger logger = LogManager.getLogger(andTwo.class);
    /**
     * Default constructor. 
     */
    public andTwo() {
        // TODO Auto-generated constructor stub
    }
 
    /**
     * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
     */
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // TODO Auto-generated method stub
        response.getWriter().append("Served at: ").append(request.getContextPath());
        logger.error("error message");
        logger.warn("warn message");
        logger.info("info message");
        logger.debug("debug message");
        logger.trace("trace message");
    }
 
    /**
     * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
     */
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // TODO Auto-generated method stub
        response.getWriter().append("Served at: ").append(request.getContextPath());
        logger.error("error message");
        logger.warn("warn message");
        logger.info("info message");
        logger.debug("debug message");
        logger.trace("trace message");
    }
 
}
 

코드 설명 대충 하자면 

18번째 줄은 요청 url이야. 그림으로 설명해줄게

포트정보

context path

서버 탭을 자세히 살펴보면 자신의 포트와 contextPath 정보를 확인할 수 있어.

서버를 기동시 키면 http://localhost:port/contextPath 가 루트 url이 되는 거야.

요청 url인 '/andTwo'는 루트 url을 포함한 형태라고 생각해.

정리하면 http://localhost:8080/log/andTwo 경로로 요청이 들어오면 해당 경로와 mapping 된 서블릿에 정의된 코드를 처리한다는 뜻이야.

 

21번째 줄에 logger 객체 LogManger.getLogger() 메서드를 통해 생성해주었어. getLogger의 파라미터 값에 현재 클래스명. class를 넣어줘

 

32번째 줄은 Get방식으로 온 요청에 대한 처리.

 

45번째 줄은 Post방식으로 온 요청에 대한 처리이고, 각각 error, warn, info, debug, trace 로그를 남기게 돼. 이들을 로그 레벨이라고 하고 자세한 건 구글링을 통해 알아보면 좋을 것 같아.

 

간단하게 몇 개만 설명하면

 error는 시스템에 문제를 발생시킬만한 로그정보

 warn는 시스템에 문제가 생기진 않지만 에러를 야기할 수 로그정보

 debug는 디버깅을 위해 남기는 로그정보

 

 상황에 맞게 이 로그들을 사용해야 한다는데.. 나는 아직도 어려워..

 어쨌든 이 서블릿으로 요청이 들어오면 무조건 error ~ tarce까지 로그를 출력하도록 했어.

 이제 log4j2의 설정 파일을 생성해야하는데 생성하기 전에 log4j2의 설정파일 경로를 지정해놓자. 이 작업은 web.xml파일에서 해.

 

 4.3) web.xml 파일 설정

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
  <display-name>log</display-name>
  <welcome-file-list>
    <welcome-file>index.html</welcome-file>
    <welcome-file>index.htm</welcome-file>
    <welcome-file>index.jsp</welcome-file>
    <welcome-file>default.html</welcome-file>
    <welcome-file>default.htm</welcome-file>
    <welcome-file>default.jsp</welcome-file>
  </welcome-file-list>
  <context-param>
    <param-name>log4j2ConfigLocation</param-name>
    <param-value>/WEB-INF/log4j2.xml</param-value>
  </context-param>
</web-app>

display-name은 프로젝트명.

welcome-file-list는 프로젝트가 컴파일되면 최초로 보이는 파일 list.

만약 WEB-INF에 이 파일이 없다면? 404 에러가 뜰 거야. 하지만 우리는 저런 html 파일이 필요 없기 때문에 만들지 않아도 돼

 

context-param은 서버의 parameter를 설정해주는 부분이야.

log4 jConfigLocation이라는 변수에 /WEB-INF/log4j2.xml이라는 값을 넣었다고 생각하면 편해.

 

log4j2는 기본적으로 로그에 대한 설정 파일인 log4j2.xml이 필요한데 이 녀석의 경로야.

 

(사실 이 부분이 없어도 되는데 이유는 log4j2는 로드가 될때 설정 파일인 log4j2.xml을 classpath: 경로에서 알아서 찾는다고 하네..)

 

이제 log4j2 설정파일 세팅을 해보자.

 

 4.4) log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
    <!-- 로그 출력 방식 -->
    <Appenders>
        <!-- 콘솔 출력 방식 -->
        <Console name="STDOUT" target="SYSTEM_OUT">
            <PatternLayout pattern="%d %-5p [%t] %C{2} (%F:%L) - %m%n" />
        </Console>
        
        <!-- 파일 저장 방식 -->
        <File name="file" fileName="C:/Users/mcnc/Desktop/20191203.log">
              <PatternLayout pattern="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/>
        </File>
    </Appenders>
    
    <Loggers>
        <!-- one 패키지의 'andTwo 클래스의 로그 레벨은 info로 올리고', file로 저장할래 -->
        <!-- additivity는 같은 로그가 있다면 additivity가 설정되어있는 로거에서만 출력하도로 설정하는거야.
        참고로 모든 로거에는 기본 로그가 남는데 아래처럼 따로 설정한 로그 방식을 AppenderRef 해준다면 기본 로그+Append 로그. 총 2개의 로그가 남아.
        기본로그는 최소의 정보만 들어있기때문에 이를 막아야겠지? 로그 자체는 동일하기때문에 additivity를 false로 해 주면 기본로그는 뜨지 않을거야. -->
        <Logger name = "one.andTwo"  level="info" additivity = 'false'>
            <AppenderRef ref="STDOUT"/>
            <AppenderRef ref="file"/>
        </Logger>
    </Loggers>
</Configuration>

3번째 줄의 Appenders는 로그 방식에 대한 정의 부분이야.

 

6번째 줄은 Console로 출력하기 위한 설정으로 target="SYSTEM_OUT"으로 설정했어.  name은 이 방식에 대한 이름이야. 맘대로 정해.

 

7번째 줄은 로그 내용에 대한 형식이야. 날짜, 시간, 클래스.. 대충 요런 형식으로 로그 정보가 남는다는 뜻이야. 자세한 건 구글링..

 

11번째 줄부터는 로그를 파일에 저장시키는 방식을 정의한 부분이야.

 

16번째 줄부터는 Appenders에 정의해놓은 로그 방식을 사용하는 부분이야.

 

21번째 줄의 name은 패키지 경로를 포함한 클래스 이름이야. andTwo 클래스에서 발생되는 로그를 콘솔과 파일로 남기겠다는 뜻인데, level이 info로 설정되어 있으니 info레벨 이상의 로그만 남긴다는 의미야.

현재 andTwo 클래스에는 상위부터 error ~ trace까지의 로그를 남긴다고 되어있는데 level속성에 의해 trace와 debug를 제외한 로그만이 console과 파일에 저장되게 되지!

 

이제 서버를 켜고 크롬 창에서 요청 url을 입력해봐. 만약 아래와 같은 화면이 출력된다면 Servlet 호출에 성공한 거고, 콘솔 창, 파일에 로그까지 남는다면 log4j2를 이용한 로그 남기기도 성공한 거야!

---

5. 실행결과

 

이클립스 콘솔

 

 

파일

 

 

설명이 너무 장황하고 두서없어서 이해하긴 어려울 거야... 공부한다고 생각하고 나 자신과 대화를 한다는 컨셉으로 쓴 거니까 이해해주길..