apache-tuscany/site/trunk/site-publish/tuscanytuscanyjavadas-java-overviewimproved-logging.html
2014-11-21 09:30:19 +00:00

183 lines
7.8 KiB
HTML
Raw Permalink Blame History

<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE- 2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML>
<HEAD>
<!-- generateKeywords macro -->
<META name="description" content="Apache Tuscany">
<META name="keywords" content="apache, apache tuscany, tuscany, service, services, fabric, soa, service oriented architecture, sca, service component architecture, das, sdo, csa, ruby, opensource">
<!-- generateKeywords macro end -->
<LINK type="text/css" rel="stylesheet" href="http://tuscany.apache.org/stylesheets/default.css">
<LINK rel="SHORTCUT ICON" href="https://cwiki.apache.org/confluence/display/TUSCANY/$images/favicon.ico">
<TITLE>Apache Tuscany : Tuscany.TuscanyJava.DAS Java Overview.Improved logging</TITLE>
<META http-equiv="Content-Type" content="text/html;charset=UTF-8"></HEAD>
<BODY onload="init()">
<!-- topNav macro -->
<TABLE valign="top" border="0" cellspacing="0" cellpadding="0" width="100%" background="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg">
<TR>
<TD valing="top" align="left">
<A href="https://cwiki.apache.org/confluence/pages/viewpage.action?spaceKey=TUSCANY&title=$siteroot"><IMG src="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg" height="91" width="25" border="0"></A>
</TD>
<TD>
<A href="http://tuscany.apache.org/"><IMG src="http://tuscany.apache.org/images/TuscanyLogo.jpg" border="0"></A>
</TD>
<TD width="100%">
&nbsp;
</TD>
<!-- Adds the edit page link to the top banner-->
<TD valign="bottom">
<DIV style="padding: 2px 10px; margin: 0px;">
<A href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=52840">
<IMG src="http://tuscany.apache.org/images/notep_16.gif" height="16" width="16" border="0" align="absmiddle" title="Edit Page"></A>
</DIV>
</TD>
</TR>
</TABLE>
<!-- topNav macro end -->
<!-- breadCrumbs macro -->
<TABLE border="0" cellpadding="2" cellspacing="0" width="100%">
<TR class="topBar">
<TD align="left" valign="middle" class="topBarDiv" nowrap="true" width="100%">
&nbsp;<A href="home.html" title="Apache Tuscany">Apache Tuscany</A>&nbsp;&gt;&nbsp;<A href="home.html" title="Home">Home</A>&nbsp;&gt;&nbsp;<A href="das-overview.html" title="DAS Overview">DAS Overview</A>&nbsp;&gt;&nbsp;<A href="das-java.html" title="DAS Java">DAS Java</A>&nbsp;&gt;&nbsp;<A href="das-java-documentation-menu.html" title="DAS Java Documentation Menu">DAS Java Documentation Menu</A>&nbsp;&gt;&nbsp;<A href="das-java-developer-guide.html" title="DAS Java Developer Guide">DAS Java Developer Guide</A>&nbsp;&gt;&nbsp;<A href="rdb-das-java.html" title="RDB DAS Java">RDB DAS Java</A>&nbsp;&gt;&nbsp;<A href="rdb-das-user-guide.html" title="RDB DAS - User Guide">RDB DAS - User Guide</A>&nbsp;&gt;&nbsp;<A href="" title="Tuscany.TuscanyJava.DAS Java Overview.Improved logging">Tuscany.TuscanyJava.DAS Java Overview.Improved logging</A>
</TD>
<TD align="right" valign="middle" class="topBarDiv" align="left" nowrap="true">
<A href="http://mail-archives.apache.org/mod_mbox/tuscany-user">User List</A> | <A href="http://mail-archives.apache.org/mod_mbox/tuscany-dev">Dev List</A> | <A href="http://issues.apache.org/jira/browse/Tuscany">Issue Tracker</A>&nbsp;&nbsp;
</TD>
</TR>
</TABLE>
<!-- breadCrumbs macro end -->
<TABLE border="0" cellpadding="0" width="100%" bgcolor="#FFFFFF">
<TR>
<TD align="left" valign="top">
<!-- pageContent macro -->
<DIV id="PageContent">
<DIV class="pagecontent">
<DIV class="wiki-content">
<H1><A name="Tuscany.TuscanyJava.DASJavaOverview.Improvedlogging-Tuscany%2FTuscanyJava%2FDASJavaOverview%2FImprovedlogging"></A>Tuscany/TuscanyJava/DAS Java Overview/Improved logging</H1>
<H3><A name="Tuscany.TuscanyJava.DASJavaOverview.Improvedlogging-LoggingOverview"></A>Logging Overview</H3>
<P><B>Overview</B></P>
<UL>
<LI>Tuscany DAS uses log4J as its logging mechanism. For more information and complete documentation on log4j, please visit their website (<A href="http://logging.apache.org/log4j/docs/" class="external-link" rel="nofollow">http://logging.apache.org/log4j/docs/</A>)</LI>
</UL>
<P><B>Using log while contributting for Tuscany DAS code</B></P>
<UL>
<LI>While contributing to DAS code, please follow the following guidelines to add logging to your class
<BR class="atl-forced-newline">
<EM>Instantiate a logger</EM>
<BR class="atl-forced-newline">
&#45; There is a logger factory available in org.apache.tuscany.das.rdb.util - To use it
<UL>
<LI>private final Logger logger = LoggerFactory.INSTANCE.getLogger(MappingWrapper.class);</LI>
</UL>
</LI>
</UL>
<P>&#45; To instrument your code with logging capabilities</P>
<UL>
<LI>
<UL>
<LI>if(this.logger.isDebugEnabled())
<UL>
<LI>this.logger.debug(&quot;your debug message&quot;);</LI>
</UL>
</LI>
</UL>
</LI>
</UL>
<P>Note: As a performance enhancement, please surround your debug code with a check to see if debug is enabled or not.</P>
<P><B>Configuring DAS logging (log4j)</B></P>
<UL>
<LI><EM>Configuring with Tomcat</EM>
<BR class="atl-forced-newline">
There are two ways to configure log4j in Tomcat :
<UL>
<LI>&#45; Having a global log4j.properties inside %CATALINA_HOME%\common\classes
<BR class="atl-forced-newline">
&#45; Having a global log4j.properties inside your own web app at WEB-INF\classes</LI>
</UL>
</LI>
</UL>
<P><B>Sample log4j.properties</B></P>
<P>&#35; Set root logger level to DEBUG and its only appender to A1.</P>
<P>log4j.rootLogger=INFO, A1</P>
<P>&#35; A1 is set to be a ConsoleAppender.</P>
<P>log4j.appender.A1=org.apache.log4j.ConsoleAppender</P>
<P>&#35; A1 uses PatternLayout.</P>
<P>log4j.appender.A1.layout=org.apache.log4j.PatternLayout log4j.appender.A1.layout.ConversionPattern=[DAS RDB] - %c{1}.%M (%L) : %m %n</P>
<P>&#35; Print only messages of level WARN or above in the package com.foo.</P>
<P>log4j.logger.org.apache.tuscany=OFF &#42;&#42; For further information, please follow the link : <A href="http://tomcat.apache.org/faq/logging.html" class="external-link" rel="nofollow">Tomcat FAQ - Logging</A></P>
</DIV>
</DIV>
</DIV>
<!-- pageContent macro end -->
</TD>
</TR>
</TABLE>
<!-- footer macro -->
<SCRIPT src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</SCRIPT>
<SCRIPT type="text/javascript">
_uacct = "UA-1174707-5";
urchinTracker();
</SCRIPT>
<A href="http://www.statcounter.com/" target="_blank"><IMG src="http://c26.statcounter.com/counter.php?sc_project=2619156&java=0&security=94bd7e7d&invisible=0" alt="website stats" border="0"></A>
<DIV class="footer">
Copyright <20> 2003-2012, The Apache Software Foundation&nbsp;&nbsp;</BR>
Apache Tuscany and the Apache Tuscany project logo are trademarks of The Apache Software Foundation.
</DIV>
<!-- footer macro end -->
</BODY>
</HTML>