概要

SLF4j ( The Simple Logging Facade for Java ) を使って JSON フォーマットのログを出力してみました

環境

JDK 1.8.0_25
Maven 3.2.1
Eclipse Luna 4.4.1
SLF4j 1.6.6
Jackson 2.5.3

ソースコード

プロジェクト名を「test」
Group Id を「test」
Artifact Id を「test」
として Maven プロジェクトを Eclipse で作成した体で話を進めます

pom.xml

/path/to/project/test/pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>test</groupId>
    <artifactId>test</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>test</name>
    <url>http://maven.apache.org</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.6.6</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jcl-over-slf4j</artifactId>
            <version>1.6.6</version>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.6.6</version>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.5.3</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.5.3</version>
        </dependency>
    </dependencies>
</project>

log4j.xml

/path/to/project/test/src/main/resources/log4j.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN" "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

    <!-- Appenders -->
    <appender name="console" class="org.apache.log4j.ConsoleAppender">
        <param name="Target" value="System.out" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%m%n" />
        </layout>
    </appender>
    <appender name="file" class="org.apache.log4j.DailyRollingFileAppender">
        <param name="File" value="sample.json" />
        <param name="Append" value="true" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%m%n" />
        </layout>
    </appender>

    <!-- Application Loggers -->
    <logger name="test.test">
        <level value="debug" />
        <appender-ref ref="file" />
        <appender-ref ref="console" />
    </logger>

    <!-- Root Logger -->
    <root>
        <priority value="warn" />
    </root>

</log4j:configuration>

AppTest.java

/path/to/test/src/main/java/test/test/App.java

package test.test;

import java.text.SimpleDateFormat;
import java.util.Date;

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

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;

public class App {

    private static final Logger JSON_LOGGER = LoggerFactory.getLogger(App.class);

    public static void main(String[] args) {
        Data d = new Data();
        d.user = "user";
        d.age = 30;
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'hh:mm:ssZ");
        d.date = sdf.format(new Date());
        ObjectMapper mapper = new ObjectMapper();
        String json = null;
        try {
            json = mapper.writeValueAsString(d);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
        JSON_LOGGER.debug(json);
    }
}

class Data {
    public String user;
    public int age;
    public String date;
}

実行結果

こんな感じの JSON が出力されます

{"user":"user","age":30,"date":"2016-02-22T08:08:29+0900"}

ポイント

logj4.xml でロギングのパターンを指定するときにメッセージだけを出力するように設定します

<param name="ConversionPattern" value="%m%n" />

必要な情報はすべて JSON 文字列内に含めるようにします
App.java で出力する JSON 情報を作成します
Data というクラスを作成してこのクラスのオブジェクトを JSON オブジェクトにシリアライズすることでログを出力します

Data d = new Data();
d.user = "user";
d.age = 30;
// ･･･
String json = null;
json = mapper.writeValueAsString(d);
// ･･･
JSON_LOGGER.debug(json);

最後に

SLF4j を使って JSON ログを出力する方法を紹介しました
log4j2 に JSONLayout というフォーマットがあるのですが、これがあまりいけてなく独自で出力してみました

今回はログ出力に必要なクラスを作成して対応しましたが、key, value の種類が変わるような場合には Map を使っても可能です
データ構造が決まっている場合はクラスを使えば OK です

これで td-agent を使って簡単にログ集計できるようになると思います

hawksnowlog

2017年3月10日金曜日

SLF4j を使って JSON フォーマットのログを出力する方法

概要

環境