SLF4J

Simple Logging Facade for Java
Developer(s)	Ceki Gülcü
Stable release	2.0.9 / September 3, 2023;12 months ago
Repository	github.com/qos-ch/slf4j ;
Written in	Java
Operating system	Cross-platform
Type	Logging Tool
License	MIT License
Website	www.slf4j.org

Last updated September 04, 2024

Simple Logging Facade for Java (SLF4J) provides a Java logging API by means of a simple facade pattern. The underlying logging backend is determined at runtime by adding the desired binding to the classpath and may be the standard Sun Java logging package java.util.logging,^[2] Log4j, Reload4j, Logback^[3] or tinylog.^[4]^[5]

The separation of the client API from the logging backend reduces the coupling between an application and any particular logging framework. This can make it easier to integrate with existing or third-party code or to deliver code into other projects that have already made a choice of logging backend.

SLF4J was created by Ceki Gülcü as a more reliable alternative to Jakarta Commons Logging framework.^[6]^[7] Research in 2013 on 10,000 GitHub projects found that the most popular Java library is SLF4J, along with JUnit, with 30.7% of projects using it.^[8] In January 2021, it was ranked as the second most popular project according to mvnrepository.^[9]

Similarities and differences with log4j 1.x

Five of log4j's six logging levels are used (ERROR, WARN, INFO, DEBUG, TRACE). FATAL has been dropped on the basis that inside the logging framework is not the place to decide when an application should terminate and therefore there is no difference between ERROR and FATAL from the logger's point of view. In addition, SLF4J markers offer a more general method for tagging log statements. For example, any log statement of level ERROR can be tagged with the "FATAL" marker.
Logger instances are created via the LoggerFactory, which is very similar in log4j. For example,
```
privatestaticfinalLoggerLOG=LoggerFactory.getLogger(Wombat.class);
```
In Logger, the logging methods are overloaded with forms that accept one, two or more values.^[10] Occurrences of the simple pattern {} in the log message are replaced in turn with the values. This is simple to use yet provides a performance benefit when the values have expensive toString() methods. When logging is disabled at the given level, the logging framework does not need to evaluate the string representation of the values, or construct a log message string that is never actually logged. In the following example, string concatenation and toString() method for the values count or userAccountList are performed only when DEBUG is enabled.

LOG.debug("There are now "+count+" user accounts: "+userAccountList);// slowerLOG.debug("There are now {} user accounts: {}",count,userAccountList);// faster

Similar methods exist in Logger for isDebugEnabled() etc. to allow more complex logging calls to be wrapped so that they are disabled when the corresponding level is disabled, avoiding unnecessary processing.
Unlike log4j, SLF4J offers logging methods that accept markers. These are special objects that enrich the log messages. At present time, logback is the only framework which makes use of markers.

Similarities and differences with log4j 2.x

Apache log4j 2.x supports all slf4j features.^[11]

Version history

Version 2

Version 2.0.0 was released on 2022-08-20. The latest version 2 release is 2.0.9 (2023-09-03).^[12]

Significant changes and feature additions:

Support for lambda syntax in passing messages to be logged.
Addition of a Fluent API.
Requires Java 8 or later.

Version 1

Version details can be found in the manual.

Significant versions include:

Version 1.7.36 and all newer releases are reproducible.
Version 1.7.35 slf4j-log4j12 module is replaced by slf4j-reload4j.
Version 1.7.33 adds support for reload4j via the slf4j-reload4j module. It is the latest stable release. See Download product page.
Version 1.7.5 yielded significant improvement in logger retrieval times.
Version 1.7.0 added support for varargs, requiring support for Java 5 or later.
Version 1.6 brought a no-operation implementation used by default if no binding found.
Version 1.1 releases in Maven repositories began 2006-09.

Related Research Articles

Jakarta EE, formerly Java Platform, Enterprise Edition and Java 2 Platform, Enterprise Edition (J2EE), is a set of specifications, extending Java SE with specifications for enterprise features such as distributed computing and web services. Jakarta EE applications are run on reference runtimes, which can be microservices or application servers, which handle transactions, security, scalability, concurrency and management of the components they are deploying.

Cocoa is Apple's native object-oriented application programming interface (API) for its desktop operating system macOS.

<span class="mw-page-title-main">GNUstep</span> Open source widget toolkit and application development tools

GNUstep is a free software implementation of the Cocoa Objective-C frameworks, widget toolkit, and application development tools for Unix-like operating systems and Microsoft Windows. It is part of the GNU Project.

The bridge pattern is a design pattern used in software engineering that is meant to "decouple an abstraction from its implementation so that the two can vary independently", introduced by the Gang of Four. The bridge uses encapsulation, aggregation, and can use inheritance to separate responsibilities into different classes.

In computing, aspect-oriented programming (AOP) is a programming paradigm that aims to increase modularity by allowing the separation of cross-cutting concerns. It does so by adding behavior to existing code without modifying the code, instead separately specifying which code is modified via a "pointcut" specification, such as "log all function calls when the function's name begins with 'set'". This allows behaviors that are not central to the business logic to be added to a program without cluttering the code of core functions.

XML Interface for Network Services (XINS) is an open-source technology for definition and implementation of internet applications, which enforces a specification-oriented approach.

Apache Log4j is a Java-based logging utility originally written by Ceki Gülcü. It is part of the Apache Logging Services, a project of the Apache Software Foundation. Log4j is one of several Java logging frameworks.

In the Java computer programming language, an annotation is a form of syntactic metadata that can be added to Java source code. Classes, methods, variables, parameters and Java packages may be annotated. Like Javadoc tags, Java annotations can be read from source files. Unlike Javadoc tags, Java annotations can also be embedded in and read from Java class files generated by the Java compiler. This allows annotations to be retained by the Java virtual machine at run-time and read via reflection. It is possible to create meta-annotations out of the existing ones in Java.

