1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 18 Feb 2015 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>CodeNarc - CodeNarc - Logging Rules</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="Date-Revision-yyyymmdd" content="20150218" />
<meta http-equiv="Content-Language" content="en" />
</head>
<body class="composite">
<div id="banner">
<a href="./" id="bannerLeft">
<img src="images/codenarc-logo.png" alt="CodeNarc" />
</a>
<a href="http://github.com/CodeNarc" id="bannerRight">
<img src="images/forkme_right_red_aa0000.png" alt="Fork me on GitHub" />
</a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
<span id="publishDate">Last Published: 18 Feb 2015</span>
| <span id="projectVersion">Version: 0.23</span>
</div>
<div class="xright">
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>General</h5>
<ul>
<li class="none">
<a href="index.html" title="Home">Home</a>
</li>
<li class="none">
<a href="https://sourceforge.net/project/showfiles.php?group_id=250145" class="externalLink" title="Downloads">Downloads</a>
</li>
<li class="none">
<a href="apidocs/index.html" title="Javadocs">Javadocs</a>
</li>
<li class="none">
<a href="http://sourceforge.net/mail/?group_id=250145" class="externalLink" title="Mailing Lists">Mailing Lists</a>
</li>
<li class="none">
<a href="http://sourceforge.net/tracker/?group_id=250145" class="externalLink" title="Bug Tracker">Bug Tracker</a>
</li>
<li class="none">
<a href="http://sourceforge.net/projects/codenarc" class="externalLink" title="SourceForge Project">SourceForge Project</a>
</li>
<li class="none">
<a href="http://github.com/CodeNarc" class="externalLink" title="GitHub Project">GitHub Project</a>
</li>
</ul>
<h5>Running</h5>
<ul>
<li class="none">
<a href="codenarc-ant-task.html" title="Ant Task Usage">Ant Task Usage</a>
</li>
<li class="none">
<a href="codenarc-command-line.html" title="Command-Line">Command-Line</a>
</li>
<li class="none">
<a href="codenarc-run-as-a-test.html" title="Run as a Test">Run as a Test</a>
</li>
<li class="none">
<a href="codenarc-other-tools-frameworks.html" title="Other Tools/Frameworks">Other Tools/Frameworks</a>
</li>
</ul>
<h5>Using</h5>
<ul>
<li class="none">
<a href="codenarc-creating-ruleset.html" title="Creating a RuleSet">Creating a RuleSet</a>
</li>
<li class="none">
<a href="codenarc-creating-rule.html" title="Creating a Rule">Creating a Rule</a>
</li>
<li class="none">
<a href="codenarc-configuring-rules.html" title="Configuring Rules">Configuring Rules</a>
</li>
<li class="none">
<a href="StarterRuleSet-AllRulesByCategory.groovy.txt" title="Starter RuleSet (All)">Starter RuleSet (All)</a>
</li>
</ul>
<h5>Report Types</h5>
<ul>
<li class="none">
<a href="codenarc-HtmlReportWriter.html" title="HTML Report">HTML Report</a>
</li>
<li class="none">
<a href="codenarc-XmlReportWriter.html" title="XML Report">XML Report</a>
</li>
<li class="none">
<a href="codenarc-TextReportWriter.html" title="Text and IDE Reports">Text and IDE Reports</a>
</li>
</ul>
<h5>Sample Reports</h5>
<ul>
<li class="none">
<a href="SampleCodeNarcHtmlReport.html" title="Sample HTML Report">Sample HTML Report</a>
</li>
<li class="none">
<a href="SampleCodeNarcXmlReport.xml" title="Sample XML Report">Sample XML Report</a>
</li>
</ul>
<h5>Rules</h5>
<ul>
<li class="none">
<a href="codenarc-rule-index.html" title="Rule Index">Rule Index</a>
</li>
<li class="none">
<a href="codenarc-rules-basic.html" title="Basic Rules">Basic Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-braces.html" title="Braces Rules">Braces Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-concurrency.html" title="Concurrency Rules">Concurrency Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-convention.html" title="Convention Rules">Convention Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-design.html" title="Design Rules">Design Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-dry.html" title="DRY Rules">DRY Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-enhanced.html" title="Enhanced Rules">Enhanced Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-exceptions.html" title="Exceptions Rules">Exceptions Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-formatting.html" title="Formatting Rules">Formatting Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-generic.html" title="Generic Rules">Generic Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-grails.html" title="Grails Rules">Grails Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-groovyism.html" title="Groovyism Rules">Groovyism Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-imports.html" title="Imports Rules">Imports Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-jdbc.html" title="JDBC Rules">JDBC Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-junit.html" title="JUnit Rules">JUnit Rules</a>
</li>
<li class="none">
<strong>Logging Rules</strong>
</li>
<li class="none">
<a href="codenarc-rules-naming.html" title="Naming Rules">Naming Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-size.html" title="Size/Complexity Rules">Size/Complexity Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-security.html" title="Security Rules">Security Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-serialization.html" title="Serialization Rules">Serialization Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-unnecessary.html" title="Unnecessary Rules">Unnecessary Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-unused.html" title="Unused Rules">Unused Rules</a>
</li>
</ul>
<h5>Developing</h5>
<ul>
<li class="none">
<a href="codenarc-developer-guide.html" title="Developer Guide">Developer Guide</a>
</li>
</ul>
<h5>Project Documentation</h5>
<ul>
<li class="collapsed">
<a href="project-info.html" title="Project Information">Project Information</a>
</li>
<li class="collapsed">
<a href="project-reports.html" title="Project Reports">Project Reports</a>
</li>
</ul>
<a href="http://sourceforge.net" title="Hosted on SourceForge.net" class="poweredBy">
<img class="poweredBy" alt="Hosted on SourceForge.net" src="http://sflogo.sourceforge.net/sflogo.php?group_id=208647&type=2" />
</a>
<a href="http://maven.apache.org" title="Build with Maven 2" class="poweredBy">
<img class="poweredBy" alt="Build with Maven 2" src="images/logos/maven-feather.png" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<div class="section">
<h2>Logging Rules ("<i>rulesets/logging.xml</i>")<a name="Logging_Rules_rulesetslogging.xml"></a></h2><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<div class="section">
<h3><a name="LoggerForDifferentClass">LoggerForDifferentClass</a> Rule<a name="LoggerForDifferentClass_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<p><i>Since CodeNarc 0.12</i></p>
<p>Checks for instantiating a logger for a class other than the current class. Checks for logger instantiations for <b>Log4J</b>, <b>SLF4J</b>, <b>Logback</b>, <b>Apache Commons Logging</b> and <b>Java Logging API (java.util.logging)</b>.</p>
<p>This rule contains a parameter <tt>allowDerivedClasses</tt>. When set, a logger may be created about this.getClass().</p>
<p>Limitations:</p>
<ul>
<li>Only checks Loggers instantiated within a class field or property (not variables or expressions within a method)</li>
<li>For <b>Log4J</b>: Does not catch Logger instantiations if you specify the full package name for the <tt>Logger</tt> class: e.g. <tt>org.apache.log4.Logger.getLogger(..)</tt></li>
<li>For <b>SLF4J</b> and <b>Logback</b>: Does not catch Log instantiations if you specify the full package name for the <tt>LoggerFactory</tt> class: e.g. <tt>org.slf4j.LoggerFactory.getLogger(..)</tt></li>
<li>For <b>Commons Logging</b>: Does not catch Log instantiations if you specify the full package name for the <tt>LogFactory</tt> class: e.g. <tt>org.apache.commons.logging.LogFactory.getLog(..)</tt></li>
<li>For <b>Java Logging API</b>: Does not catch Logger instantiations if you specify the full package name for the <tt>Logger</tt> class: e.g. <tt>java.util.logging.Logger.getLogger(..)</tt></li></ul>
<p>Here are examples of <b>Log4J</b> or <b>Java Logging API</b> code that cause violations:</p>
<div>
<pre> class MyClass {
private static final LOG = Logger.getLogger(SomeOtherClass) // violation
def log1 = Logger.getLogger(SomeOtherClass.class) // violation
def log2 = Logger.getLogger(SomeOtherClass.class.name) // violation
}
</pre></div>
<p>Here are examples of <b>Commons Logging</b> code that cause violations:</p>
<div>
<pre> class MyClass {
private static final LOG = LogFactory.getLog(SomeOtherClass) // violation
Log log1 = LogFactory.getLog(SomeOtherClass.class) // violation
def log2 = LogFactory.getLog(SomeOtherClass.class.getName()) // violation
}
</pre></div>
<p>Here are examples of code that does NOT cause violations:</p>
<div>
<pre> // Log4J or Java Logging API
class MyClass {
private static final LOG = Logger.getLogger(MyClass) // ok
def log2 = Logger.getLogger(MyClass.class) // ok
private static log3 = Logger.getLogger(MyClass.getClass().getName()) // ok
private static log4 = Logger.getLogger(MyClass.getClass().name) // ok
private static log5 = Logger.getLogger(MyClass.class.getName()) // ok
private static log6 = Logger.getLogger(MyClass.class.name) // ok
}
// Commons Logging
class MyClass {
private static final LOG = LogFactory.getLog(MyClass) // ok
def log2 = LogFactory.getLog(MyClass.class) // ok
private static log3 = LogFactory.getLog(MyClass.getClass().getName()) // ok
private static log4 = LogFactory.getLog(MyClass.getClass().name) // ok
private static log5 = LogFactory.getLog(MyClass.class.getName()) // ok
private static log6 = LogFactory.getLog(MyClass.class.name) // ok
}
</pre></div></div>
<div class="section">
<h3><a name="LoggingSwallowsStacktrace">LoggingSwallowsStacktrace</a> Rule<a name="LoggingSwallowsStacktrace_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<p><i>Since CodeNarc 0.12</i></p>
<p>If you are logging an exception then the proper API is to call error(Object, Throwable), which will log the message and the exception stack trace. If you call error(Object) then the stacktrace may not be logged.</p></div>
<div class="section">
<h3><a name="LoggerWithWrongModifiers">LoggerWithWrongModifiers</a> Rule<a name="LoggerWithWrongModifiers_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<p><i>Since CodeNarc 0.12</i></p>
<p>Logger objects should be declared private, static and final.</p>
<p>This rule has a property: <tt>allowProtectedLogger</tt>, which defaults to false. Set it to true if you believe subclasses should have access to a Logger in a parent class and that Logger should be declared protected or public.</p>
<p>This rule has a property: <tt>allowNonStaticLogger</tt>, which defaults to false. Set it to true if you believe a logger should be allowed to be non-static.</p></div>
<div class="section">
<h3><a name="MultipleLoggers">MultipleLoggers</a> Rule<a name="MultipleLoggers_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<p><i>Since CodeNarc 0.12</i></p>
<p>This rule catches classes that have more than one logger object defined. Typically, a class has zero or one logger objects.</p></div>
<div class="section">
<h3><a name="Println">Println</a> Rule<a name="Println_Rule"></a></h3><!-- ~~~~~~~~~~~~~ -->
<p>Checks for calls to <tt>this.print()</tt>, <tt>this.println()</tt> or <tt>this.printf()</tt>. Consider using a standard logging facility instead.</p></div>
<div class="section">
<h3><a name="PrintStackTrace">PrintStackTrace</a> Rule<a name="PrintStackTrace_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~~~~ -->
<p>Checks for calls to <tt>Throwable.printStackTrace()</tt> or <tt>StackTraceUtils.printSanitizedStackTrace(Throwable)</tt>. Consider using a standard logging facility instead.</p></div>
<div class="section">
<h3><a name="SystemErrPrint">SystemErrPrint</a> Rule<a name="SystemErrPrint_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~~ -->
<p>Checks for calls to <tt>System.err.print()</tt>, <tt>System.err.println()</tt> or <tt>System.err.printf()</tt>. Consider using a standard logging facility instead.</p></div>
<div class="section">
<h3><a name="SystemOutPrint">SystemOutPrint</a> Rule<a name="SystemOutPrint_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~~ -->
<p>Checks for calls to <tt>System.out.print()</tt>, <tt>System.out.println()</tt> or <tt>System.out.printf()</tt>. Consider using a standard logging facility instead.</p></div></div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">
Copyright © 2015.
All Rights Reserved.
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>
|