Getting started

1. Add the dependency

The current project version is 4.0.0, as declared in pom.xml and Changelog.md.

<dependency>
    <groupId>com.agido</groupId>
    <artifactId>logback-elasticsearch-appender</artifactId>
    <version>4.0.0</version>
</dependency>

Gradle:

implementation "com.agido:logback-elasticsearch-appender:4.0.0"

Logback, Logback Access, SLF4J, and the AWS SDK modules are declared with provided scope. Your application must supply the components it uses. For Logback Access, version 4 uses the separately published module:

<dependency>
    <groupId>ch.qos.logback.access</groupId>
    <artifactId>logback-access-common</artifactId>
    <version>2.0.15</version>
</dependency>

2. Add a minimal logback.xml

<configuration>
    <appender name="ELASTIC"
              class="com.agido.logback.elasticsearch.ElasticsearchAppender">
        <url>http://localhost:9200/_bulk</url>
        <index>application-%date{yyyy-MM-dd}</index>
        <headers>
            <header>
                <name>Content-Type</name>
                <value>application/json</value>
            </header>
        </headers>
        <properties>
            <esProperty>
                <name>level</name>
                <value>%level</value>
            </esProperty>
            <esProperty>
                <name>logger</name>
                <value>%logger</value>
            </esProperty>
            <esProperty>
                <name>thread</name>
                <value>%thread</value>
            </esProperty>
            <esProperty>
                <name>stacktrace</name>
                <value>%ex</value>
            </esProperty>
        </properties>
    </appender>

    <root level="INFO">
        <appender-ref ref="ELASTIC"/>
    </root>
</configuration>

The appender always sends @timestamp and message. The example adds four fields generated by Logback's PatternLayout.