Poppler is a free and open-source software library for rendering Portable Document Format (PDF) documents. Its development is supported by freedesktop.org. Commonly used on Linux systems, it powers the PDF viewers of the GNOME and KDE desktop environments.

A Java logging framework is a computer data logging package for the Java platform. This article covers general purpose logging frameworks.

Google Web Toolkit, or GWT Web Toolkit, is an open-source set of tools that allows web developers to create and maintain JavaScript front-end applications in Java. It is licensed under Apache License 2.0.

Jakarta Mail is a Jakarta EE API used to send and receive email via SMTP, POP3 and IMAP. Jakarta Mail is built into the Jakarta EE platform, but also provides an optional package for use in Java SE.

<span class="mw-page-title-main">YUI Library</span>

The Yahoo! User Interface Library (YUI) is a discontinued open-source JavaScript library for building richly interactive web applications using techniques such as Ajax, DHTML, and DOM scripting. YUI includes several cores CSS resources. It is available under a BSD License. Development on YUI began in 2005 and Yahoo! properties such as My Yahoo! and the Yahoo! front page began using YUI in the summer of that year. YUI was released for public use in February 2006. It was actively developed by a core team of Yahoo! engineers.

Clutter is a discontinued GObject-based graphics library for creating hardware-accelerated user interfaces. Clutter is an OpenGL-based 'interactive canvas' library and does not contain any graphical control elements. It relies upon OpenGL (1.4+) or OpenGL ES for rendering,. It also supports media playback using GStreamer and 2D graphics rendering using Cairo.

<span class="mw-page-title-main">Vaadin</span> Web development platform written in Java

Vaadin is an open-source web application development platform for Java. Vaadin includes a set of Web Components, a Java web framework, and a set of tools that enable developers to implement modern web graphical user interfaces (GUI) using the Java programming language only, TypeScript only, or a combination of both.

Spring Roo is an open-source software tool that uses convention-over-configuration principles to provide rapid application development of Java-based enterprise software. The resulting applications use common Java technologies such as Spring Framework, Java Persistence API, Thymeleaf, Apache Maven and AspectJ. Spring Roo is a member of the Spring portfolio of projects.

Canigó is the name chosen for the Java EE framework of the Generalitat de Catalunya.

Enduro/X is an open-source middleware platform for distributed transaction processing. It is built on proven APIs such as X/Open group's XATMI and XA. The platform is designed for building real-time microservices based applications with a clusterization option. Enduro/X functions as an extended drop-in replacement for Oracle Tuxedo. The platform uses in-memory POSIX Kernel queues which insures high interprocess communication throughput.

Apache Commons Logging is a Java-based logging utility and a programming model for logging and for other toolkits. It provides APIs, log implementations, and wrapper implementations over some other tools.

Log4Shell (CVE-2021-44228) is a zero-day vulnerability in Log4j, a popular Java logging framework, involving arbitrary code execution. The vulnerability had existed unnoticed since 2013 and was privately disclosed to the Apache Software Foundation, of which Log4j is a project, by Chen Zhaojun of Alibaba Cloud's security team on 24 November 2021. Before an official CVE identifier was made available on 10 December 2021, the vulnerability circulated with the name "Log4Shell", given by Free Wortley of the LunaSec team, which was initially used to track the issue online. Apache gave Log4Shell a CVSS severity rating of 10, the highest available score. The exploit was simple to execute and is estimated to have had the potential to affect hundreds of millions of devices.

References

↑ "SLF4J News". slfj4.org. 2023-09-03.
↑ java.util.logging
↑ logback
↑ tinylog
↑ "SLF4J binding for tinylog". Archived from the original on 2017-12-07. Retrieved 2014-12-16.
↑ "Think again before adopting the commons-logging API"
↑ "Taxonomy of class loader problems encountered when using Jakarta Commons Logging"
↑ "We Analyzed 30,000 GitHub Projects – Here Are The Top 100 Libraries in Java, JS and Ruby". Archived from the original on 2014-07-09. Retrieved 2014-02-09.
↑ Nicolas, Frenkel. ""most popular" section". Twitter. Retrieved 2022-01-16.
↑ SLF4J api docs: Logger
↑ Apache log4j 2.x slf4j Binding
↑ "SLF4J News". www.slf4j.org. Retrieved 2023-11-27.

External links

Official website

This page is based on this Wikipedia article
Text is available under the CC BY-SA 4.0 license; additional terms may apply.
Images, videos and audio are available under their respective licenses.

[1] "SLF4J News". slfj4.org. 2023-09-03.

[2] va.util.logging

[3] ↑ logback

[4] tinylog

[5] "SLF4J binding for tinylog". Archived from the original on 2017-12-07. Retrieved 2014-12-16.

[6] "Think again before adopting the commons-logging API"

[7] "Taxonomy of class loader problems encountered when using Jakarta Commons Logging"

[8] "We Analyzed 30,000 GitHub Projects – Here Are The Top 100 Libraries in Java, JS and Ruby". Archived from the original on 2014-07-09. Retrieved 2014-02-09.

[9] Nicolas, Frenkel. ""most popular" section". Twitter. Retrieved 2022-01-16.

[10] SLF4J api docs: Logger

[11] Apache log4j 2.x slf4j Binding

[12] "SLF4J News". www.slf4j.org. Retrieved 2023-11-27.

[1]

[2]

[3]

[4]

[5]

[6]

[7]

[8]

[9]

[10]

[11]

[12]