Logback SDK v2

Classic/VPC環境で利用できます。

logback SDK v2では、Effective Log Search & Analytics 2.0サービスで提供する logback SDKの使用方法を説明します。

SDKを使用する手順は、次の通りです。

1. 事前準備
2. Dependency追加
3. 基本 Appender設定
4. AsyncAppender設定
5. SDKを使用する

1. 事前準備

logback SDKをインストールするための事前準備事項は、次の通りです。

1. NAVERクラウドプラットフォームコンソールで、プロジェクトを作成します。
2. 作成したプロジェクト詳細情報画面で txtToken値を確認します。
3. logback SDKをダウンロードします。

2. Dependency追加

logback SDK v2をインストールする方法は、次の通りです。

1. ダウンロードした SDKファイルの圧縮を解凍します。

2. pom.xmlファイルに以下のように dependencyを追加します。

   • <systemPath>に各々 coreモジュール(nelo2-java-sdk-core-1.6.6.jar)と logbackモジュール(nelo2-java-sdk-logback-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</groupId>
                <artifactId>nelo2-java-sdk-logback</artifactId>
                <version>1.6.6</version>
                <scope>system</scope>
                <systemPath>/nelo2-java-sdk-logback-1.6.6.jar</systemPath>
            </dependency>
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-classic</artifactId>
                <version>1.1.7</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を設定する方法は、次の通りです。

• logbackは logback.groovy → logback-test.xml → logback.xml 順に設定ファイルを検索します。
  • ここでは logback.xml 文書を基準に説明します。
• ファイル名: logback.xml

1. configurationは、以下の例のように入力します。

   <?xml version="1.0" encoding="UTF-8"?>
   <Configuration status="WARN" shutDownHook="disable">
       <Appenders>
           <Console name="console" target="SYSTEM_OUT">
               <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
           </Console>
           <ThriftAppender>
               <name>nelo</name>
               <collectorUrl>COLLECTOR_HOST</collectorUrl>
               <port>COLLECTOR_PORT</port>
               <projectName>PROJECT_ID</projectName>
               <version>PROJECT_VERSION</version>
               <logType>LOG_TYPE</logType>
               <logSource>LOG_SOURCE</logSource>
           </ThriftAppender>
           <HttpAppender>
               <name>http</name>
               <collectorUrl>COLLECTOR_HOST</collectorUrl>
               <port>COLLECTOR_PORT</port>
               <projectName>PROJECT_ID</projectName>
               <version>PROJECT_VERSION</version>
               <logType>LOG_TYPE</logType>
               <logSource>LOG_SOURCE</logSource>
           </HttpAppender>
       </Appenders>
       <Loggers>
           <Logger name="nelo" level="error" additivity="false">
               <AppenderRef ref="nelo"/>
               <AppenderRef ref="console"/>
           </Logger>
           <Root level="warn">
               <AppenderRef ref="nelo"/>
               <AppenderRef ref="console"/>
           </Root>
       </Loggers>
   </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 logback SDKはログを件数ごとに転送する singleモードとセット単位で転送する bulkモードをサポートします。xml appender設定で isBulkEnabledを true または falseにし、bulkと singleモードの中から選択できます(デフォルト値: true(bulkモード))。
プロトコルに応じて以下のパフォーマンス指標をご参照ください。

• 1分間単一スレッドで 1kb sizeのログを転送する場合の throughput
  • thrift
    • singleモード: 2587.93logs/sec
    • bulkモード: 6492.99logs/sec
  • http
    • singleモード: 595.86logs/sec
    • bulkモード: 4617.98logs/sec

4. AsyncAppender設定

基本的に使用する Appenderに追加として logbackでサポートする AsyncAppenderを使用し、実際のログ転送を別途スレッドで行えます。

以下の例を参照し、AsyncAppenderを設定します。

例)

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" shutDownHook="disable">
    <Appenders>
        <Console name="console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
        <ThriftAppender>
            <name>nelo</name>
            <collectorUrl>COLLECTOR_HOST</collectorUrl>
            <port>COLLECTOR_PORT</port>
            <projectName>PROJECT_ID</projectName>
            <version>PROJECT_VERSION</version>
            <logType>LOG_TYPE</logType>
            <logSource>LOG_SOURCE</logSource>
        </ThriftAppender>
        <HttpAppender>
            <name>http</name>
            <collectorUrl>COLLECTOR_HOST</collectorUrl>
            <port>COLLECTOR_PORT</port>
            <projectName>PROJECT_ID</projectName>
            <version>PROJECT_VERSION</version>
            <logType>LOG_TYPE</logType>
            <logSource>LOG_SOURCE</logSource>
        </HttpAppender>
        <Async name="async">
            <AppenderRef ref="nelo"/>
            <includeLocation>true</includeLocation>
        </Async>
    </Appenders>
    <Loggers>
        <Logger name="nelo" level="error" additivity="false">
            <AppenderRef ref="async"/>
            <AppenderRef ref="console"/>
        </Logger>
        <Root level="warn">
            <AppenderRef ref="nelo"/>
            <AppenderRef ref="console"/>
        </Root>
    </Loggers>
</Configuration>

5. SDKを使用する

以下の Effective Log Search & Analytics 2.0 logback SDKを使用する実際のサンプルコードを参照し、プロジェクトにログを転送します。

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

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

logback SDK v2のトラブルシューティング

logback SDK v2に関して発生し得る問題と解決方法を確認します。

Effective Log Search & Analytics 2.0サーバにログを転送したが、これをウェブで確認できない場合

転送したログをウェブで確認できない場合、以下のように対応します。

1. ログを Effective Log Search & Analytics 2.0収集サーバに転送した後、結果メッセージにエラーがない場合は projectNameが正しいか確認します。
2. 実際にエラーデータが転送されることを確認します。
   • 設定ファイル(logback.xml)で Effective Log Search & Analytics 2.0 NELO appenderの debug プロパティを trueに設定して実行した後、以下のような転送ログが出力されることを確認します。

  <!-- NELO2 Logback Appender -->
  <appender name="nelo-logback" class="com.naver.nelo2.logback.ThriftAppender">
      <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
          <level>ERROR</level>
      </filter>
      <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 :
  …