blob: 2727233f6a90901107a19cfb636f71b032fea3d3 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="keywords" content="SMILA/Project Concepts/Logging,G.schmidt.brox.de" />
<link rel="shortcut icon" href="http://wiki.eclipse.org/SMILA/Project_Concepts/favicon.ico" />
<link rel="search" type="application/opensearchdescription+xml" href="http://wiki.eclipse.org/opensearch_desc.php" title="Eclipsepedia (English)" />
<link rel="alternate" type="application/rss+xml" title="Eclipsepedia RSS Feed" href="http://wiki.eclipse.org/index.php?title=Special:Recentchanges&amp;feed=rss" />
<link rel="alternate" type="application/atom+xml" title="Eclipsepedia Atom Feed" href="http://wiki.eclipse.org/index.php?title=Special:Recentchanges&amp;feed=atom" />
<title>SMILA/Project Concepts/Logging - Eclipsepedia</title>
<style type="text/css" media="screen,projection">/*<![CDATA[*/ @import "http://wiki.eclipse.org/skins/eclipsenova/novaWide.css?116"; /*]]>*/</style>
<link rel="stylesheet" type="text/css" media="print" href="http://wiki.eclipse.org/skins/eclipsenova/eclipsenovaPrint.css?116" />
<link rel="stylesheet" type="text/css" media="handheld" href="http://wiki.eclipse.org/skins/eclipsenova/handheld.css?116" />
<link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/header.css" media="screen" />
<link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/tabs.css" media="screen" />
<link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/visual.css" media="screen" />
<link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/layout.css" media="screen" />
<link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/footer.css" media="screen" />
<!--[if IE]><link rel="stylesheet" type="text/css" href="/skins/eclipsenova/IEpngfix.css" media="screen" /><![endif]-->
<!--[if lt IE 5.5000]><style type="text/css">@import "/skins/eclipsenova/IE50Fixes.css?116";</style> <![endif]-->
<!--[if IE 5.5000]><style type="text/css">@import "/skins/eclipsenova/IE55Fixes.css?116";</style><![endif]-->
<!--[if IE 6]><style type="text/css">@import "/skins/eclipsenova/IE60Fixes.css?116";</style><![endif]-->
<!--[if IE 7]><style type="text/css">@import "/skins/eclipsenova/IE70Fixes.css?116";</style><![endif]-->
<!--[if lt IE 7]><script type="text/javascript" src="/skins/common/IEFixes.js?116"></script>
<meta http-equiv="imagetoolbar" content="no" /><![endif]-->
<script type= "text/javascript">/*<![CDATA[*/
var skin = "eclipsenova";
var stylepath = "/skins";
var wgArticlePath = "/$1";
var wgScriptPath = "";
var wgScript = "/index.php";
var wgServer = "http://wiki.eclipse.org";
var wgCanonicalNamespace = "";
var wgCanonicalSpecialPageName = false;
var wgNamespaceNumber = 0;
var wgPageName = "SMILA/Project_Concepts/Logging";
var wgTitle = "SMILA/Project Concepts/Logging";
var wgAction = "view";
var wgRestrictionEdit = [];
var wgRestrictionMove = [];
var wgArticleId = "15309";
var wgIsArticle = true;
var wgUserName = null;
var wgUserGroups = null;
var wgUserLanguage = "en";
var wgContentLanguage = "en";
var wgBreakFrames = false;
var wgCurRevisionId = "113741";
var wgVersion = "1.12.0";
var wgEnableAPI = true;
var wgEnableWriteAPI = false;
/*]]>*/</script>
<script type="text/javascript" src="http://wiki.eclipse.org/skins/common/wikibits.js?116"><!-- wikibits js --></script>
<!-- Performance mods similar to those for bug 166401 -->
<script type="text/javascript" src="http://wiki.eclipse.org/index.php?title=-&amp;action=raw&amp;gen=js&amp;useskin=eclipsenova"><!-- site js --></script>
<!-- Head Scripts -->
<script type="text/javascript" src="http://wiki.eclipse.org/skins/common/ajax.js?116"></script>
<style type="text/css">/*<![CDATA[*/
.source-text {line-height: normal; font-size: medium;}
.source-text li {line-height: normal;}
/**
* GeSHi Dynamically Generated Stylesheet
* --------------------------------------
* Dynamically generated stylesheet for text
* CSS class: source-text, CSS id:
* GeSHi (C) 2004 - 2007 Nigel McNie (http://qbnz.com/highlighter)
*/
.source-text .de1, .source-text .de2 {font-family: 'Courier New', Courier, monospace; font-weight: normal;}
.source-text {}
.source-text .head {}
.source-text .foot {}
.source-text .imp {font-weight: bold; color: red;}
.source-text .ln-xtra {color: #cc0; background-color: #ffc;}
.source-text li {font-family: 'Courier New', Courier, monospace; color: black; font-weight: normal; font-style: normal;}
.source-text li.li2 {font-weight: bold;}
/*]]>*/
</style>
<style type="text/css">/*<![CDATA[*/
@import "http://wiki.eclipse.org/index.php?title=MediaWiki:Geshi.css&usemsgcache=yes&action=raw&ctype=text/css&smaxage=18000";
/*]]>*/
</style><style type="text/css">/*<![CDATA[*/
.source-java {line-height: normal; font-size: medium;}
.source-java li {line-height: normal;}
/**
* GeSHi Dynamically Generated Stylesheet
* --------------------------------------
* Dynamically generated stylesheet for java
* CSS class: source-java, CSS id:
* GeSHi (C) 2004 - 2007 Nigel McNie (http://qbnz.com/highlighter)
*/
.source-java .de1, .source-java .de2 {font-family: 'Courier New', Courier, monospace; font-weight: normal;}
.source-java {}
.source-java .head {}
.source-java .foot {}
.source-java .imp {font-weight: bold; color: red;}
.source-java .ln-xtra {color: #cc0; background-color: #ffc;}
.source-java li {font-family: 'Courier New', Courier, monospace; color: black; font-weight: normal; font-style: normal;}
.source-java li.li2 {font-weight: bold;}
.source-java .kw1 {color: #7F0055; font-weight: bold;}
.source-java .kw2 {color: #7F0055; font-weight: bold;}
.source-java .kw3 {color: #000000; font-weight: normal}
.source-java .kw4 {color: #7F0055; font-weight: bold;}
.source-java .co1 {color: #3F7F5F; font-style: italic;}
.source-java .co2 {color: #3F7F5F;}
.source-java .co3 {color: #3F7F5F; font-style: italic; font-weight: bold;}
.source-java .coMULTI {color: #3F5FBF; font-style: italic;}
.source-java .es0 {color: #000000;}
.source-java .br0 {color: #000000;}
.source-java .st0 {color: #2A00ff;}
.source-java .nu0 {color: #000000;}
.source-java .me1 {color: #000000;}
.source-java .me2 {color: #000000;}
/*]]>*/
</style>
<style type="text/css">/*<![CDATA[*/
@import "http://wiki.eclipse.org/index.php?title=MediaWiki:Geshi.css&usemsgcache=yes&action=raw&ctype=text/css&smaxage=18000";
/*]]>*/
</style><link rel="stylesheet" type="text/css" href="Logging.html" /> </head>
<body class="mediawiki ns-0 ltr page-SMILA_Project_Concepts_Logging">
<div id="globalWrapper">
<div id="column-one">
<!-- Eclipse Additions for the Top Nav start here M. Ward-->
<div id="header">
<div id="header-graphic">
<img src="http://wiki.eclipse.org/skins/eclipsenova/eclipse.png" alt="Eclipse Wiki">
</div>
<!-- Pulled 101409 Mward -->
<div class="portlet" id="p-personal">
<div class="pBody">
<ul>
<li id="pt-login"><a href="http://wiki.eclipse.org/index.php?title=Special:Userlogin&amp;returnto=SMILA/Project_Concepts/Logging">Log in</a></li>
</ul>
</div>
</div>
<div id="header-icons">
<div id="sites">
<ul id="sitesUL">
<li><a href="http://www.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/eclipseIcon.png" width="28" height="28" alt="Eclipse Foundation" title="Eclipse Foundation" /><div>Eclipse Foundation</div></a></li>
<li><a href="http://marketplace.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/marketplace.png" width="28" height="28" alt="Eclipse Marketplace" title="Eclipse Marketplace" /><div>Eclipse Marketplace</div></a></li>
<li><a href="https://bugs.eclipse.org/bugs"><img src="http://dev.eclipse.org/custom_icons/system-search-bw.png" width="28" height="28" alt="Bugzilla" title="Bugzilla" /><div>Bugzilla</div></a></li>
<li><a href="http://live.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/audio-input-microphone-bw.png" width="28" height="28" alt="Live" title="Live" /><div>Eclipse Live</div></a></li>
<li><a href="http://planeteclipse.org"><img src="http://dev.eclipse.org/large_icons/devices/audio-card.png" width="28" height="28" alt="PlanetEclipse" title="Planet" /><div>Planet Eclipse</div></a></li>
<li><a href="http://portal.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/preferences-system-network-proxy-bw.png" width="28" height="28" alt="Portal" title="Portal" /><div>My Foundation Portal</div></a></li>
</ul>
</div>
</div>
</div>
<!-- NEW HEADER STUFF HERE -->
<div id="header-menu">
<div id="header-nav">
<ul> <li><a class="first_one" href="http://wiki.eclipse.org/" target="_self">Home</a></li> <li><a href="http://www.eclipse.org/downloads/" target="_self">Downloads</a></li>
<li><a href="http://www.eclipse.org/users/" target="_self">Users</a></li>
<li><a href="http://www.eclipse.org/membership/" target="_self">Members</a></li>
<li><a href="http://wiki.eclipse.org/index.php/Development_Resources" target="_self">Committers</a></li>
<li><a href="http://www.eclipse.org/resources/" target="_self">Resources</a></li>
<li><a href="http://www.eclipse.org/projects/" target="_self">Projects</a></li>
<li><a href="http://www.eclipse.org/org/" target="_self">About Us</a></li>
</ul>
</div>
<div id="header-utils">
<!-- moved the search window here -->
<form action="http://wiki.eclipse.org/Special:Search" >
<input class="input" name="search" type="text" accesskey="f" value="" />
<input type='submit' onclick="this.submit();" name="go" id="searchGoButton" class="button" title="Go to a page with this exact name if one exists" value="Go" />&nbsp;
<input type='submit' onclick="this.submit();" name="fulltext" class="button" id="mw-searchButton" title="Search Eclipsepedia for this text" value="Search" />
</form>
</div>
</div>
<!-- Eclipse Additions for the Header stop here -->
<!-- Additions and mods for leftside nav Start here -->
<!--Started nav rip here-->
<!-- these are the nav controls main page, changes etc -->
<div id="novaContent" class="faux">
<div id="leftcol">
<ul id="leftnav">
<!-- these are the page controls, edit history etc -->
<li class="separator"><a class="separator">Navigation &#160;&#160;</li>
<li id="n-mainpage"><a href="http://wiki.eclipse.org/Main_Page">Main Page</a></li>
<li id="n-portal"><a href="http://wiki.eclipse.org/Eclipsepedia:Community_Portal">Community portal</a></li>
<li id="n-currentevents"><a href="http://wiki.eclipse.org/Eclipsepedia:Current_events">Current events</a></li>
<li id="n-recentchanges"><a href="http://wiki.eclipse.org/Special:Recentchanges">Recent changes</a></li>
<li id="n-randompage"><a href="http://wiki.eclipse.org/Special:Random">Random page</a></li>
<li id="n-help"><a href="http://wiki.eclipse.org/Help:Contents">Help</a></li>
<li class="separator"><a class="separator">Toolbox &#160;&#160;</a></li>
<li id="t-whatlinkshere"><a href="http://wiki.eclipse.org/Special:Whatlinkshere/SMILA/Project_Concepts/Logging">What links here</a></li>
<li id="t-recentchangeslinked"><a href="http://wiki.eclipse.org/Special:Recentchangeslinked/SMILA/Project_Concepts/Logging">Related changes</a></li>
<!-- This is the toolbox section -->
<li id="t-upload"><a href="http://wiki.eclipse.org/Special:Upload">Upload file</a></li>
<li id="t-specialpages"><a href="http://wiki.eclipse.org/Special:Specialpages">Special pages</a></li>
<li id="t-print"><a href="http://wiki.eclipse.org/index.php?title=SMILA/Project_Concepts/Logging&amp;printable=yes">Printable version</a></li> <li id="t-permalink"><a href="http://wiki.eclipse.org/index.php?title=SMILA/Project_Concepts/Logging&amp;oldid=113741">Permanent link</a></li> </ul>
</div>
<!-- Additions and mods for leftside nav End here -->
<div id="column-content">
<div id="content">
<a name="top" id="top"></a>
<div id="tabs">
<ul class="primary">
<li class="active"><a href="Logging.html"><span class="tab">Page</span></a></li>
<li><a href="http://wiki.eclipse.org/index.php?title=Talk:SMILA/Project_Concepts/Logging&amp;action=edit"><span class="tab">Discussion</span></a></li>
<li><a href="http://wiki.eclipse.org/index.php?title=SMILA/Project_Concepts/Logging&amp;action=edit"><span class="tab">View source</span></a></li>
<li><a href="http://wiki.eclipse.org/index.php?title=SMILA/Project_Concepts/Logging&amp;action=history"><span class="tab">History</span></a></li>
<li><a href="http://wiki.eclipse.org/index.php?title=Special:Userlogin&amp;returnto=SMILA/Project&#32;Concepts/Logging"><span class="tab">Edit</span></a></li>
</ul>
</div>
<script type="text/javascript"> if (window.isMSIE55) fixalpha(); </script>
<h1 class="firstHeading">SMILA/Project Concepts/Logging</h1>
<div id="bodyContent">
<h3 id="siteSub">From Eclipsepedia</h3>
<div id="contentSub"><span class="subpages">&lt; <a href="../../SMILA.html" title="SMILA">SMILA</a> | <a href="../Project_Concepts.1.html" title="SMILA/Project Concepts">Project Concepts</a></span></div>
<div id="jump-to-nav">Jump to: <a href="Logging.html#column-one">navigation</a>, <a href="Logging.html#searchInput">search</a></div> <!-- start content -->
<table id="toc" class="toc" summary="Contents"><tr><td><div id="toctitle"><h2>Contents</h2></div>
<ul>
<li class="toclevel-1"><a href="Logging.html#Description"><span class="tocnumber">1</span> <span class="toctext">Description</span></a></li>
<li class="toclevel-1"><a href="Logging.html#Discussion"><span class="tocnumber">2</span> <span class="toctext">Discussion</span></a>
<ul>
<li class="toclevel-2"><a href="Logging.html#Combination_of_LogService_and_Log4j.2Fcommons-logging"><span class="tocnumber">2.1</span> <span class="toctext">Combination of LogService and Log4j/commons-logging</span></a></li>
<li class="toclevel-2"><a href="Logging.html#Mapping_of_log_Methods_of_OSGi_Logging_Service_and_log4j.2Fcommons-logging"><span class="tocnumber">2.2</span> <span class="toctext">Mapping of log Methods of OSGi Logging Service and log4j/commons-logging</span></a></li>
</ul>
</li>
<li class="toclevel-1"><a href="Logging.html#Technical_proposal"><span class="tocnumber">3</span> <span class="toctext">Technical proposal</span></a>
<ul>
<li class="toclevel-2"><a href="Logging.html#Normalize_log_format"><span class="tocnumber">3.1</span> <span class="toctext">Normalize log format</span></a></li>
<li class="toclevel-2"><a href="Logging.html#Code_Guards"><span class="tocnumber">3.2</span> <span class="toctext">Code Guards</span></a></li>
<li class="toclevel-2"><a href="Logging.html#Logs_system"><span class="tocnumber">3.3</span> <span class="toctext">Logs system</span></a>
<ul>
<li class="toclevel-3"><a href="Logging.html#Commons-Logging_and_log4j"><span class="tocnumber">3.3.1</span> <span class="toctext">Commons-Logging and log4j</span></a></li>
<li class="toclevel-3"><a href="Logging.html#Java_Logging"><span class="tocnumber">3.3.2</span> <span class="toctext">Java Logging</span></a></li>
<li class="toclevel-3"><a href="Logging.html#OSGi_LogService"><span class="tocnumber">3.3.3</span> <span class="toctext">OSGi LogService</span></a></li>
</ul>
</li>
<li class="toclevel-2"><a href="Logging.html#LogService_vs_log4j"><span class="tocnumber">3.4</span> <span class="toctext">LogService vs log4j</span></a>
<ul>
<li class="toclevel-3"><a href="Logging.html#Using_the_log4j_in_the_OSGi_LogService"><span class="tocnumber">3.4.1</span> <span class="toctext">Using the log4j in the OSGi LogService</span></a></li>
<li class="toclevel-3"><a href="Logging.html#Using_the_the_OSGi_LogService_in_the_log4j"><span class="tocnumber">3.4.2</span> <span class="toctext">Using the the OSGi LogService in the log4j</span></a></li>
</ul>
</li>
<li class="toclevel-2"><a href="Logging.html#Mapping"><span class="tocnumber">3.5</span> <span class="toctext">Mapping</span></a></li>
<li class="toclevel-2"><a href="Logging.html#Summary"><span class="tocnumber">3.6</span> <span class="toctext">Summary</span></a></li>
</ul>
</li>
</ul>
</td></tr></table><script type="text/javascript"> if (window.showTocToggle) { var tocShowText = "show"; var tocHideText = "hide"; showTocToggle(); } </script>
<a name="Description"></a><h2> <span class="mw-headline"> Description </span></h2>
<p>Create concept of logging.
</p>
<a name="Discussion"></a><h2> <span class="mw-headline"> Discussion </span></h2>
<a name="Combination_of_LogService_and_Log4j.2Fcommons-logging"></a><h3> <span class="mw-headline"> Combination of LogService and Log4j/commons-logging </span></h3>
<ul><li> <a href="http://wiki.eclipse.org/User:G.schmidt.brox.de" title="User:G.schmidt.brox.de">Georg Schmidt</a>: Currently I did not understand how such technologies will fit together or whether the are orthogonal approaches. If so which will be the suggested way of working? How do we handle backward compatibility e.g. to Lucene?
</li></ul>
<ul><li><ul><li> Andrey Basalve: LogService and Log4j/commons-logging don't contradict to each other. Nay we can use log4j/commons-logging to log event which was handled by LogService via implementing LogListener. On the other hand we can implement custom log4j appender which will send log messages to the OSGi LogService. What do you mean at backward compatibility (eg lucene doesn't use commons-logging)?
</li></ul>
</li></ul>
<ul><li> <a href="http://wiki.eclipse.org/User:G.schmidt.brox.de" title="User:G.schmidt.brox.de">Georg Schmidt</a>: There are several applications/APIs that are using commons-logging/log4j. How do we support a migration process?
</li></ul>
<ul><li><ul><li> Andrey Basalve: I haven't any issues with it, it is needed to set org.apache.commons.logging.Log property and to configure log4j and then all application/API's begins work with it. Tested with Apache ODE and ActiveMQ bundles.
</li></ul>
</li></ul>
<a name="Mapping_of_log_Methods_of_OSGi_Logging_Service_and_log4j.2Fcommons-logging"></a><h3> <span class="mw-headline"> Mapping of log Methods of OSGi Logging Service and log4j/commons-logging </span></h3>
<ul><li> <a href="http://wiki.eclipse.org/User:G.schmidt.brox.de" title="User:G.schmidt.brox.de">Georg Schmidt</a>: How do you map the log methods of those approaches?
</li></ul>
<ul><li><ul><li> Andrey Basalve: Added 'Mapping' Section.
</li></ul>
</li></ul>
<a name="Technical_proposal"></a><h2> <span class="mw-headline"> Technical proposal </span></h2>
<p>The main idea is using Commons-Logging interface and log4* as background. Also it is necessary to listen OSGi LogService.
</p>
<a name="Normalize_log_format"></a><h3> <span class="mw-headline"> Normalize log format </span></h3>
<p>There is standard layout for log format:
</p>
<div dir="ltr" style="text-align: left;"><pre class="source-text">%d &nbsp;%-50.50c{2}&nbsp;%-5p [%-10.10t] -&nbsp;%m%n</pre></div>
<div dir="ltr" style="text-align: left;"><pre class="source-text">2008-03-13 16:17:11,171 test.Log4JLogListener INFO [Dispatcher] - org.eclipse.osgi: FrameworkEvent STARTLEVEL CHANGED
2008-03-13 16:17:11,171 test.Activator DEBUG [Thread-1 ] - debug</pre></div>
<a name="Code_Guards"></a><h3> <span class="mw-headline"> Code Guards </span></h3>
<p>Code guards are typically used to guard code that only needs to execute in support of logging, that otherwise introduces undesirable runtime overhead in the general case (logging disabled). Examples are multiple parameters, or expressions (i.e. string + " more") for parameters. Use the guard methods of the form log.is&lt;Priority&gt;() to verify that logging should be performed, before incurring the overhead of the logging method call. Yes, the logging methods will perform the same check, but only after resolving parameters.
</p>
<a name="Logs_system"></a><h3> <span class="mw-headline"> Logs system </span></h3>
<a name="Commons-Logging_and_log4j"></a><h4> <span class="mw-headline"> Commons-Logging and log4j </span></h4>
<p>To use log4j as background for the Commons-Logging it is necessary to set up a two variables (in the $\{eclipse.home\}/configuration/config.ini where $\{eclipse.home\} is a path to the product folder)
</p>
<div dir="ltr" style="text-align: left;"><pre class="source-text">org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger
log4j.configuration=file:${eclipse.home}configuration/log4j.properties</pre></div>
<p>{info:title=Useful information}
If you working in the eclipse you can add a following arguments to the VM arguments section in the Run As wizard:
-Dorg.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger
-Dlog4j.configuration=file:${eclipse_home\}configuration/log4j.properties
{info}
</p><p>Also it is needed to add the org.apache.log4j package to the commons-logging bundle as dependency.
</p>
<div dir="ltr" style="text-align: left;"><pre class="source-text">Import-Package: org.apache.log4j;resolution:=optional</pre></div>
<p>For using logging system in the other bundles you should add Commons-Logging bundle as dependency and simply use Commons-Logging interface:
</p>
<div dir="ltr" style="text-align: left;"><pre class="source-java"><span class="kw1">public</span> <span class="kw1">class</span> SomeClass <span class="br0">&#123;</span>
&nbsp;
<span class="kw1">private</span> <span class="kw1">static</span> <span class="kw1">final</span> Log s_log = LogFactory.<span class="me1">getLog</span><span class="br0">&#40;</span>SomeClass.<span class="kw1">class</span><span class="br0">&#41;</span>;
&nbsp;
<span class="kw1">public</span> <span class="kw4">void</span> someMethod<span class="br0">&#40;</span><span class="br0">&#41;</span> <span class="br0">&#123;</span>
<span class="kw1">if</span> <span class="br0">&#40;</span>log.<span class="me1">isDebugEnable</span><span class="br0">&#40;</span><span class="br0">&#41;</span><span class="br0">&#41;</span> <span class="br0">&#123;</span>
log.<span class="me1">debug</span><span class="br0">&#40;</span><span class="st0">&quot;Enter to some method&quot;</span><span class="br0">&#41;</span>;
<span class="br0">&#125;</span>
&nbsp;
....
&nbsp;
<span class="kw1">if</span> <span class="br0">&#40;</span>log.<span class="me1">isDebugEnable</span><span class="br0">&#40;</span><span class="br0">&#41;</span><span class="br0">&#41;</span> <span class="br0">&#123;</span>
log.<span class="me1">debug</span><span class="br0">&#40;</span><span class="st0">&quot;Exit from some method&quot;</span><span class="br0">&#41;</span>;
<span class="br0">&#125;</span>
<span class="br0">&#125;</span>
<span class="br0">&#125;</span></pre></div>
<p>It is possible to automatically reload a configuration file if it is changed. Both the DOMConfigurator and the PropertyConfigurator support automatic reloading through the configureAndWatch method. Because the configureAndWatch launches a separate wathdog thread, and because there is no way to stop this thread in log4j 1.2, the configureAndWatch method is unsafe for use in J2EE envrironments where applications are recycled.
</p><p>{info:title=Configuring}
The best way, in my opinion, is use our configuration management system (basis on OSGi ConfigurationAdminService) to configure log4j. It allows to dynamically update configuration and removes associating with file system.
{info}
</p>
<a name="Java_Logging"></a><h4> <span class="mw-headline"> Java Logging </span></h4>
<p>The newer logging API, which has been included in the JRE since 1.4, incorporates many of the same concepts as log4j. It has loggers and appenders.
</p>
<div dir="ltr" style="text-align: left;"><pre class="source-java"><span class="co1">//Get a logger; the logger is automatically created if it doesn't already exist</span>
Logger logger = Logger.<span class="me1">getLogger</span><span class="br0">&#40;</span><span class="st0">&quot;com.mycompany.BasicLogging&quot;</span><span class="br0">&#41;</span>;
&nbsp;
<span class="co1">// Log a few message at different severity levels</span>
logger.<span class="me1">severe</span><span class="br0">&#40;</span><span class="st0">&quot;my severe message&quot;</span><span class="br0">&#41;</span>;
logger.<span class="me1">warning</span><span class="br0">&#40;</span><span class="st0">&quot;my warning message&quot;</span><span class="br0">&#41;</span>;
logger.<span class="me1">info</span><span class="br0">&#40;</span><span class="st0">&quot;my info message&quot;</span><span class="br0">&#41;</span>;
logger.<span class="me1">config</span><span class="br0">&#40;</span><span class="st0">&quot;my config message&quot;</span><span class="br0">&#41;</span>;
logger.<span class="me1">fine</span><span class="br0">&#40;</span><span class="st0">&quot;my fine message&quot;</span><span class="br0">&#41;</span>;
logger.<span class="me1">finer</span><span class="br0">&#40;</span><span class="st0">&quot;my finer message&quot;</span><span class="br0">&#41;</span>;
logger.<span class="me1">finest</span><span class="br0">&#40;</span><span class="st0">&quot;my finest message&quot;</span><span class="br0">&#41;</span>;</pre></div>
<a name="OSGi_LogService"></a><h4> <span class="mw-headline"> OSGi LogService </span></h4>
<p>The Log Service provides a general purpose message logger for the OSGi Service Platform. It consists of two services, one for logging information and another for retrieving current or previously recorded log information. The OSGi specification defines the methods and semantics of interfaces which bundle developers can use to log entries and to retrieve log entries.
</p><p><a href="http://wiki.eclipse.org/Image:LogService.png" class="image" title="Image:LogService.png"><img alt="Image:LogService.png" src="http://wiki.eclipse.org/images/c/c1/LogService.png" width="722" height="443" border="0" /></a>
</p><p>There is an eclipse implementation of the OSGi LogService (org.eclipse.equinox.log bundle).
</p>
<div dir="ltr" style="text-align: left;"><pre class="source-java"><span class="kw1">final</span> ServiceReference reference = context.<span class="me1">getServiceReference</span><span class="br0">&#40;</span>LogService.<span class="kw1">class</span>.<span class="me1">getName</span><span class="br0">&#40;</span><span class="br0">&#41;</span><span class="br0">&#41;</span>;
<span class="kw1">final</span> LogService logService = <span class="br0">&#40;</span>LogService<span class="br0">&#41;</span> context.<span class="me1">getService</span><span class="br0">&#40;</span>reference<span class="br0">&#41;</span>;
logService.<span class="me1">log</span><span class="br0">&#40;</span>LogService.<span class="me1">LOG_DEBUG</span>, <span class="st0">&quot;Test Log Message&quot;</span><span class="br0">&#41;</span>;</pre></div>
<a name="LogService_vs_log4j"></a><h3> <span class="mw-headline"> LogService vs log4j </span></h3>
<a name="Using_the_log4j_in_the_OSGi_LogService"></a><h4> <span class="mw-headline"> Using the log4j in the OSGi LogService </span></h4>
<p>There is a way to use log4j for logging messages from OSGi Log Service. For this it is necessary to implement LogListener(which uses log4j) and to register it via the LogReaderService OSGi Service.
</p>
<div dir="ltr" style="text-align: left;"><pre class="source-java"><span class="kw1">public</span> <span class="kw1">class</span> <span class="kw3">Activator</span> <span class="kw1">implements</span> BundleActivator <span class="br0">&#123;</span>
&nbsp;
<span class="kw1">private</span> Log4JLogListener _listener;
&nbsp;
<span class="kw1">public</span> <span class="kw4">void</span> start<span class="br0">&#40;</span>BundleContext context<span class="br0">&#41;</span> <span class="kw1">throws</span> <span class="kw3">Exception</span> <span class="br0">&#123;</span>
_listener = <span class="kw1">new</span> Log4JLogListener<span class="br0">&#40;</span><span class="br0">&#41;</span>;
&nbsp;
ServiceReference reference = context.<span class="me1">getServiceReference</span><span class="br0">&#40;</span>LogReaderService.<span class="kw1">class</span>.<span class="me1">getName</span><span class="br0">&#40;</span><span class="br0">&#41;</span><span class="br0">&#41;</span>;
<span class="kw1">final</span> LogReaderService readerService = <span class="br0">&#40;</span>LogReaderService<span class="br0">&#41;</span> context.<span class="me1">getService</span><span class="br0">&#40;</span>reference<span class="br0">&#41;</span>;
readerService.<span class="me1">addLogListener</span><span class="br0">&#40;</span>_listener<span class="br0">&#41;</span>;
<span class="br0">&#125;</span>
&nbsp;
<span class="kw1">public</span> <span class="kw4">void</span> stop<span class="br0">&#40;</span>BundleContext context<span class="br0">&#41;</span> <span class="kw1">throws</span> <span class="kw3">Exception</span> <span class="br0">&#123;</span>
<span class="kw1">final</span> ServiceReference reference = context.<span class="me1">getServiceReference</span><span class="br0">&#40;</span>LogReaderService.<span class="kw1">class</span>.<span class="me1">getName</span><span class="br0">&#40;</span><span class="br0">&#41;</span><span class="br0">&#41;</span>;
<span class="kw1">final</span> LogReaderService readerService = <span class="br0">&#40;</span>LogReaderService<span class="br0">&#41;</span> context.<span class="me1">getService</span><span class="br0">&#40;</span>reference<span class="br0">&#41;</span>;
readerService.<span class="me1">removeLogListener</span><span class="br0">&#40;</span>_listener<span class="br0">&#41;</span>;
<span class="br0">&#125;</span>
<span class="br0">&#125;</span></pre></div>
<p><br />
</p>
<div dir="ltr" style="text-align: left;"><pre class="source-java"><span class="kw1">public</span> <span class="kw1">class</span> Log4JLogListener <span class="kw1">implements</span> LogListener <span class="br0">&#123;</span>
&nbsp;
<span class="kw1">private</span> <span class="kw1">static</span> Log s_log = LogFactory.<span class="me1">getLog</span><span class="br0">&#40;</span>Log4JLogListener.<span class="kw1">class</span><span class="br0">&#41;</span>;
&nbsp;
<span class="kw1">public</span> <span class="kw4">void</span> logged<span class="br0">&#40;</span>LogEntry entry<span class="br0">&#41;</span> <span class="br0">&#123;</span>
<span class="kw1">switch</span> <span class="br0">&#40;</span>entry.<span class="me1">getLevel</span><span class="br0">&#40;</span><span class="br0">&#41;</span><span class="br0">&#41;</span> <span class="br0">&#123;</span>
<span class="kw1">case</span> LogService.<span class="me1">LOG_DEBUG</span>:
<span class="kw1">if</span> <span class="br0">&#40;</span>s_log.<span class="me1">isDebugEnabled</span><span class="br0">&#40;</span><span class="br0">&#41;</span><span class="br0">&#41;</span> <span class="br0">&#123;</span>
<span class="kw1">final</span> <span class="kw3">Throwable</span> throwable = entry.<span class="me1">getException</span><span class="br0">&#40;</span><span class="br0">&#41;</span>;
<span class="kw1">if</span> <span class="br0">&#40;</span>throwable == <span class="kw2">null</span><span class="br0">&#41;</span> <span class="br0">&#123;</span>
s_log.<span class="me1">debug</span><span class="br0">&#40;</span>getMessage<span class="br0">&#40;</span>entry<span class="br0">&#41;</span><span class="br0">&#41;</span>;
<span class="br0">&#125;</span> <span class="kw1">else</span> <span class="br0">&#123;</span>
s_log.<span class="me1">debug</span><span class="br0">&#40;</span>getMessage<span class="br0">&#40;</span>entry<span class="br0">&#41;</span>, throwable<span class="br0">&#41;</span>;
<span class="br0">&#125;</span>
<span class="br0">&#125;</span>
<span class="kw1">break</span>;
&nbsp;
....
&nbsp;
<span class="kw1">default</span>:
<span class="kw1">throw</span> <span class="kw1">new</span> <span class="kw3">IllegalArgumentException</span><span class="br0">&#40;</span><span class="st0">&quot;Unexpected log level &quot;</span> + entry.<span class="me1">getLevel</span><span class="br0">&#40;</span><span class="br0">&#41;</span><span class="br0">&#41;</span>;
<span class="br0">&#125;</span>
<span class="br0">&#125;</span>
&nbsp;
<span class="kw1">private</span> <span class="kw3">String</span> getMessage<span class="br0">&#40;</span>LogEntry entry<span class="br0">&#41;</span> <span class="br0">&#123;</span>
<span class="kw1">final</span> StringBuilder builder = <span class="kw1">new</span> StringBuilder<span class="br0">&#40;</span><span class="br0">&#41;</span>;
builder.<span class="me1">append</span><span class="br0">&#40;</span>entry.<span class="me1">getBundle</span><span class="br0">&#40;</span><span class="br0">&#41;</span>.<span class="me1">getSymbolicName</span><span class="br0">&#40;</span><span class="br0">&#41;</span><span class="br0">&#41;</span>;
builder.<span class="me1">append</span><span class="br0">&#40;</span><span class="st0">&quot;: &quot;</span><span class="br0">&#41;</span>;
builder.<span class="me1">append</span><span class="br0">&#40;</span>entry.<span class="me1">getMessage</span><span class="br0">&#40;</span><span class="br0">&#41;</span><span class="br0">&#41;</span>;
<span class="kw1">return</span> builder.<span class="me1">toString</span><span class="br0">&#40;</span><span class="br0">&#41;</span>;
<span class="br0">&#125;</span>
&nbsp;
<span class="br0">&#125;</span></pre></div>
<p>For implement and register LogService we need a bundle(and in particular BundleContext). There are two ways:
</p>
<ol><li> Create single bundle for this purposes.
</li><li> Add LogListener implementation to the product bundle (BrandingBundle) and register it on start application.
</li></ol>
<p>I prefer the first way because is allows stop/update/start this service.
</p>
<a name="Using_the_the_OSGi_LogService_in_the_log4j"></a><h4> <span class="mw-headline"> Using the the OSGi LogService in the log4j </span></h4>
<p>On the other hand we can implement custom log4j appender which will send log messages to the OSGi LogService. For this we should create a special bundle which have the log4j appender implementation and track LogService.
</p>
<div dir="ltr" style="text-align: left;"><pre class="source-java"><span class="kw1">public</span> <span class="kw1">class</span> LogServiceAppender <span class="kw1">extends</span> AppenderSkeleton <span class="br0">&#123;</span>
&nbsp;
<span class="kw1">protected</span> <span class="kw4">void</span> append<span class="br0">&#40;</span>LoggingEvent le<span class="br0">&#41;</span> <span class="br0">&#123;</span>
&nbsp;
<span class="co1">// getLogService use service tracker to obtain LogService </span>
LogService logService = getLogService<span class="br0">&#40;</span><span class="br0">&#41;</span>;
&nbsp;
<span class="kw1">if</span> <span class="br0">&#40;</span>logService == <span class="kw2">null</span><span class="br0">&#41;</span> <span class="br0">&#123;</span>
<span class="kw1">return</span>;
<span class="br0">&#125;</span>
&nbsp;
<span class="kw1">if</span> <span class="br0">&#40;</span>le.<span class="me1">getLevel</span><span class="br0">&#40;</span><span class="br0">&#41;</span>.<span class="me1">equals</span><span class="br0">&#40;</span>Level.<span class="me1">DEBUG</span><span class="br0">&#41;</span><span class="br0">&#41;</span> <span class="br0">&#123;</span>
logService.<span class="me1">log</span><span class="br0">&#40;</span>LogService.<span class="me1">LOG_DEBUG</span>, le.<span class="me1">getRenderedMessage</span><span class="br0">&#40;</span><span class="br0">&#41;</span><span class="br0">&#41;</span>;
<span class="br0">&#125;</span> <span class="kw1">else</span> <span class="kw1">if</span> <span class="br0">&#40;</span>le.<span class="me1">getLevel</span><span class="br0">&#40;</span><span class="br0">&#41;</span>.<span class="me1">equals</span><span class="br0">&#40;</span>Level.<span class="me1">INFO</span><span class="br0">&#41;</span><span class="br0">&#41;</span> <span class="br0">&#123;</span>
...
<span class="br0">&#125;</span>
<span class="br0">&#125;</span>
&nbsp;
<span class="br0">&#125;</span></pre></div>
<a name="Mapping"></a><h3> <span class="mw-headline"> Mapping </span></h3>
<p>There are several different log levels in each log system and it is necessary to compare theirs.
</p>
<table border="1">
<tr>
<th> Log4j
</th><th> Commons Logging
</th><th> Java Logging
</th><th> OSGi LogService
</th></tr>
<tr>
<td> Fatal
</td><td> Fatal
</td><td> Severe
</td><td> Error
</td></tr>
<tr>
<td> Error
</td><td> Error
</td><td> Severe
</td><td> Error
</td></tr>
<tr>
<td> Warn
</td><td> Warn
</td><td> Warning
</td><td> Warning
</td></tr>
<tr>
<td> Info
</td><td> Info
</td><td> Info
</td><td> Info
</td></tr>
<tr>
<td> Debug
</td><td> Debug
</td><td> Fine
</td><td> Debug
</td></tr>
<tr>
<td> Trace
</td><td> Trace
</td><td> Finer and Finest
</td><td> Debug
</td></tr></table>
<a name="Summary"></a><h3> <span class="mw-headline"> Summary </span></h3>
<p>There is an issue with a third party bundles because they are used different log systems. But we needed a centralized log. Therefore it is suggested to use log4j(in conjunction with commons-logging) as a basis because it is possible to easily redirect other loggers to log4j.
</p><p><a href="http://wiki.eclipse.org/Image:CentralizedLog.png" class="image" title="Image:centralizedLog.png"><img alt="Image:centralizedLog.png" src="http://wiki.eclipse.org/images/3/34/CentralizedLog.png" width="724" height="419" border="0" /></a>
</p>
<!--
NewPP limit report
Preprocessor node count: 47/1000000
Post-expand include size: 0/2097152 bytes
Template argument size: 0/2097152 bytes
#ifexist count: 0/100
-->
<!-- Saved in parser cache with key wikidb:pcache:idhash:15309-0!1!0!!en!2!edit=0 and timestamp 20120710093542 -->
<div class="printfooter">
Retrieved from "<a href="Logging.html">http://wiki.eclipse.org/SMILA/Project_Concepts/Logging</a>"</div>
<div id="catlinks"><p class='catlinks'><a href="http://wiki.eclipse.org/Special:Categories" title="Special:Categories">Category</a>: <span dir='ltr'><a href="http://wiki.eclipse.org/Category:SMILA" title="Category:SMILA">SMILA</a></span></p></div> <!-- end content -->
<div class="visualClear"></div>
</div>
</div>
</div>
<!-- Yoink of toolbox for phoenix moved up -->
</div>
</div>
<div id="clearFooter"/>
<div id="footer" >
<ul id="footernav">
<li class="first"><a href="http://www.eclipse.org/">Home</a></li>
<li><a href="http://www.eclipse.org/legal/privacy.php">Privacy Policy</a></li>
<li><a href="http://www.eclipse.org/legal/termsofuse.php">Terms of Use</a></li>
<li><a href="http://www.eclipse.org/legal/copyright.php">Copyright Agent</a></li>
<li><a href="http://www.eclipse.org/org/foundation/contact.php">Contact</a></li>
<li><a href="http://wiki.eclipse.org/Eclipsepedia:About" title="Eclipsepedia:About">About Eclipsepedia</a></li>
</ul>
<span id="copyright">Copyright &copy; 2012 The Eclipse Foundation. All Rights Reserved</span>
<p id="footercredit">This page was last modified 12:23, 15 August 2008 by <a href="http://wiki.eclipse.org/User:Daniel.stucky.empolis.com" title="User:Daniel.stucky.empolis.com">Daniel Stucky</a>. </p>
<p id="footerviews">This page has been accessed 3,786 times.</p>
</div>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-910670-4");
pageTracker._trackPageview();
</script>
<!-- <div class="visualClear"></div> -->
<script type="text/javascript">if (window.runOnloadHook) runOnloadHook();</script>
</div>
<!-- Served in 0.049 secs. --></body></html>