Giter VIP home page Giter VIP logo

eelf's Introduction

#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 >

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.