beamly / flumeback

Apache License 2.0 GitHub

A Logback appender for Flume

Flumeback

Latest Version License Scaladoc

Build Status Dependency Status Repo Size

A logback appender for Apache Flume, currently logs using HTTP/JSON.

Developed to configure our Play apps to log to our Flume setup.

How to Use

Add flumeback to your build system.

For sbt:

"com.beamly.flumeback" %% "flumeback" % "0.4.0"

For maven:

<dependency>
  <groupId>com.beamly.flumeback</groupId>
  <artifactId>flumeback_${scala.binary}</artifactId>
  <version>0.4.0</version>
</dependency>

(where scala.binary is defined somewhere as 2.11 or 2.10)

Configure logback

Add to logback.xml (conf/application-logger.xml for Play):

<appender name="FLUMEBACK" class="flumeback.FlumebackAppender" />

You can override the default settings within the appender. Here is an example with its defaults:

<appender name="FLUMEBACK" class="flumeback.FlumebackAppender">
  <host>localhost</host>
  <port>16301</port>
</appender>

Dependencies

  • Scala 2.11.x or 2.10.x
  • Logback 1.1.x
  • JSON4S 3.2.x

How to Release

  • Bump version in README
  • sbt release, responding to prompt as such (for example): Release (relative) version: 3 Next release series [0.1]: [CTRL-D] [info] Not bumping release series Next (relative) version: 4-SNAPSHOT
  • sbt sonatypeRelease
  • git push --follow-tags
  • git checkout the tag again
  • sbt ghpagesPushSite