kiwiproject / dropwizard-elk-appender Goto Github PK

View Code? Open in Web Editor NEW

2.0 3.0 0.0 224 KB

Dropwizard Logging Appender to send logging events to the ELK stack

License: MIT License

Shell 19.49% Java 80.51%

dropwizard elk-stack java logging

dropwizard-elk-appender's Introduction

Dropwizard ELK Appender

Dropwizard Logging Appender to send logging events to the ELK stack.

How to use

Install library with Maven:

    <dependency>
        <groupId>org.kiwiproject</groupId>
        <artifactId>dropwizard-elk-appender</artifactId>
        <version>[current-version]</version>
    </dependency>

Add to Dropwizard config:

    logging:
      level: WARN
      appenders:
        - type: elk
          host: localhost
          port: 9000

Properties that can be set in the config:

Property Name	Default	Description
host (required)	blank	Hostname for the logstash server
port (required)	0	Port (greater than zero) for the logstash server
includeCallerData	false	Whether the calling data gets included in the message to logstash
includeMdc	true	Whether to include the MDC in the message to logstash
includeContext	true	Whether to include the logging context in the message to logstash
customFields	empty	Map of custom fields that are to be sent to logstash for processing
fieldNames	empty	Map of field name mappings if overrides are needed

dropwizard-elk-appender's People

Contributors

Stargazers

Watchers

dropwizard-elk-appender's Issues

Add badge for javadoc.io

[![javadoc](https://javadoc.io/badge2/org.kiwiproject/dropwizard-elk-appender/javadoc.svg)](https://javadoc.io/doc/org.kiwiproject/dropwizard-elk-appender)

Manage kiwi dependency version

Currently when we release retrying-again, kiwi, and kiwi-test it forces us to release all our other libraries in kiwiproject. As long as the updates to these pure utility libraries are 100% backwards compatible, then it should be safe to update them without having to update every other library.

This task is to add a dependencyManagement section to the POM to control the version of these libraries and avoid all the downstream convergence errors. It will allow us to release them on a more frequent cadence, since they are the ones that change more frequently.

Use kiwi-parent as parent POM

Fix code scanning alert - Missing Override annotation

Tracking issue for:

https://github.com/kiwiproject/dropwizard-elk-appender/security/code-scanning/1

Normally I would dismiss this since Lombok is generating the setters. But, investigate a bit more since this is extending a third party library class.

io.dropwizard.logging.AppenderFactory must be renamed

io.dropwizard.logging.AppenderFactory must be renamed to io.dropwizard.logging.common.AppenderFactory to match the package structure in Dropwizard 3+

Without doing this, Dropwizard can't find the ElkAppenderFactory classs, which causes startup to fail because of a ConfigurationPartsingException caused by:

Could not resolve type id 'elk' as a subtype of `io.dropwizard.logging.common.AppenderFactory...
(more details elided)

See Upgrade Notes for Dropwizard 3.0.x

Bump kiwi-parent to 0.4.0

Remove junit-pioneer after update to kiwi-parent 0.10.0

kiwi-parent 0.10.0 adds junit-pioneer so it isn't needed explicitly anymore

Do not allow releases if repository is not up to date

If the repository is not up to date, print a warning and exit the release script.

Support Java 16

Add lombok.addLombokGeneratedAnnotation=true to Lombok config

Create initial repo

Setup boilerplate project with the following:

README
travis
pom
license
Sonar

Support UDP and TCP

Create appender

Add slf4j-api and logback-classic back into POM

kiwi-parent 2.0.0 removed slf4j-api and logback-classic and they are now controlled only in the BOM (kiwi-bom). So, they need to be explicitly added back to the POM, but don't need version specified. slf4j-api should be compile scope (default) and logback-classic should be test scope.

The workflow should be manually triggered.