Splunk Java Logging Framework

The purpose of this project is to create a logging framework to allow developers to as seamlessly as possible integrate Splunk best practice logging semantics into their code. There are also custom handler/appender implementations for the 3 most prevelent Java logging frameworks in play.

1. LogBack
2. log4j
3. java.util logging

This framework contains :

• Implementation of Splunk CIM(Common Information Model) and best practice logging semantics

• java.util.logging handler for logging to Splunk REST endpoints

• log4j appender for logging to Splunk REST endpoints

• Logback appender for logging to Splunk REST endpoints

• Example logging configuration files

• Javadocs

License

The Splunk Java Logging Framework is licensed under the Creative Commons 3.0 License. Details can be found in the file LICENSE.

Quick Start

1. Untar releases/splunklogging-0.1.0.tar.gz
2. All the required jar files are in the lib directory..
3. Assume you know how to setup your classpath to use your preferred logging framework implementation.
4. There is simple code example here https://github.com/damiendallimore/SplunkJavaLogging/blob/master/src/com/dtdsoftware/splunk/logging/examples/Example.java
5. There are sample logging config files in the config directory for the 3 logging frameworks

Splunk

If you haven't already installed Splunk, download it here: http://www.splunk.com/download. For more about installing and running Splunk and system requirements, see Installing & Running Splunk (http://dev.splunk.com/view/SP-CAAADRV).

Contribute

Get the Splunk Java Logging Framework from GitHub (https://github.com/) and clone the resources to your computer. For example, use the following command:

git clone https://github.com/damiendallimore/SplunkJavaLogging.git

Resources

Splunk Common Information Model

• http://docs.splunk.com/Documentation/Splunk/latest/Knowledge/UnderstandandusetheCommonInformationModel

Splunk Best Practice Logging Semantics

• http://dev.splunk.com/view/logging-best-practices/SP-CAAADP6

Introduction to the Splunk product and some of its capabilities

• http://docs.splunk.com/Documentation/Splunk/latest/User/SplunkOverview

Contact

This project was initiated by Damien Dallimore

Email	damien@dtdsoftware.com
Twitter	@damiendallimore
Splunkbase.com	damiend