README.md

Log4J2 Utilities

This library provides a multitude of Log4J 2.x Appenders:

• Netty TCP
• Slack
• Discord using the Slack Appender
• Sentry

This library also provides the following logging layouts:

• Bunyan - at a very basic level
• Logstash
  • Send logging events to Logstash using TCP - combine the Netty TCP appender with the Logstash layout
• SlackLayout - for sending events to Slack/Discord

Adding additional context information to a LogEvent

• Utilize the ContextualMessage class to add additional KVs to a logging event before sending it to a specific destination

Built-in Logging Message Queueing

• The Netty TCP Appender will automatically queue messages to the local filesystem if it is unable to send messages to TCP. Once network connectivity is restored, these messages are delivered.

Automatic HTTP Client Selection

• The Slack/Discord Appenders will automatically select a suitable HTTP client based on the dependencies located at runtime:
• The priority for HTTP client selection is as follows:
  • async-http-client
  • Apache HTTP Client 5.x
  • Apache HTTP Client 4.x

Build Requirements

• Maven 3.2.5 (at a minimum), the latest version is recommended
• Java 11 (we do not provide support for Java 8 as it is nearing end-of-life)