granicus.if.org Git - apache/blob - docs/manual/programs/rotatelogs.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>rotatelogs - Piped logging program to rotate Apache logs - Apache HTTP Server</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" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body id="manual-page"><div id="page-header">
  14 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  15 <p class="apache">Apache HTTP Server Version 2.3</p>
  16 <img alt="" src="../images/feather.gif" /></div>
  17 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  18 <div id="path">
  19 <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.3</a> &gt; <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>rotatelogs - Piped logging program to rotate Apache logs</h1>
  20 <div class="toplang">
  21 <p><span>Available Languages: </span><a href="../en/programs/rotatelogs.html" title="English">&nbsp;en&nbsp;</a> |
  22 <a href="../ko/programs/rotatelogs.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  23 </div>
  24
  25      <p><code>rotatelogs</code> is a simple program for use in
  26      conjunction with Apache's piped logfile feature.  It supports
  27      rotation based on a time interval or maximum size of the log.</p>
  28 </div>
  29 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li>
  30 <li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li>
  31 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  32 <li><img alt="" src="../images/down.gif" /> <a href="#portability">Portability</a></li>
  33 </ul></div>
  34 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  35 <div class="section">
  36 <h2><a name="synopsis" id="synopsis">Synopsis</a></h2>
  37
  38      <p><code><strong>rotatelogs</strong>
  39      [ -<strong>l</strong> ]
  40      [ -<strong>f</strong> ]
  41      <var>logfile</var>
  42      <var>rotationtime</var>|<var>filesize</var>M
  43      [ <var>offset</var> ]</code></p>
  44 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  45 <div class="section">
  46 <h2><a name="options" id="options">Options</a></h2>
  47
  48 <dl>
  49
  50 <dt><code>-l</code></dt>
  51 <dd>Causes the use of local time rather than GMT as the base for the
  52 interval or for <code>strftime(3)</code> formatting with size-based
  53 rotation.  Note that using <code>-l</code> in an environment which
  54 changes the GMT offset (such as for BST or DST) can lead to unpredictable
  55 results!</dd>
  56
  57 <dt><code>-f</code></dt>
  58 <dd>Causes the logfile to be opened immediately, as soon as
  59 <code>rotatelogs</code> starts, instead of waiting for the
  60 first logfile entry to be read (for non-busy sites, there may be
  61 a substantial delay between when the server is started
  62 and when the first request is handled, meaning that the
  63 associated logfile does not "exist" until then, which
  64 causes problems from some automated logging tools)</dd>
  65
  66 <dt><code><var>logfile</var></code></dt>
  67
  68 <dd>The path plus basename of the logfile.  If <var>logfile</var>
  69 includes any '%' characters, it is treated as a format string for
  70 <code>strftime(3)</code>.  Otherwise, the suffix
  71 <var>.nnnnnnnnnn</var> is automatically added and is the time in
  72 seconds.  Both formats compute the start time from the beginning of
  73 the current period.  For example, if a rotation time of 86400 is
  74 specified, the hour, minute, and second fields created from the
  75 <code>strftime(3)</code> format will all be zero, referring to the
  76 beginning of the current 24-hour period (midnight).</dd>
  77
  78 <dt><code><var>rotationtime</var></code></dt>
  79
  80 <dd>The time between log file rotations in seconds.  The rotation
  81 occurs at the beginning of this interval.  For example, if the
  82 rotation time is 3600, the log file will be rotated at the beginning
  83 of every hour; if the rotation time is 86400, the log file will be
  84 rotated every night at midnight.  (If no data is logged during an
  85 interval, no file will be created.)</dd>
  86
  87 <dt><code><var>filesize</var>M</code></dt>
  88
  89 <dd>The maximum file size in megabytes followed by the letter
  90 <code>M</code> to specify size rather than time.</dd>
  91
  92 <dt><code><var>offset</var></code></dt>
  93
  94 <dd>The number of minutes offset from UTC.  If omitted, zero is
  95 assumed and UTC is used.  For example, to use local time in the zone
  96 UTC -5 hours, specify a value of <code>-300</code> for this argument.
  97 In most cases, <code>-l</code> should be used instead of specifying
  98 an offset.</dd>
  99
 100 </dl>
 101 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 102 <div class="section">
 103 <h2><a name="examples" id="examples">Examples</a></h2>
 104
 105 <div class="example"><p><code>
 106      CustomLog "|bin/rotatelogs /var/logs/logfile 86400" common
 107 </code></p></div>
 108
 109      <p>This creates the files /var/logs/logfile.nnnn where nnnn  is
 110      the system time at which the log nominally starts (this time
 111      will always be a multiple of the rotation time, so  you  can
 112      synchronize cron scripts with it).  At the end of each rotation
 113      time (here after 24 hours) a new log is started.</p>
 114
 115 <div class="example"><p><code>
 116      CustomLog "|bin/rotatelogs -l /var/logs/logfile.%Y.%m.%d 86400" common
 117 </code></p></div>
 118
 119      <p>This creates the files /var/logs/logfile.yyyy.mm.dd where
 120      yyyy is the year, mm is the month, and dd is the day of the month.
 121      Logging will switch to a new file every day at midnight, local time.</p>
 122
 123 <div class="example"><p><code>
 124      CustomLog "|bin/rotatelogs /var/logs/logfile 5M" common
 125 </code></p></div>
 126
 127      <p>This configuration will rotate the logfile whenever it reaches
 128      a size of 5 megabytes.</p>
 129
 130 <div class="example"><p><code>
 131      ErrorLog "|bin/rotatelogs /var/logs/errorlog.%Y-%m-%d-%H_%M_%S 5M"
 132 </code></p></div>
 133      <p>This configuration will rotate the error logfile whenever it
 134      reaches a size of 5 megabytes, and the suffix to the logfile name
 135      will be created of the form
 136      <code>errorlog.YYYY-mm-dd-HH_MM_SS</code>.</p>
 137
 138 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 139 <div class="section">
 140 <h2><a name="portability" id="portability">Portability</a></h2>
 141
 142 <p>The following logfile format string substitutions should be
 143 supported by all <code>strftime(3)</code> implementations, see
 144 the <code>strftime(3)</code> man page for library-specific
 145 extensions.</p>
 146
 147 <table class="bordered"><tr><td><code>%A</code></td><td>full weekday name (localized)</td></tr>
 148 <tr class="odd"><td><code>%a</code></td><td>3-character weekday name (localized)</td></tr>
 149 <tr><td><code>%B</code></td><td>full month name (localized)</td></tr>
 150 <tr class="odd"><td><code>%b</code></td><td>3-character month name (localized)</td></tr>
 151 <tr><td><code>%c</code></td><td>date and time (localized)</td></tr>
 152 <tr class="odd"><td><code>%d</code></td><td>2-digit day of month</td></tr>
 153 <tr><td><code>%H</code></td><td>2-digit hour (24 hour clock)</td></tr>
 154 <tr class="odd"><td><code>%I</code></td><td>2-digit hour (12 hour clock)</td></tr>
 155 <tr><td><code>%j</code></td><td>3-digit day of year</td></tr>
 156 <tr class="odd"><td><code>%M</code></td><td>2-digit minute</td></tr>
 157 <tr><td><code>%m</code></td><td>2-digit month</td></tr>
 158 <tr class="odd"><td><code>%p</code></td><td>am/pm of 12 hour clock (localized)</td></tr>
 159 <tr><td><code>%S</code></td><td>2-digit second</td></tr>
 160 <tr class="odd"><td><code>%U</code></td><td>2-digit week of year
 161 (Sunday first day of week)</td></tr>
 162 <tr><td><code>%W</code></td><td>2-digit week of year
 163 (Monday first day of week)</td></tr>
 164 <tr class="odd"><td><code>%w</code></td><td>1-digit weekday
 165 (Sunday first day of week)</td></tr>
 166 <tr><td><code>%X</code></td><td>time (localized)</td></tr>
 167 <tr class="odd"><td><code>%x</code></td><td>date (localized)</td></tr>
 168 <tr><td><code>%Y</code></td><td>4-digit year</td></tr>
 169 <tr class="odd"><td><code>%y</code></td><td>2-digit year</td></tr>
 170 <tr><td><code>%Z</code></td><td>time zone name</td></tr>
 171 <tr class="odd"><td><code>%%</code></td><td>literal `%'</td></tr>
 172 </table>
 173
 174 </div></div>
 175 <div class="bottomlang">
 176 <p><span>Available Languages: </span><a href="../en/programs/rotatelogs.html" title="English">&nbsp;en&nbsp;</a> |
 177 <a href="../ko/programs/rotatelogs.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 178 </div><div id="footer">
 179 <p class="apache">Copyright 2008 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>
 180 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 181 </body></html>