mod_journald.html.en revision 205f749042ed530040a4f0080dbcb47ceae8a374
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<?xml version="1.0" encoding="ISO-8859-1"?>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd This file is generated from xml source: DO NOT EDIT
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd -->
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<title>mod_journald - Apache HTTP Server Version 2.5</title>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" />
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<script src="/style/scripts/prettify.min.js" type="text/javascript">
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd</script>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<link href="/images/favicon.ico" rel="shortcut icon" /></head>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<body>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<div id="page-header">
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<p class="apache">Apache HTTP Server Version 2.5</p>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<img alt="" src="/images/feather.gif" /></div>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<div id="path">
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<div id="page-content">
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<div id="preamble"><h1>Apache Module mod_journald</h1>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<div class="toplang">
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<p><span>Available Languages: </span><a href="/en/mod/mod_journald.html" title="English">&nbsp;en&nbsp;</a></p>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd</div>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides "journald" ErrorLog provider</td></tr>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>journald_module</td></tr>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_journald.c</td></tr></table>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<h3>Summary</h3>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <p>This module provides "journald" ErrorLog provider. It allows logging
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd error messages and CustomLog/TransferLog via systemd-journald(8).</p>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd</div>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<div id="quickview"><h3 class="directives">Directives</h3>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<ul id="toc">
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<li><img alt="" src="/images/down.gif" /> <a href="#journaldcustomlog">JournaldCustomLog</a></li>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd</ul>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<h3>Topics</h3>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<ul id="topics">
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<li><img alt="" src="/images/down.gif" /> <a href="#structured">Structured logging</a></li>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<li><img alt="" src="/images/down.gif" /> <a href="#examples">Examples</a></li>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<div class="section">
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<h2><a name="structured" id="structured">Structured logging</a></h2>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <p>Systemd-journald allows structured logging and therefore it is
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd possible to filter logged messages according to various variables.
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd Currently supported variables are:
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd </p>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <dl>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <dt><code>LOG</code></dt>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <dd>The name of the log. For ErrorLog, the value is "error_log".
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd For CustomLog or TransferLog, the value is the first argument of
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd these directives.</dd>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <dt><code>REQUEST_HOSTNAME</code></dt>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <dd>Host, as set by full URI or Host: header in the request.</dd>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <dt><code>REQUEST_USER</code></dt>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <dd>If an authentication check was made, this gets set to the user
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd name.</dd>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <dt><code>REQUEST_USERAGENT_IP</code></dt>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <dd>The address that originated the request.</dd>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <dt><code>REQUEST_URI</code></dt>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <dd>The path portion of the URI, or "/" if no path provided.</dd>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <dt><code>SERVER_HOSTNAME</code></dt>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <dd>The hostname of server for which the log message has been
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd generated.</dd>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd </dl>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <p>These variables can be for example used to show only log messages
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd for particular URI using <code>journalctl</code>:
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd </p>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <pre class="prettyprint lang-">journalctl REQUEST_URI=/index.html -a</pre>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <p>For more examples, see systemd-journalctl documentation.</p>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<div class="section">
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<h2><a name="examples" id="examples">Examples</a></h2>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <p>Using <code>journald</code> in ErrorLog directive (see <code class="module"><a href="/mod/core.html">core</a></code>)
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd instead of a filename enables logging via systemd-journald(8)
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd if the system supports it.
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd </p>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <pre class="prettyprint lang-config">ErrorLog journald</pre>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd</div>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<div class="directive-section"><h2><a name="JournaldCustomLog" id="JournaldCustomLog">JournaldCustomLog</a> <a name="journaldcustomlog" id="journaldcustomlog">Directive</a></h2>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<table class="directive">
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable logging of CustomLog/TransferLog to systemd-journald</td></tr>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>JournaldCustomLog on|off</code></td></tr>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>JournaldCustomLog off</code></td></tr>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_journald</td></tr>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd</table>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <p>The <code class="directive">JournaldCustomLog</code> directive enables logging
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd of CustomLog and TransferLog messages to systemd-journald.
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd </p>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd <div class="warning"><h3>Performance warning</h3><p>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd Currently, systemd-journald is not designed for high-throughput logging
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd and logging access_log to systemd-journald could decrease the performance
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd a lot.
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd </p></div>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd</div>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd</div>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<div class="bottomlang">
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<p><span>Available Languages: </span><a href="/en/mod/mod_journald.html" title="English">&nbsp;en&nbsp;</a></p>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<script type="text/javascript"><!--//--><![CDATA[//><!--
6c4ef4a72d9897e53365b94103f4bd819fd0d3acndvar comments_shortname = 'httpd';
6c4ef4a72d9897e53365b94103f4bd819fd0d3acndvar comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_journald.html';
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd(function(w, d) {
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd d.write('<div id="comments_thread"><\/div>');
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd var s = d.createElement('script');
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd s.type = 'text/javascript';
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd s.async = true;
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd }
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd else {
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd }
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd})(window, document);
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd//--><!]]></script></div><div id="footer">
205f749042ed530040a4f0080dbcb47ceae8a374rjung<p class="apache">Copyright 2015 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
6c4ef4a72d9897e53365b94103f4bd819fd0d3acndif (typeof(prettyPrint) !== 'undefined') {
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd prettyPrint();
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd}
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd//--><!]]></script>
6c4ef4a72d9897e53365b94103f4bd819fd0d3acnd</body></html>