https://github.com/magrossi/es-log4j2-appender

An ElasticSearch REST appender for Log4j2
https://github.com/magrossi/es-log4j2-appender

elasticsearch java-8 log4j2-appender

Last synced: 1 day ago
JSON representation

An ElasticSearch REST appender for Log4j2

• Host: GitHub
• URL: https://github.com/magrossi/es-log4j2-appender
• Owner: magrossi
• License: apache-2.0
• Created: 2017-08-31T15:17:27.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-08-25T08:14:50.000Z (about 5 years ago)
• Last Synced: 2024-11-15T12:13:14.734Z (2 days ago)
• Topics: elasticsearch, java-8, log4j2-appender
• Language: Java
• Size: 157 KB
• Stars: 27
• Watchers: 4
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ElasticSearch Log4j2 Appender

[![Build Status](https://travis-ci.org/magrossi/es-log4j2-appender.svg?branch=master)](https://travis-ci.org/magrossi/es-log4j2-appender)

[![Code Coverage](https://codecov.io/gh/magrossi/es-log4j2-appender/branch/master/graph/badge.svg)](https://codecov.io/gh/magrossi/es-log4j2-appender)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.magrossi/log4j2-elasticsearch-appender/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.magrossi/log4j2-elasticsearch-appender)

An ElasticSearch REST appender for Log4j2

This is a simple appender that sends your log data JSON formatted directly to ElasticSearch via the REST API. There are options to buffer the logs before sending in bulk. Two options are provided for the buffering of logs.

- **Max Bulk Size:** when set to a value greater than `0` it will buffer messages until `maxBulkSize` is reached, when it will then send the whole lot using ElasticSearch's `_bulk` API (defaults to `200`).

- **Max Delay Time:** similarly to the previous option, `maxDelayTime` will accumulate log messages for up to `maxDelayTime` in milliseconds (counted from the first message received) and it will send the entirety of the accumulated messages in a single bulk (defaults to `2000`ms).

Any combination of the two options can be used. Setting any to `0` effectively disables it, if both are set to `0` logs are sent one by one as soon as they are received.

The appender uses the `JSONLayout` by default, but a custom layout can be provided. The only requirement is that the layout produces an `application/json` content type.

To use it, simply reference this package into your Log4j2 configuration file, and add the appender with as your ElasticSearch nodes as hosts and you're good to go!

```xml

    

        

        

                  name="ELASTIC"

                  

                  maxBulkSize="0" 

                  

                  maxDelayTime="0"

                  

                  esIndex="my-index-"

                  esType="logs"

                  

                  dateFormat="yyyyMMdd"

                  

                  user="${env:myEsUser}"

                  password="${env:myEsPassword}">

            

            

            

        

    

    

        

            

        

    

```