Event and Error Logging Framework
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
EELF-Maven-Plugin
EELF-Samples
EELF
Contributing.txt
Jenkinsfile
License.txt
README.md

README.md

#EVENT and ERROR LOGGING FRAMEWORK

##OVERVIEW

Event and Error Logging Framework aka EELF, builds on top of existing logging frameworks, adding the I18N support in a standard way,and also provides the ability to generate wiki documentation from the message definitions. The framework includes classes with numerous convenience methods to perform logging operations with ease.

    EELF API and Features


    • Pluggable Logging framework built on SLF4j
    • Message Logging with error codes 
    • Resource Management of resource bundles 
    • Load Resource Bundles
    • Format Message Resources
    • Exception Formatting
    • Wiki Content generation from the message definitions
    • Ability to capture exception hierarchy
    • Internationalization/Localization support

###REQUIREMENTS

Java 7 and above, Maven

##BUILD & RUN

Maven can be used to build

##CONFIGURATION

This project contains the main library.. Any application using EELF has to include eelf-core as the dependency in pom.xml.

    < dependency > 
    < groupId > </ groupId > 
    < artifactId > eelf-core</ artifactId > 
    < version >${eelf.version}</ version > 
    </ dependency >

This project contains the maven plugin to generate wiki page. The wiki page will contain the list of error codes along with its description and resolution. .

    < plugin > 
        < groupId >  </ groupId > 
        < artifactId >eelf-maven-plugin</ artifactId > 
        < version >${eelf.maven.plugin.version}</ version > 
        < executions > 
        < execution > 
        < phase >install</ phase > 
        < goals > 
        < goal >WikiMsgGenerator</ goal > 
        </ goals > 
        </ execution >  
      </ executions > 
      < dependencies > 
        <!-- We need to include the dependency of the project so that its include in classpath when running plugin --> 
        < dependency > 
        < groupId ></ groupId > 
        < artifactId > eelf-samples</ artifactId > 
        < version >${project.version}</ version > 
        </ dependency > 
      </ dependencies > 
      < configuration > < outputDirectory >target/messages</ outputDirectory > 
        < outputFile >messages.html</ outputFile > 
        < wiki > 
        < title >Messages and Codes</ title > 
     < page >APP Messages and Codes</ page > 
     < principal >user</ principal > 
     < credentials >password</ credentials > 
     < url ></ url > 
     </ wiki > 
     < resources > 
     < resource > 
     <!-- Provide enum class created for your application --> 
     < messageClass >com.att.eelf.sample.ApplicationMsgs</ messageClass > 
     < header ><![CDATA[<p> <ac:macro ac:name="toc"/> </p>
     <p>
     <ac:macro ac:name="anchor"> 
     <ac:default-parameter>Application Messages</ac:default-parameter> 
     </ac:macro> </p> <h2>Application Messages</h2>]]></ header > 
     </ resource > 
     </ resources > 
     </ configuration > 
     </ plugin >