blob: 8e2fce2f226494e0c8db2995f4027debc320bee3 [file] [log] [blame]
<!doctype html>
<!-- Generated by FreeMarker/Docgen from DocBook -->
<html lang="en" class="page-type-section">
<head prefix="og: http://ogp.me/ns#">
<meta charset="utf-8">
<title>Logging - FreeMarker Manual</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="format-detection" content="telephone=no">
<meta property="og:site_name" content="FreeMarker Manual">
<meta property="og:title" content="Logging">
<meta property="og:locale" content="en_US">
<meta property="og:url" content="http://example.com/pgui_misc_logging.html">
<link rel="canonical" href="http://example.com/pgui_misc_logging.html">
<link rel="icon" href="favicon.png" type="image/png">
<link rel="stylesheet" type="text/css" href="docgen-resources/docgen.min.css?1594338517553">
</head>
<body itemscope itemtype="https://schema.org/Code">
<meta itemprop="url" content="http://example.com/">
<meta itemprop="name" content="FreeMarker Manual">
<!--[if lte IE 9]>
<div style="background-color: #C00; color: #fff; padding: 12px 24px;">Please use a modern browser to view this website.</div>
<![endif]--><div class="header-top-bg"><div class="site-width header-top"><a class="logo" href="http://example.com" role="banner"> <img itemprop="image" src="logo.png" alt="My Logo">
</a></div></div><div class="header-bottom-bg"><div class="site-width search-row"><a href="index.html" class="navigation-header">FreeMarker Manual</a><div class="navigation-header"></div></div><div class="site-width breadcrumb-row"><ul class="breadcrumb" itemscope itemtype="http://schema.org/BreadcrumbList"><li class="step-0" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="index.html"><span itemprop="name">FreeMarker Manual</span></a></li><li class="step-1" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="pgui.html"><span itemprop="name">Programmer&#39;s Guide</span></a></li><li class="step-2" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="pgui_misc.html"><span itemprop="name">Miscellaneous</span></a></li><li class="step-3" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="pgui_misc_logging.html"><span itemprop="name">Logging</span></a></li></ul><div class="bookmarks" title="Bookmarks"><span class="sr-only">Bookmarks:</span><ul class="bookmark-list"><li><a href="alphaidx.html">Index</a></li><li><a href="gloss.html">Glossary</a></li><li><a href="ref.html">Reference</a></li><li><a href="app_faq.html">FAQ</a></li><li><a href="preface.html#test_target">Bőregér</a></li></ul></div></div></div> <div class="main-content site-width">
<div class="content-wrapper no-toc">
<div id="table-of-contents-wrapper" class="col-left">
</div>
<div class="col-right"><div class="page-content"><div class="page-title"><div class="pagers top"><a class="paging-arrow previous" href="pgui_misc_beanwrapper.html"><span>Previous</span></a><a class="paging-arrow next" href="pgui_misc_servlet.html"><span>Next</span></a></div><div class="title-wrapper">
<h1 class="content-header header-section1" id="pgui_misc_logging" itemprop="headline">Logging</h1>
</div></div><p>FreeMarker integrates with the following logging packages: <a href="http://jakarta.apache.org/log4j">Log4J</a>, <a href="http://jakarta.apache.org/avalon/logkit">Avalon
LogKit</a>, and <a href="http://java.sun.com/j2se/1.4/docs/api/java/util/logging/package-summary.html">java.util.logging</a>
(Java2 platform 1.4 and above). You need not do anything in order for
FreeMarker to use these loggers; if any of them is discovered through
the class loader that loaded FreeMarker classes, it is used
automatically. All log messages produced by FreeMarker are logged into
the logger hierarchy whose top-level logger is named
<code class="inline-code">freemarker</code>. Currently used loggers are:</p> <div class="table-responsive">
<table class="table">
<thead>
<tr>
<th>Logger name</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="inline-code">freemarker.beans</code></td>
<td>Logs messages of the Beans wrapper module.</td>
</tr>
<tr>
<td><code class="inline-code">freemarker.cache</code></td>
<td>Logs messages related to template loading and caching.</td>
</tr>
<tr>
<td><code class="inline-code">freemarker.runtime</code></td>
<td>Logs template exceptions thrown during template
processing.</td>
</tr>
<tr>
<td><code class="inline-code">freemarker.runtime.attempt</code></td>
<td>Logs template exceptions thrown during template processing,
but caught by
<code class="inline-code">attempt</code>/<code class="inline-code">recover</code>
directives. Enable DEBUG severity to see the exceptions.</td>
</tr>
<tr>
<td><code class="inline-code">freemarker.servlet</code></td>
<td>Logs messages of the FreemarkerServlet class.</td>
</tr>
</tbody>
</table>
</div>
<p>FreeMarker will look for the logging packages in this order, and
will use the first package it finds: Log4J, Avalon, java.util.logging.
However, if you call the static <code class="inline-code">selectLoggerLibrary</code>
method on the <code class="inline-code">freemarker.log.Logger</code> class with
appropriate parameter, you can explicitly select a logger package, or
even disable the logging.</p><p>You can also call the static
<code class="inline-code">selectLoggerLibrary</code> method on the
<code class="inline-code">freemarker.log.Logger</code> class and pass it a string
that will be used to prefix the above mentioned logger names. This is
useful if you want to have separate loggers on a per-application
basis.</p><div class="bottom-pagers-wrapper"><div class="pagers bottom"><a class="paging-arrow previous" href="pgui_misc_beanwrapper.html"><span>Previous</span></a><a class="paging-arrow next" href="pgui_misc_servlet.html"><span>Next</span></a></div></div></div></div> </div>
</div>
<div class="site-footer"><div class="site-width"><div class="footer-bottom"> <p class="last-generated">
Last generated:
<time itemprop="dateModified" datetime="2020-07-09T23:48:37Z" title="Thursday, July 9, 2020 11:48:37 PM GMT">2020-07-09 23:48:37 GMT</time> </p>
<p class="copyright">
© <span itemprop="copyrightYear">1999</span>–2020
<a itemtype="http://schema.org/Organization" itemprop="copyrightHolder" href="https://apache.org/">The Apache Software Foundation</a> </p>
</div></div></div></body>
</html>