Log4j SDK v2

Classic/VPC 환경에서 이용 가능합니다.

log4j SDK v2에서는 Effective Log Search & Analytics 2.0 서비스가 제공하는 log4j SDK의 사용 방법을 설명합니다.

SDK를 사용하는 순서는 다음와 같습니다.

1. 사전 준비
2. Dependency 추가
3. 기본 Appender 설정
4. AsyncAppender 설정
5. SDK 사용

1. 사전 준비

log4j SDK를 설치하기 위한 사전 준비 사항은 다음과 같습니다.

1. 네이버 클라우드 플랫폼의 콘솔에서 프로젝트를 생성해 주십시오.
2. 생성한 프로젝트의 상세 정보 화면에서 txtToken 값을 확인해 주십시오.
3. log4j SDK를 다운로드해 주십시오.

2. Dependency 추가

log4j SDK v2를 설치하는 방법은 다음과 같습니다.

1. 다운로드한 SDK 파일의 압축을 풀어 주십시오.
2. pom.xml 파일에 다음과 같이 dependency를 추가해 주십시오.
   • <systemPath>에 각각 core 모듈(nelo2-java-sdk-core-1.6.6.jar)과 log4j 모듈(nelo2-java-sdk-log4j-1.6.6.jar)의 경로 추가

    <dependencies>
        <dependency>
            <groupId>nelo2-java-sdk-core</groupId>
            <artifactId>nelo2-java-sdk-core</artifactId>
            <version>1.6.6</version>
            <scope>system</scope>
            <systemPath>/nelo2-java-sdk-core-1.6.6.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>nelo2-java-sdk-log4j</groupId>
            <artifactId>nelo2-java-sdk-log4j</artifactId>
            <version>1.6.6</version>
            <scope>system</scope>
            <systemPath>/nelo2-java-sdk-log4j-1.6.6.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.7.2</version>
        </dependency>
        <dependency>
            <groupId>org.apache.thrift</groupId>
            <artifactId>libthrift</artifactId>
            <version>0.9.3</version>
        </dependency>
        <dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpclient</artifactId>
            <version>4.2.6</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.3.1</version>
        </dependency>
    </dependencies>
   

3. 기본 Appender 설정

기본 Appender를 설정하는 방법은 다음과 같습니다.

• 파일명: log4j.xml

1. configuration은 다음과 같이 입력해 주십시오.

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration PUBLIC "" "log4j.dtd">
<log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/'>
    <!-- // define appenders // -->
    <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
        <param name="Threshold" value="DEBUG"/>
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%m%n"/>
        </layout>
    </appender>
    <!-- // define loggers // -->
    <logger name="com" additivity="false">
        <level value="INFO"/>
        <appender-ref ref="STDOUT"/>
    </logger>
    <!-- // define root // -->
    <root>
        <level value="WARN"/>
        <appender-ref ref="STDOUT"/>
    </root>
</log4j:configuration>

2. appender는 다음과 같은 형식으로 입력해 주십시오.

<!-- define nelo appender -->
<appender name="nelo" class="com.naver.nelo2.log4j.ThriftAppender">
    <param name="Threshold" value="ERROR"/>
    <param name="projectName" value="%YOUR_PROJECT_ID%"/>
    <param name="collectorUrl" value="elsa-v2-col.ncloud.com"/>
    <param name="port" value="10006"/>
    <param name="timeout" value="1200"/>
    <param name="enable" value="true"/>
    <param name="errorCodeType" value="default"/>
</appender>

각 설정 옵션에 대한 설명은 다음과 같습니다.

bulk와 single 모드

NELO2 log4j SDK는 로그 전송을 건당으로 보내는 single 모드와 묶음 단위로 전송하는 bulk 모드를 지원합니다. xml appender 설정에서 isBulkEnabled를 true 또는 false로 하여 bulk 또는 single 모드를 선택할 수 있습니다(기본값: true(bulk 모드)).
프로토콜에 따라 다음 성능 지표를 참고해 주십시오.

• 1분간 단일 스레드에서 1kb size의 로그를 전송할 시의 throughput
  • thrift
    • single 모드: 2615.54 logs/sec
    • bulk 모드: 6642.97 logs/sec
  • http
    • single 모드: 592.97 logs/sec
    • bulk 모드: 4665.26 logs/sec

