| Developed by | Apache Software Foundation |
|---|---|
| Latest release | 1.2.15 / 29 September 2007 |
| Written in | Java |
| OS | Cross-platform |
| Type | Logging Tool |
| License | Apache License 2.0 |
| Website | logging.apache.org/log4j |
Apache log4j is a Java-based logging utility. It was originally written by Ceki Gülcü and is now a project of the Apache Software Foundation. log4j is one of several Java Logging Frameworks.
Ceki Gülcü has since started the SLF4J[1] and Logback projects, with the intention of offering a compatible successor to log4j.
Contents |
Log Level
The following table defines the log levels and messages in Log4j, in decreasing order of severity. The left column lists the log level designation in Log4j and the right column provides a brief description of each log level.
| level | Description |
|---|---|
| FATAL | Severe errors that cause premature termination. Expect these to be immediately visible on a status console. |
| ERROR | Other runtime errors or unexpected conditions. Expect these to be immediately visible on a status console. |
| WARN | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". Expect these to be immediately visible on a status console. |
| INFO | Interesting runtime events (startup/shutdown). Expect these to be immediately visible on a console, so be conservative and keep to a minimum. |
| DEBUG | detailed information on the flow through the system. Expect these to be written to logs only. |
| TRACE | more detailed information. Expect these to be written to logs only. |
Configuration
There are two ways to configure log4j. One is with a properties file and the other is with an XML file. Within either you can define 3 main components: Loggers, Appenders and Layouts. Configuring logging via a file has the advantage of turning logging on or off without modifying the application that uses log4j. The application can be allowed to run with logging off until there's a problem, for example, and then logging can be turned back on simply by modifying the configuration file.
Loggers are logical log file names. They are the names that are known to the Java application. Each logger is independently configurable as to what level of logging (FATAL, ERROR, etc) it currently logs. In early versions of log4j, these were called category and priority, but now they're called logger and level, respectively.
The actual outputs are done by Appenders. There are numerous Appenders available, with descriptive names, such as FileAppender, ConsoleAppender, SocketAppender, SyslogAppender, NTEventLogAppender and even SMTPAppender. Multiple Appenders can be attached to any Logger, so it's possible to log the same information to a file locally and to a socket listener on another computer, for example.
Appenders use Layouts to format log entries. A popular way to format one-line-at-a-time log files is PatternLayout, which uses a pattern string, much like the C / C++ function printf. There are also HTMLLayout and XMLLayout formatters for use when HTML or XML formats are more convenient, respectively.
Example
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE log4j:configuration PUBLIC "http://logging.apache.org/log4j/docs/api/org/apache/log4j/xml/log4j.dtd"> <log4j:configuration> <!-- an appender is an output destination, such as e.g. the console or a file; names of appenders are arbitrarily chosen--> <appender name="stdout" class="org.apache.log4j.ConsoleAppender"> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d{ABSOLUTE} %5p %c{1}:%L - %m%n" /> </layout> </appender> <!-- loggers of category 'org.springframework' will only log messages of level info or higher; if you retrieve Loggers by using the class name (e.g. Logger.getLogger(AClass.class)) and if AClass is part of the springframework.org package, it will belong to this category --> <logger name="org.springframework"> <level value="info"/> </logger> <!-- everything of spring was set to info but for class PropertyEditorRegistrySupport we do want debug logging --> <logger name="org.springframework.beans.PropertyEditorRegistrySupport"> <level value="debug"/> </logger> <logger name="org.acegisecurity"> <level value="info"/> </logger> <root><!-- the root category --> <!-- all log messages of level debug or more serious will be logged, unless defined otherwise --> <!-- all log messages will be logged to the appender 'stdout', unless defined otherwise --> <level value="debug" /> <appender-ref ref="stdout" /> </root> </log4j:configuration>
Log4j in Application Server like Tomcat etc.
Just Adding log4j.properties & logger statement in java code doesn't generate log files in the case of the Application Server such as Tomcat. Following method can be added in the Main class & should be called via suitable methods
public void initLogging(){
try{
URL fl = this.getClass().getClassLoader().getResource("log4j.properties");
PropertyConfigurator.configure(fl);
logger.debug("Reloading log4j.properties file.");
}
catch(Exception e)
{
logger.error(e);
}
}
Following should be added in the log4j.properties is also needed. log4j.logger.<Your_Package_Name>=<LOG_LEVEL Such as Debug etc>
Log viewer
Apache has another project named Chainsaw which was intended to use log4j generated log files. Chainsaw is a java-based GUI viewer with a lot of functionality. Chainsaw also uses similar configuration file as log4j. Other log viewing tools can be used with log4j too, for example log2web, which is open source and web-based, but has fewer features than Chainsaw. Log4J log file contain semi structured information about application problems, in some cases you would run log analysis on the logs in order to detect bugs, errors and generate statistics.
See also
- SLF4J
- Chainsaw
External links
- Short introduction to log4j
- Official log4j Homepage
- Log Viewer: a commercial, log4j log viewer and log monitor
- log4j Javadocs
- Setting up a log4j Socket Server to Email You Errors From Your Java Programs
Ports
- log5j - A 'modern' log4j that supports printf and has additional performance features.
- dlib C++ library Homepage - A port for C++
- Log4cxx Homepage - Apache port for C++
- Log4cplus Homepage - Another port for C++ (outdated)
- Log4cpp Homepage - Yet another port for C++ (outdated)
- Log4plsql HomePage - A port to the Oracle PL/SQL
- Log4c - A port for C
- Log4perl - A port for Perl
- log4js - A port for JavaScript
- logging - The official logging module for Python inspired by log4j.
- Log4r - Ruby logging module inspired by log4j
- Log4net - A port to the Microsoft .NET Framework
- log4php a port for PHP
- logback a purported successor to log4j, designed by log4j's founder
- log4sh a port for various Unix shells including sh, bash, dash and ksh
- Log4Cocoa - A Port for Cocoa
- Log4D - A Port for Delphi
|
||||||||||||||
No comments have been added.
