Google Git
Sign in
apache / logging-site / refs/heads/asf-staging / . / content / xml / ns / index.html
blob: f4af919fec9be915a9d30d0d0a928410985cb043 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Apache Logging Services</title>
<link href="/css/asciidoctor-default.css" rel="stylesheet" type="text/css" />
<link href="/css/bootstrap.min.css" rel="stylesheet" type="text/css" />
<link href="/css/site.css?version=20231214" rel="stylesheet" type="text/css" />
<script src="/js/jquery.min.js"></script>
<script src="/js/bootstrap.min.js"></script>
<script src="/js/site.js"></script>
<link rel="alternate" type="application/rss+xml" title="ASF Loggin Services" href="/feed.xml">
</head>
<body>
<div class="navbar">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="/">Apache Logging Services&trade;</a>
<ul class="nav">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="/guidelines.html">Guidelines</a></li>
<li><a href="/charter.html">Charter</a></li>
<li><a href="/team-list.html">Team</a></li>
<li><a href="/processes.html">Retirement Processes</a>
<li><a target="_blank" href="https://cwiki.apache.org/confluence/display/LOGGING/Home">Wiki</a>
<li><a href="/what-is-logging.html">What is logging?</a></li>
<li><a href="/activity-monitor">Activity monitor</a></li>
</ul>
</li>
</ul>
<ul class="nav">
<li><a href="/download.html">Download</a></li>
</ul>
<ul class="nav">
<li><a href="/support.html">Support</a></li>
</ul>
<ul class="nav">
<li><a href="/security.html">Security</a></li>
</ul>
<ul class="nav">
<li><a href="/xml/ns">XML Schemas</a></li>
</ul>
<ul class="nav pull-right">
<li><a href="/blog">Blog</a></li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>All XML Schemas for Apache Logging Services projects are published at this directory.
The canonical name for this directory is <code><a href="https://logging.apache.org/xml/ns" class="bare">https://logging.apache.org/xml/ns</a></code>.</p>
</div>
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<div class="title">Important</div>
</td>
<td class="content">
<div class="paragraph">
<p>There are two important things to understand about XSD versioning scheme used here to employ these schemas in your applications:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p><strong>Schema versions and project versions evolve independently.</strong>
That is, Log4j <code>2.24.0</code> release does not necessarily mean a new <code>log4j-config-2.24.0.xsd</code>: the Log4j 2 runtime configuration API might have been kept intact.</p>
</li>
<li>
<p><strong>Users are recommended to use schemas with only major versions</strong>; <code>log4j-config-2.xsd</code>, <code>log4j-config-3.xsd</code>, <code>log4j-changelog-0.xsd</code>, etc.</p>
</li>
</ol>
</div>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="log4j">Log4j schemas</h2>
<div class="sectionbody">
<div class="paragraph">
<p><a href="#/log4j">Log4j</a> is a Java logging framework.
Following schemas model the Log4j runtime configuration, i.e., <code>log4j2.xml</code><sup class="footnote">[<a id="_footnoteref_1" class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup>.</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Publication date</th>
<th class="tableblock halign-left valign-top">File name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2024-03-19</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="log4j-config-2.23.1.xsd">log4j-config-2.23.1.xsd</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Released with <a href="/log4j/2.x/release-notes.html#release-notes-2-23-1">Log4j <code>2.23.1</code></a></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">N/A</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="log4j-config-2.xsd">log4j-config-2.xsd</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Points to the most recent XSD of major version <code>2</code>.
<strong>Log4j 2 users are recommended to refer to this XSD in their XML files.</strong></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2024-03-19</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="log4j-config-3.0.0.xsd">log4j-config-3.0.0.xsd</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">N/A</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">N/A</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="log4j-config-3.xsd">log4j-config-3.xsd</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Points to the most recent XSD of major version <code>3</code>.
<strong>Log4j 3 users are recommended to refer to this XSD in their XML files.</strong></p></td>
</tr>
</tbody>
</table>
<div class="listingblock">
<div class="title">Example Log4j 2 schema usage</div>
<div class="content">
<pre class="highlight"><code class="language-xml" data-lang="xml">&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;Configuration xmlns="https://logging.apache.org/xml/ns"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-config-2.xsd"&gt;
&lt;Appenders&gt;
&lt;Console name="Console" target="SYSTEM_OUT"&gt;
&lt;PatternLayout pattern="%d [%t] %p %c - %m%n"/&gt;
&lt;/Console&gt;
&lt;/Appenders&gt;
&lt;Loggers&gt;
&lt;Root level="WARN"&gt;
&lt;AppenderRef ref="Console"/&gt;
&lt;/Root&gt;
&lt;/Loggers&gt;
&lt;/Configuration&gt;</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="log4j-changelog">Log4j Changelog schemas</h2>
<div class="sectionbody">
<div class="paragraph">
<p><a href="/log4j/tools/latest/#log4j-changelog">Log4j Changelog</a> is a tool to maintain changelogs.
It is designed for Apache Log4j, but can be used for any Java project.</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Publication date</th>
<th class="tableblock halign-left valign-top">File name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2023-02-03</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="log4j-changelog-0.1.0.xsd">log4j-changelog-0.1.0.xsd</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Released with <a href="/log4j/tools/latest/#release-notes-0-2-0">Log4j Tools <code>0.2.0</code></a></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2023-03-17</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="log4j-changelog-0.1.1.xsd">log4j-changelog-0.1.1.xsd</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Released with <a href="/log4j/tools/latest/#release-notes-0-3-0">Log4j Tools <code>0.3.0</code></a></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2023-09-28</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="log4j-changelog-0.1.2.xsd">log4j-changelog-0.1.2.xsd</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Released with <a href="/log4j/tools/latest/#release-notes-0-5-0">Log4j Tools <code>0.5.0</code></a></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2023-12-13</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="log4j-changelog-0.1.3.xsd">log4j-changelog-0.1.3.xsd</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Released with <a href="/log4j/tools/latest/#release-notes-0-7-0">Log4j Tools <code>0.7.0</code></a></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2024-03-15</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="log4j-changelog-0.2.0.xsd">log4j-changelog-0.2.0.xsd</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Planned to be released with Log4j Tools <code>0.8.0</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">N/A</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="log4j-changelog-0.xsd">log4j-changelog-0.xsd</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Points to the most recent XSD of major version <code>0</code>.
<strong>Users are recommended to refer to this XSD in their XML files.</strong></p></td>
</tr>
</tbody>
</table>
<div class="listingblock">
<div class="title">Example Log4j Changelog schema usage</div>
<div class="content">
<pre class="highlight"><code class="language-xml" data-lang="xml">&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://logging.apache.org/xml/ns"
xsi:schemaLocation="
https://logging.apache.org/xml/ns
https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
type="updated"&gt;
&lt;issue id="2370" link="https://github.com/apache/logging-log4j2/pull/2370"/&gt;
&lt;description format="asciidoc"&gt;Update `actions/checkout` to version `4.1.2`&lt;/description&gt;
&lt;/entry&gt;</code></pre>
</div>
</div>
</div>
</div>
<div id="footnotes">
<hr>
<div class="footnote" id="_footnotedef_1">
<a href="#_footnoteref_1">1</a>. Both Log4j 2 and Log4j 3 use <code>log4j2.xml</code> for configuration.
</div>
</div>
</div>
</div>
<div class="footer">
<div class="container">
<p>
Copyright © 2017-2024 <a href="https://www.apache.org" target="external">The Apache Software Foundation</a>.
Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0"
target="external">Apache Software License, Version 2.0</a> Please read our <a href="https://privacy.apache.org/policies/privacy-policy-public.html">privacy policy</a>.
</p><p>
Apache, Chainsaw, log4cxx, Log4j, Log4net, log4php and the Apache
feather logo are trademarks or registered trademarks of The Apache
Software Foundation.
Oracle and Java are registered trademarks
of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
</p>
</div>
</div>
<!-- Matomo -->
<script>
var _paq = window._paq = window._paq || [];
_paq.push(["disableCookies"]);
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="https://analytics.apache.org/";
_paq.push(['setTrackerUrl', u+'matomo.php']);
_paq.push(['setSiteId', '42']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
})();
</script>
<noscript><p><img src="https://analytics.apache.org/matomo.php?idsite=42&amp;rec=1" style="border:0;" alt="" /></p></noscript>
<!-- End Matomo Code -->
</body>
</html>