granicus.if.org Git - apache/blob - docs/manual/mod/mod_journald.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_journald - Apache HTTP Server Version 2.5</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <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" />
  12 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body>
  17 <div id="page-header">
  18 <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>
  19 <p class="apache">Apache HTTP Server Version 2.5</p>
  20 <img alt="" src="../images/feather.gif" /></div>
  21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <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>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_journald</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_journald.html" title="English">&nbsp;en&nbsp;</a></p>
  28 </div>
  29 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides "journald" ErrorLog provider</td></tr>
  30 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  31 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>journald_module</td></tr>
  32 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_journald.c</td></tr></table>
  33 <h3>Summary</h3>
  34
  35     <p>This module provides "journald" ErrorLog provider. It allows logging
  36     error messages and CustomLog/TransferLog via systemd-journald(8).</p>
  37 </div>
  38 <div id="quickview"><h3 class="directives">Directives</h3>
  39 <ul id="toc">
  40 <li><img alt="" src="../images/down.gif" /> <a href="#journaldcustomlog">JournaldCustomLog</a></li>
  41 </ul>
  42 <h3>Topics</h3>
  43 <ul id="topics">
  44 <li><img alt="" src="../images/down.gif" /> <a href="#structured">Structured logging</a></li>
  45 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  46 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  47 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  48 <div class="section">
  49 <h2><a name="structured" id="structured">Structured logging</a></h2>
  50
  51     <p>Systemd-journald allows structured logging and therefore it is
  52     possible to filter logged messages according to various variables.
  53     Currently supported variables are:
  54     </p>
  55     <dl>
  56       <dt><code>LOG</code></dt>
  57       <dd>The name of the log. For ErrorLog, the value is "error_log".
  58           For CustomLog or TransferLog, the value is the first argument of
  59           these directives.</dd>
  60       <dt><code>REQUEST_HOSTNAME</code></dt>
  61       <dd>Host, as set by full URI or Host: header in the request.</dd>
  62       <dt><code>REQUEST_USER</code></dt>
  63       <dd>If an authentication check was made, this gets set to the user
  64           name.</dd>
  65       <dt><code>REQUEST_USERAGENT_IP</code></dt>
  66       <dd>The address that originated the request.</dd>
  67       <dt><code>REQUEST_URI</code></dt>
  68       <dd>The path portion of the URI, or "/" if no path provided.</dd>
  69       <dt><code>SERVER_HOSTNAME</code></dt>
  70       <dd>The hostname of server for which the log message has been
  71           generated.</dd>
  72     </dl>
  73
  74     <p>These variables can be for example used to show only log messages
  75     for particular URI using <code>journalctl</code>:
  76     </p>
  77
  78     <pre class="prettyprint lang-">journalctl REQUEST_URI=/index.html -a</pre>
  79
  80
  81     <p>For more examples, see systemd-journalctl documentation.</p>
  82 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  83 <div class="section">
  84 <h2><a name="examples" id="examples">Examples</a></h2>
  85
  86
  87     <p>Using <code>journald</code> in ErrorLog directive (see <code class="module"><a href="../mod/core.html">core</a></code>)
  88     instead of a filename enables logging via systemd-journald(8)
  89     if the system supports it.
  90     </p>
  91
  92     <pre class="prettyprint lang-config">ErrorLog journald</pre>
  93
  94
  95 </div>
  96 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  97 <div class="directive-section"><h2><a name="JournaldCustomLog" id="JournaldCustomLog">JournaldCustomLog</a> <a name="journaldcustomlog" id="journaldcustomlog">Directive</a></h2>
  98 <table class="directive">
  99 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable logging of CustomLog/TransferLog to systemd-journald</td></tr>
 100 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>JournaldCustomLog on|off</code></td></tr>
 101 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>JournaldCustomLog off</code></td></tr>
 102 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 103 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 104 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_journald</td></tr>
 105 </table>
 106
 107     <p>The <code class="directive">JournaldCustomLog</code> directive enables logging
 108     of CustomLog and TransferLog messages to systemd-journald.
 109     </p>
 110
 111     <div class="warning"><h3>Performance warning</h3><p>
 112     Currently, systemd-journald is not designed for high-throughput logging
 113     and logging access_log to systemd-journald could decrease the performance
 114     a lot.
 115     </p></div>
 116
 117 </div>
 118 </div>
 119 <div class="bottomlang">
 120 <p><span>Available Languages: </span><a href="../en/mod/mod_journald.html" title="English">&nbsp;en&nbsp;</a></p>
 121 </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>
 122 <script type="text/javascript"><!--//--><![CDATA[//><!--
 123 var comments_shortname = 'httpd';
 124 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_journald.html';
 125 (function(w, d) {
 126     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 127         d.write('<div id="comments_thread"><\/div>');
 128         var s = d.createElement('script');
 129         s.type = 'text/javascript';
 130         s.async = true;
 131         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 132         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 133     }
 134     else {
 135         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 136     }
 137 })(window, document);
 138 //--><!]]></script></div><div id="footer">
 139 <p class="apache">Copyright 2014 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>
 140 <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[//><!--
 141 if (typeof(prettyPrint) !== 'undefined') {
 142     prettyPrint();
 143 }
 144 //--><!]]></script>
 145 </body></html>