[java] Log4j의 SMTP Appender

23 Nov 2023

java

Log4j는 Java에서 로깅을 위해 주로 사용되는 라이브러리로, 다양한 로깅 기능을 제공합니다. Log4j는 애플리케이션에서 발생하는 로그 메시지를 다양한 출력 대상으로 전송할 수 있습니다. 이 중에 SMTP Appender는 로그 메시지를 이메일로 전송하는 기능을 제공합니다.

SMTP Appender 설정하기

SMTP Appender를 설정하려면 다음과 같은 단계를 따라야 합니다.

먼저, Log4j의 XML 설정 파일 또는 프로그래밍적으로 설정하는 방법을 선택합니다.

설정 파일에 SMTP Appender를 추가합니다. 다음은 기본적인 SMTP Appender의 설정 예시입니다.

<appender name="smtpAppender" class="org.apache.log4j.net.SMTPAppender">
    <param name="BufferSize" value="10" />
    <param name="SMTPHost" value="smtp.example.com" />
    <param name="SMTPPort" value="587" />
    <param name="SMTPUsername" value="your_username" />
    <param name="SMTPPassword" value="your_password" />
    <param name="From" value="log@example.com" />
    <param name="To" value="admin@example.com" />
    <param name="Subject" value="Log Event" />
    <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern" value="%d{ISO8601} [%t] %-5p %c{1}:%L - %m%n" />
    </layout>
</appender>

위 예시에서는 SMTP 호스트, 포트, 사용자 이름 및 비밀번호, 발신자 및 수신자 이메일 주소, 제목 등의 정보를 설정합니다. BufferSize는 전송 대기중인 로그 이벤트의 수를 제한하는 매개변수입니다.

필요한 경우, 패턴 레이아웃을 사용하여 로그 이벤트 포맷을 지정할 수 있습니다. 위 예시에서는 ConversionPattern에 로그 메시지를 어떻게 포맷할지를 정의하였습니다.

마지막으로, Logger의 Appender에 SMTP Appender를 추가하여 이메일로 로그를 전송할 수 있습니다.

<logger name="com.example">
    <level value="debug" />
    <appender-ref ref="smtpAppender" />
</logger>

SMTP Appender는 Log4j의 다양한 설정 및 기능을 활용하여 로그 이메일을 세밀하게 제어할 수 있습니다. 또한, 추가적인 속성을 설정하여 첨부 파일을 포함하거나 특정 이벤트에만 이메일을 전송할 수도 있습니다.

참고 자료

Apache Log4j Documentation