att / eelf Goto Github PK

Event and Error Logging Framework

Java 100.00%

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 >

eelf's People

Contributors

Stargazers

Watchers

Forkers

gg4126

eelf's Issues

Security issue with logback

The ONAP projects from OpenECOMP uses EELF. They are being flagged with security issue due to EELF dependency logback:
http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2017-5929

Can you upgrade the version of logback above 1.2 and release an upgraded artifact?

Build failure on artifact signing - missing secret

Looking into removing security

[INFO] Scanning for projects...
[WARNING]
[WARNING] Some problems were encountered while building the effective model for com.att.eelf:eelf-core:jar:1.0.0
[WARNING] 'build.plugins.plugin.(groupId:artifactId)' must be unique but found duplicate declaration of plugin org.codehaus.mojo:cobertura-maven-plugin @ line 218, column 16
[WARNING] 'build.plugins.plugin.(groupId:artifactId)' must be unique but found duplicate declaration of plugin com.att.eelf:eelf-maven-plugin @ line 272, column 18
[WARNING] 'build.plugins.plugin.version' for org.apache.maven.plugins:maven-javadoc-plugin is missing. @ line 174, column 13
[WARNING]
[WARNING] It is highly recommended to fix these problems because they threaten the stability of your build.
[WARNING]
[WARNING] For this reason, future Maven versions might no longer support building such malformed projects.
[WARNING]
[INFO] Inspecting build with total of 1 modules...
[INFO] Installing Nexus Staging features:
[INFO] ... total of 1 executions of maven-deploy-plugin replaced with nexus-staging-maven-plugin
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Event and Error logging framework 1.0.0
[INFO] ------------------------------------------------------------------------
[INFO] Downloading: https://nexus.opendaylight.org/content/repositories/public/com/att/eelf/eelf-maven-plugin/1.0.0/eelf-maven-plugin-1.0.0.pom
[INFO] Downloaded: https://nexus.opendaylight.org/content/repositories/public/com/att/eelf/eelf-maven-plugin/1.0.0/eelf-maven-plugin-1.0.0.pom (9 KB at 11.0 KB/sec)
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ eelf-core ---
[WARNING] File encoding has not been set, using platform encoding UTF-8, i.e. build is platform dependent!
[WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] Copying 2 resources
[INFO]
[INFO] --- maven-compiler-plugin:2.3.2:compile (default-compile) @ eelf-core ---
[INFO] Nothing to compile - all classes are up to date
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ eelf-core ---
[WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] Copying 7 resources
[INFO]
[INFO] --- maven-compiler-plugin:2.3.2:testCompile (default-testCompile) @ eelf-core ---
[INFO] Nothing to compile - all classes are up to date
[INFO]
[INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ eelf-core ---
[INFO] Surefire report directory: /root/onap_1228/EELF/EELF/target/surefire-reports
[INFO] Downloading: https://nexus.opendaylight.org/content/repositories/public/org/apache/maven/surefire/surefire-junit4/2.12.4/surefire-junit4-2.12.4.pom
[INFO] Downloaded: https://nexus.opendaylight.org/content/repositories/public/org/apache/maven/surefire/surefire-junit4/2.12.4/surefire-junit4-2.12.4.pom (3 KB at 20.8 KB/sec)
[INFO] Downloading: https://nexus.opendaylight.org/content/repositories/public/org/apache/maven/surefire/surefire-providers/2.12.4/surefire-providers-2.12.4.pom
[INFO] Downloaded: https://nexus.opendaylight.org/content/repositories/public/org/apache/maven/surefire/surefire-providers/2.12.4/surefire-providers-2.12.4.pom (3 KB at 28.7 KB/sec)
[INFO] Downloading: https://nexus.opendaylight.org/content/repositories/public/org/apache/maven/surefire/surefire-junit4/2.12.4/surefire-junit4-2.12.4.jar
[INFO] Downloaded: https://nexus.opendaylight.org/content/repositories/public/org/apache/maven/surefire/surefire-junit4/2.12.4/surefire-junit4-2.12.4.jar (37 KB at 295.5 KB/sec)

T E S T S

Running com.att.eelf.exception.TestEELFException
Tests run: 3, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.016 sec
Running com.att.eelf.utils.TestStopWatch
Tests run: 5, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.016 sec
Running com.att.eelf.TestPerformanceLogger
Tests run: 7, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.357 sec
Running com.att.eelf.TestExceptionHierarchy
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0 sec
Running com.att.eelf.TestApplicationLogger
Tests run: 14, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.014 sec
Running com.att.eelf.TestServerLogger
Tests run: 7, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.007 sec
Running com.att.eelf.TestAuditLogger
Tests run: 9, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0 sec
Running com.att.eelf.TestErrorLogger
Tests run: 8, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.003 sec
Running com.att.eelf.TestSuite
Tests run: 104, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.111 sec
Running com.att.eelf.TestDebugLogger
Tests run: 8, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.001 sec
Running com.att.eelf.TestMetricsLogger
Tests run: 9, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0 sec
Running com.att.eelf.TestLogger
Tests run: 8, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0 sec
Running com.att.eelf.TestClassLogger
Tests run: 8, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0 sec
Running com.att.eelf.TestSecurityLogger
Tests run: 7, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.001 sec
Running com.att.eelf.TestPolicyLogger
Tests run: 7, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.002 sec
Running com.att.eelf.i18n.TestEELFResourceManager
Tests run: 11, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.002 sec

Results :

Tests run: 216, Failures: 0, Errors: 0, Skipped: 0

[INFO]
[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ eelf-core ---
[INFO] Building jar: /root/onap_1228/EELF/EELF/target/eelf-core-1.0.0.jar
[INFO] META-INF/maven/com.att.eelf/eelf-core/pom.xml already added, skipping
[INFO] META-INF/maven/com.att.eelf/eelf-core/pom.properties already added, skipping
[INFO]
[INFO] --- maven-javadoc-plugin:3.0.0:jar (attach-javadocs) @ eelf-core ---
[INFO] Downloading: https://nexus.opendaylight.org/content/repositories/public/org/apache/maven/shared/maven-artifact-transfer/0.9.1/maven-artifact-transfer-0.9.1.pom
[INFO] Downloaded: https://nexus.opendaylight.org/content/repositories/public/org/apache/maven/shared/maven-artifact-transfer/0.9.1/maven-artifact-transfer-0.9.1.pom (8 KB at 72.8 KB/sec)
[INFO] Downloading: https://nexus.opendaylight.org/content/repositories/public/com/thoughtworks/qdox/qdox/2.0-M7/qdox-2.0-M7.pom
[INFO] Downloaded: https://nexus.opendaylight.org/content/repositories/public/com/thoughtworks/qdox/qdox/2.0-M7/qdox-2.0-M7.pom (16 KB at 161.2 KB/sec)
[INFO] Downloading: https://nexus.opendaylight.org/content/repositories/public/org/codehaus/plexus/plexus-java/0.9.5/plexus-java-0.9.5.pom
[INFO] Downloaded: https://nexus.opendaylight.org/content/repositories/public/org/codehaus/plexus/plexus-java/0.9.5/plexus-java-0.9.5.pom (3 KB at 25.8 KB/sec)
[INFO] Downloading: https://nexus.opendaylight.org/content/repositories/public/org/codehaus/plexus/plexus-languages/0.9.5/plexus-languages-0.9.5.pom
[INFO] Downloaded: https://nexus.opendaylight.org/content/repositories/public/org/codehaus/plexus/plexus-languages/0.9.5/plexus-languages-0.9.5.pom (3 KB at 23.6 KB/sec)
[INFO] Downloading: https://nexus.opendaylight.org/content/repositories/public/org/ow2/asm/asm/6.0/asm-6.0.pom
[INFO] Downloaded: https://nexus.opendaylight.org/content/repositories/public/org/ow2/asm/asm/6.0/asm-6.0.pom (2 KB at 24.5 KB/sec)
[INFO] Downloading: https://nexus.opendaylight.org/content/repositories/public/org/ow2/asm/asm-parent/6.0/asm-parent-6.0.pom
[INFO] Downloaded: https://nexus.opendaylight.org/content/repositories/public/org/ow2/asm/asm-parent/6.0/asm-parent-6.0.pom (6 KB at 40.0 KB/sec)
[INFO] Downloading: https://nexus.opendaylight.org/content/repositories/public/org/apache/maven/shared/maven-artifact-transfer/0.9.1/maven-artifact-transfer-0.9.1.jar
[INFO] Downloaded: https://nexus.opendaylight.org/content/repositories/public/org/apache/maven/shared/maven-artifact-transfer/0.9.1/maven-artifact-transfer-0.9.1.jar (121 KB at 835.0 KB/sec)
[INFO] Downloading: https://nexus.opendaylight.org/content/repositories/public/com/thoughtworks/qdox/qdox/2.0-M7/qdox-2.0-M7.jar
[INFO] Downloaded: https://nexus.opendaylight.org/content/repositories/public/com/thoughtworks/qdox/qdox/2.0-M7/qdox-2.0-M7.jar (308 KB at 2366.6 KB/sec)
[INFO] Downloading: https://nexus.opendaylight.org/content/repositories/public/org/codehaus/plexus/plexus-java/0.9.5/plexus-java-0.9.5.jar
[INFO] Downloaded: https://nexus.opendaylight.org/content/repositories/public/org/codehaus/plexus/plexus-java/0.9.5/plexus-java-0.9.5.jar (32 KB at 387.0 KB/sec)
[INFO] Downloading: https://nexus.opendaylight.org/content/repositories/public/org/ow2/asm/asm/6.0/asm-6.0.jar
[INFO] Downloaded: https://nexus.opendaylight.org/content/repositories/public/org/ow2/asm/asm/6.0/asm-6.0.jar (93 KB at 1033.1 KB/sec)
[WARNING] Source files encoding has not been set, using platform encoding UTF-8, i.e. build is platform dependent!
[INFO]
Loading source files for package com.att.eelf.exception...
Loading source files for package com.att.eelf.utils...
Loading source files for package com.att.eelf.configuration...
Loading source files for package com.att.eelf.i18n...
Constructing Javadoc information...
Standard Doclet version 1.8.0_131
Building tree for all the packages and classes...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/exception/EELFException.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/utils/Stopwatch.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/utils/Stopwatch.StopwatchState.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/configuration/Configuration.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/configuration/EELFLogger.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/configuration/EELFLogger.Level.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/configuration/EELFManager.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/configuration/SLF4jWrapper.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/i18n/EELFMsgs.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/i18n/EELFResolvableErrorEnum.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/i18n/EELFResourceManager.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/overview-frame.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/configuration/package-frame.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/configuration/package-summary.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/configuration/package-tree.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/exception/package-frame.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/exception/package-summary.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/exception/package-tree.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/i18n/package-frame.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/i18n/package-summary.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/i18n/package-tree.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/utils/package-frame.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/utils/package-summary.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/utils/package-tree.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/constant-values.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/serialized-form.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/exception/class-use/EELFException.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/utils/class-use/Stopwatch.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/utils/class-use/Stopwatch.StopwatchState.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/configuration/class-use/EELFManager.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/configuration/class-use/SLF4jWrapper.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/configuration/class-use/Configuration.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/configuration/class-use/EELFLogger.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/configuration/class-use/EELFLogger.Level.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/i18n/class-use/EELFResolvableErrorEnum.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/i18n/class-use/EELFResourceManager.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/i18n/class-use/EELFMsgs.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/configuration/package-use.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/exception/package-use.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/i18n/package-use.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/com/att/eelf/utils/package-use.html...
Building index for all the packages and classes...
Generating /root/onap_1228/EELF/EELF/target/apidocs/overview-tree.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/index-all.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/deprecated-list.html...
Building index for all classes...
Generating /root/onap_1228/EELF/EELF/target/apidocs/allclasses-frame.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/allclasses-noframe.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/index.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/overview-summary.html...
Generating /root/onap_1228/EELF/EELF/target/apidocs/help-doc.html...
[INFO] Building jar: /root/onap_1228/EELF/EELF/target/eelf-core-1.0.0-javadoc.jar
[INFO]
[INFO] --- maven-source-plugin:2.2.1:jar-no-fork (attach-sources) @ eelf-core ---
[INFO] Building jar: /root/onap_1228/EELF/EELF/target/eelf-core-1.0.0-sources.jar
[INFO]
[INFO] --- maven-gpg-plugin:1.5:sign (sign-artifacts) @ eelf-core ---
gpg: keyring /root/.gnupg/secring.gpg' created gpg: keyring /root/.gnupg/pubring.gpg' created
gpg: no default secret key: secret key not available
gpg: signing failed: secret key not available
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 9.936 s
[INFO] Finished at: 2017-12-31T21:43:09-06:00
[INFO] Final Memory: 27M/365M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-gpg-plugin:1.5:sign (sign-artifacts) on project eelf-core: Exit code: 2 -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException

Live project - see http://mavencentral.it.att.com:8084/nexus/content/repositories/swm-releases/com/att/eelf/eelf-core/

Just wondering if this project is in line with the 1.0.0 version in nexus - looks like it.
https://github.com/att/EELF/blob/master/EELF/pom.xml
http://mavencentral.it.att.com:8084/nexus/content/repositories/swm-releases/com/att/eelf/eelf-core/
thank you
/michael

http://wiki.web.att.com not routable from eelf-core/pom.xml

Recommend Projects

React

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

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

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.