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      [ -<strong>v</strong> ]
  42      <var>logfile</var>
  43      <var>rotationtime</var>|<var>filesize</var>(B|K|M|G)
  44      [ <var>offset</var> ]</code></p>
  45 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  46 <div class="section">
  47 <h2><a name="options" id="options">Options</a></h2>
  48
  49 <dl>
  50
  51 <dt><code>-l</code></dt>
  52 <dd>Causes the use of local time rather than GMT as the base for the
  53 interval or for <code>strftime(3)</code> formatting with size-based
  54 rotation.  Note that using <code>-l</code> in an environment which
  55 changes the GMT offset (such as for BST or DST) can lead to unpredictable
  56 results!</dd>
  57
  58 <dt><code>-f</code></dt>
  59 <dd>Causes the logfile to be opened immediately, as soon as
  60 <code>rotatelogs</code> starts, instead of waiting for the
  61 first logfile entry to be read (for non-busy sites, there may be
  62 a substantial delay between when the server is started
  63 and when the first request is handled, meaning that the
  64 associated logfile does not "exist" until then, which
  65 causes problems from some automated logging tools)</dd>
  66
  67 <dt><code>-v</code></dt>
  68 <dd>Produce verbose output on STDERR. The output contains
  69 the result of the configuration parsing, and all file open and
  70 close actions.</dd>
  71
  72 <dt><code><var>logfile</var></code></dt>
  73
  74 <dd>The path plus basename of the logfile.  If <var>logfile</var>
  75 includes any '%' characters, it is treated as a format string for
  76 <code>strftime(3)</code>.  Otherwise, the suffix
  77 <var>.nnnnnnnnnn</var> is automatically added and is the time in
  78 seconds.  Both formats compute the start time from the beginning of
  79 the current period.  For example, if a rotation time of 86400 is
  80 specified, the hour, minute, and second fields created from the
  81 <code>strftime(3)</code> format will all be zero, referring to the
  82 beginning of the current 24-hour period (midnight).</dd>
  83
  84 <dt><code><var>rotationtime</var></code></dt>
  85
  86 <dd>The time between log file rotations in seconds.  The rotation
  87 occurs at the beginning of this interval.  For example, if the
  88 rotation time is 3600, the log file will be rotated at the beginning
  89 of every hour; if the rotation time is 86400, the log file will be
  90 rotated every night at midnight.  (If no data is logged during an
  91 interval, no file will be created.)</dd>
  92
  93 <dt><code><var>filesize</var>(B|K|M|G)</code></dt>
  94
  95 <dd>The maximum file size in followed by exactly one of the letters
  96 <code>B</code> (Bytes), <code>K</code> (KBytes), <code>M</code> (MBytes)
  97 or <code>G</code> (GBytes).
  98 <p>
  99 When time and size are specified, the size must be given after the time.
 100 Rotation will occur whenever either time or size limits are reached.
 101 </p>
 102 </dd>
 103
 104 <dt><code><var>offset</var></code></dt>
 105
 106 <dd>The number of minutes offset from UTC.  If omitted, zero is
 107 assumed and UTC is used.  For example, to use local time in the zone
 108 UTC -5 hours, specify a value of <code>-300</code> for this argument.
 109 In most cases, <code>-l</code> should be used instead of specifying
 110 an offset.</dd>
 111
 112 </dl>
 113 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 114 <div class="section">
 115 <h2><a name="examples" id="examples">Examples</a></h2>
 116
 117 <div class="example"><p><code>
 118      CustomLog "|bin/rotatelogs /var/logs/logfile 86400" common
 119 </code></p></div>
 120
 121      <p>This creates the files /var/logs/logfile.nnnn where nnnn  is
 122      the system time at which the log nominally starts (this time
 123      will always be a multiple of the rotation time, so  you  can
 124      synchronize cron scripts with it).  At the end of each rotation
 125      time (here after 24 hours) a new log is started.</p>
 126
 127 <div class="example"><p><code>
 128      CustomLog "|bin/rotatelogs -l /var/logs/logfile.%Y.%m.%d 86400" common
 129 </code></p></div>
 130
 131      <p>This creates the files /var/logs/logfile.yyyy.mm.dd where
 132      yyyy is the year, mm is the month, and dd is the day of the month.
 133      Logging will switch to a new file every day at midnight, local time.</p>
 134
 135 <div class="example"><p><code>
 136      CustomLog "|bin/rotatelogs /var/logs/logfile 5M" common
 137 </code></p></div>
 138
 139      <p>This configuration will rotate the logfile whenever it reaches
 140      a size of 5 megabytes.</p>
 141
 142 <div class="example"><p><code>
 143      ErrorLog "|bin/rotatelogs /var/logs/errorlog.%Y-%m-%d-%H_%M_%S 5M"
 144 </code></p></div>
 145      <p>This configuration will rotate the error logfile whenever it
 146      reaches a size of 5 megabytes, and the suffix to the logfile name
 147      will be created of the form
 148      <code>errorlog.YYYY-mm-dd-HH_MM_SS</code>.</p>
 149
 150 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 151 <div class="section">
 152 <h2><a name="portability" id="portability">Portability</a></h2>
 153
 154 <p>The following logfile format string substitutions should be
 155 supported by all <code>strftime(3)</code> implementations, see
 156 the <code>strftime(3)</code> man page for library-specific
 157 extensions.</p>
 158
 159 <table class="bordered"><tr><td><code>%A</code></td><td>full weekday name (localized)</td></tr>
 160 <tr class="odd"><td><code>%a</code></td><td>3-character weekday name (localized)</td></tr>
 161 <tr><td><code>%B</code></td><td>full month name (localized)</td></tr>
 162 <tr class="odd"><td><code>%b</code></td><td>3-character month name (localized)</td></tr>
 163 <tr><td><code>%c</code></td><td>date and time (localized)</td></tr>
 164 <tr class="odd"><td><code>%d</code></td><td>2-digit day of month</td></tr>
 165 <tr><td><code>%H</code></td><td>2-digit hour (24 hour clock)</td></tr>
 166 <tr class="odd"><td><code>%I</code></td><td>2-digit hour (12 hour clock)</td></tr>
 167 <tr><td><code>%j</code></td><td>3-digit day of year</td></tr>
 168 <tr class="odd"><td><code>%M</code></td><td>2-digit minute</td></tr>
 169 <tr><td><code>%m</code></td><td>2-digit month</td></tr>
 170 <tr class="odd"><td><code>%p</code></td><td>am/pm of 12 hour clock (localized)</td></tr>
 171 <tr><td><code>%S</code></td><td>2-digit second</td></tr>
 172 <tr class="odd"><td><code>%U</code></td><td>2-digit week of year
 173 (Sunday first day of week)</td></tr>
 174 <tr><td><code>%W</code></td><td>2-digit week of year
 175 (Monday first day of week)</td></tr>
 176 <tr class="odd"><td><code>%w</code></td><td>1-digit weekday
 177 (Sunday first day of week)</td></tr>
 178 <tr><td><code>%X</code></td><td>time (localized)</td></tr>
 179 <tr class="odd"><td><code>%x</code></td><td>date (localized)</td></tr>
 180 <tr><td><code>%Y</code></td><td>4-digit year</td></tr>
 181 <tr class="odd"><td><code>%y</code></td><td>2-digit year</td></tr>
 182 <tr><td><code>%Z</code></td><td>time zone name</td></tr>
 183 <tr class="odd"><td><code>%%</code></td><td>literal `%'</td></tr>
 184 </table>
 185
 186 </div></div>
 187 <div class="bottomlang">
 188 <p><span>Available Languages: </span><a href="../en/programs/rotatelogs.html" title="English">&nbsp;en&nbsp;</a> |
 189 <a href="../ko/programs/rotatelogs.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 190 </div><div id="footer">
 191 <p class="apache">Copyright 2009 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>
 192 <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>
 193 </body></html>