jboss-logging / slf4j-jboss-logging Goto Github PK

SLF4J (1.7.x) Backend for JBoss Logging

License: Apache License 2.0

Java 100.00%

slf4j-jboss-logging's Introduction

JBoss Logging

JBoss Logging is a logging facade which can bind to different log managers allowing your applications to be log manager agnostic.

Usage

JBoss Logging is similar to other logging facades in the way you get a logger and log messages. One thing to note is the format style log methods will only format the message if the log level is enabled. This helps with performance of objects which may have complex toString() methods.

private static final Logger LOGGER = Logger.getLogger(Customer.class);

public Customer getCustomer(final int id) {
    LOGGER.debugf("Looking up customer %d", id);
    try {
        final Customer customer = findCustomer(id);
        LOGGER.tracef("Found customer: %s", customer);
        return customer;
    } catch (Exception e) {
        LOGGER.errorf(e, "Error looking up customer %d", id);
    }
    return null;
}

Supported Log Managers

The following are the supported log managers and listed in the order the attempt to discover the provider is done.

JBoss Log Manager
Log4j 2
SLF4J and Logback
log4j (note this log manager is EOL’d)
Java Util Logging

You can define the specific log manager you want to use by specifying the org.jboss.logging.provider system property. The following is the mapping of the property value to the log manager.

Property Value	Log Manager
jboss	JBoss Log Manager
jdk	Java Util Logging
log4j2	Log4j 2
log4j	log4j
slf4j	SLF4J and Logback

Custom Provider

You can also implement your own org.jboss.logging.LoggerProvider which would be loaded from a ServiceLoader. Simply implement the API and add a META-INF/services/org.jboss.logging.LoggerProvider file with the fully qualified class name of your implementation to your library. If the system property is not defined, your implementation should be discovered.

Maven Dependency

<dependency>
    <groupId>org.jboss.logging</groupId>
    <artifactId>jboss-logging</artifactId>
    <version>${version.org.jboss.logging}</version>
</dependency>

Contributing

See the contributing guide.

slf4j-jboss-logging's People

Contributors

Stargazers

Watchers

Forkers

dmlloyd flashboss jamezp estherml tuijldert ryanemerson rhusar summanetworks garyttierney loicmathieu slyngdk boris-unckel alainlompo joegie

slf4j-jboss-logging's Issues

Add a CONTRIBUTING.md file

Add a contributing file so that contributors know the expectations when contributing. An example can bee seen here https://github.com/resteasy/resteasy-quickstarts/blob/main/CONTRIBUTING.adoc.

JBossLoggerAdapter does not provide a logger name

The logger adapter either has to provide a logger name by setting the name field on construction, or by overriding getName().

Multiple SLF4J Binding warning

Is it possible to mix this with logback or not?

SLF4J: Class path contains multiple SLF4J bindings. SLF4J: Found binding in [jar:file:/C:/Java/vfabric-tc-server-developer-2.8.2.RELEASE/base-instance/wtpwebapps/settleinv/WEB-INF/lib/logback-classic-1.0.11.jar!/org/slf4j/impl/StaticLoggerBinder.class] SLF4J: Found binding in [jar:file:/C:/Java/vfabric-tc-server-developer-2.8.2.RELEASE/base-instance/wtpwebapps/settleinv/WEB-INF/lib/slf4j-jboss-logging-1.0.4.GA.jar!/org/slf4j/impl/StaticLoggerBinder.class] SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation. SLF4J: Actual binding is of type [ch.qos.logback.classic.util.ContextSelectorStaticBinder] Apr 26, 2013 12:14:18 PM org.apache.catalina.core.ApplicationContext log INFO: Initializing Spring root WebApplicationContext

Upgrade slf4j 2.0.6

Upgrade from 1.7.21 to [2.0.5|https://mvnrepository.com/artifact/org.slf4j/slf4j-api/2.0.6]

[FAQ 2.0|https://www.slf4j.org/faq.html#changesInVersion200]
[Git-Tag|https://github.com/qos-ch/slf4j/releases/tag/v_2.0.6]
[Git-Diff|https://github.com/qos-ch/slf4j/compare/v_1.7.21...v_2.0.6]

Replaces https://issues.redhat.com/browse/JBLOGGING-165

Major issue with latest 1.2.1.Final

We had several people reporting issues with the latest versions of Quarkus due to the upgrade to 1.2.1.Final.

See:

I think it's probably due to this commit: 1204d43 .

We downgraded to 1.2.0.Final but we wanted 1.2.1.Final for the license change.

Any chance someone could have a look at this issue and release a 1.2.2.Final? Thanks!

Migrate to using JUnit 5

We should migrate to using JUnit 5 for testing.

Add a README to give more information about the project

A README should be added which informs users and contributors about the project. For contributors there should be a link to some kind of contributors guide. For users it would be nice to have say the Maven GAV and describe what the project actually does.

Add a codeowners file

This allows contributors to know who the code owners are as well as ping the code owner when there is a new PR.

Add a code of conduct

A code of conduct should added to let the community know the expectations when communicating and contributing to this project.

Examples:

MDC.getCopyOfMDC() returns original reference when using SLF4J

JBossMDCAdapter.java line 59 return the original map, rather than a copy of the map, as the method name would suggest.

This can result in unanticipated behavior.

To re-create the issue:

// put value
MDC.put("foo", "bar");

// get copy of MDC
Map copy = MDC.getCopyOfContextMap();

// clear MDC
MDC.clear();

// reset to the original copy
MDC.setContextMap(copy);

System.out.println("MDC.get(\"foo\"): " + MDC.get("foo"));

Do not use the 2.0.x version for the 1.7.x static binding

SLF4J 1.x uses static binding to determine the implementation. This includes a field:

public static String REQUESTED_API_VERSION = "2.0.6";

This version should be moved back to a 1.7.x version even though we compile against 2.0.6 currently. We do test against 1.7 and we should just use that version. Without this change when using 1.7.x the following warning is logged:

SLF4J: The requested version 2.0.6 by your slf4j binding is not compatible with [1.6, 1.7]
SLF4J: See http://www.slf4j.org/codes.html#version_mismatch for further details.

Update license to ASLv2

Update the license to ASL instead of LGPL. This is related to quarkusio/quarkus#12024.

Create a security.txt file

The community should know how to submit security related issues. Adding a security.txt file will help and there is some GitHub integration with a security.txt file, https://en.wikipedia.org/wiki/Security.txt.