4. AsyncAppender 설정

기본 Appenderlog4j에서 지원되는 AsyncAppender를 이용하여 기본 Appender와 같은 방식의 결과를 얻을 수 있습니다.

다음의 예시를 참고하여 AsyncAppender를 설정해 주십시오.

<예시>

<appender name="nelo-async" class="org.apache.log4j.AsyncAppender">
    <param name="Threshold" value="ERROR"/>
    <param name="blocking" value="false"/>
    <param name="locationInfo" value="true"/>
    <param name="bufferSize" value="2048"/>
    <appender-ref ref="nelo"/>
</appender>

기본적으로 사용하는 ThriftAppender에 추가적으로 Nelo2AsyncAppender를 사용하여 실제 로그 전송 작업을 별도의 스레드에서 수행하려면 다음 예시를 참고하여 설정해 주십시오.

<예시>

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration PUBLIC "" "log4j.dtd">
<log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/'>
    <!-- // define appenders // -->
    <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
        <param name="Threshold" value="DEBUG"/>
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%m%n"/>
        </layout>
    </appender>
    <!-- define nelo appender -->
    <appender name="nelo" class="com.naver.nelo2.log4j.ThriftAppender">
        <param name="Threshold" value="ERROR"/>
        <param name="projectName" value="프로젝트 아이디"/>
        <param name="collectorUrl" value="elsa-v2-col.ncloud.com"/>
        <param name="port" value="10006"/>
        <param name="timeout" value="1200"/>
        <param name="enable" value="true"/>
        <param name="errorCodeType" value="default"/>
    </appender>
    <!-- define nelo-async appender -->
    <appender name="nelo-async"
              class="org.apache.log4j.AsyncAppender">
        <param name="Threshold" value="ERROR"/>
        <param name="blocking" value="false"/>
        <param name="locationInfo" value="true"/>
        <param name="bufferSize" value="2048"/>
        <appender-ref ref="nelo"/>
    </appender>
    <!-- // define loggers // -->
    <logger name="com" additivity="false">
        <level value="ERROR"/>
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="nelo-async"/>
    </logger>
    <!-- // define root // -->
    <root>
        <level value="WARN"/>
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="nelo-async"/>
    </root>
</log4j:configuration>

5. SDK 사용

다음의 Effective Log Search & Analytics 2.0 log4j SDK를 사용하는 실제 코드 예를 참고하여 프로젝트에 로그를 전송해 주십시오.

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

private static Logger logger = LoggerFactory.getLogger(log4jTest.class);
...
    logger.debug("Effective Log Search & Analytics log4j SDK Debug Message");
    try {
        String npe = null;
        npe.toString();
    } catch(Exception e) {
        logger.error("Effective Log Search & Analytics log4j SDK Exception", e);
    }

log4j SDK v2 문제 해결

log4j SDK v2와 관련하여 발생할 수 있는 문제와 해결 방법을 확인해 주십시오.

Effective Log Search & Analytics 2.0 서버로 로그를 전송했지만, 이를 웹에서 확인할 수 없는 경우

전송한 로그를 웹에서 확인할 수 없는 경우 다음과 같이 조치해 주십시오.

1. 로그를 Effective Log Search & Analytics 2.0 수집 서버로 전송 후, 결과 메시지에 오류가 없는 경우에는 projectName이 정확한지 확인해 주십시오.
2. 실제 오류 데이터가 전송되는지 확인해 주십시오.
   • 설정 파일(log4j.xml)에서 Effective Log Search & Analytics 2.0 NELO appender의 debug 속성을 true로 설정하고 실행한 후 다음와 같은 전송 로그가 출력되는지 확인해 주십시오.

     <!-- define nelo appender -->
     <appender name="nelo" class="com.naver.nelo2.log4j.ThriftAppender">
         <param name="Threshold" value="ERROR"/>
         <param name="projectName" value="%YOUR_PROJECT_ID%"/>
         <param name="collectorUrl" value="elsa-v2-col.ncloud.com"/>
         <param name="port" value="10006"/>
         <param name="timeout" value="1200"/>
         <param name="enable" value="true"/>
         <param name="errorCodeType" value="default"/>
         <param name="debug" value="true"/>
     </appender>
     
     [NELO2] Log Append : sent event, return value :
     …