| <?xml version="1.0" encoding="ISO-8859-1"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!-- |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| This file is generated from xml source: DO NOT EDIT |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| --> |
| <title>rotatelogs - Piped logging program to rotate Apache logs - Apache HTTP Server</title> |
| <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> |
| <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> |
| <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /> |
| <link href="../images/favicon.ico" rel="shortcut icon" /></head> |
| <body id="manual-page"><div id="page-header"> |
| <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> |
| <p class="apache">Apache HTTP Server Version 2.2</p> |
| <img alt="" src="../images/feather.gif" /></div> |
| <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> |
| <div id="path"> |
| <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.2</a> > <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>rotatelogs - Piped logging program to rotate Apache logs</h1> |
| <div class="toplang"> |
| <p><span>Available Languages: </span><a href="../en/programs/rotatelogs.html" title="English"> en </a> | |
| <a href="../ko/programs/rotatelogs.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | |
| <a href="../tr/programs/rotatelogs.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p> |
| </div> |
| |
| <p><code>rotatelogs</code> is a simple program for use in |
| conjunction with Apache's piped logfile feature. It supports |
| rotation based on a time interval or maximum size of the log.</p> |
| </div> |
| <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#portability">Portability</a></li> |
| </ul></div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="synopsis" id="synopsis">Synopsis</a></h2> |
| |
| <p><code><strong>rotatelogs</strong> |
| [ -<strong>l</strong> ] |
| [ -<strong>f</strong> ] |
| <var>logfile</var> |
| <var>rotationtime</var>|<var>filesize</var>M |
| [ <var>offset</var> ]</code></p> |
| </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="options" id="options">Options</a></h2> |
| |
| <dl> |
| |
| <dt><code>-l</code></dt> |
| <dd>Causes the use of local time rather than GMT as the base for the |
| interval or for <code>strftime(3)</code> formatting with size-based |
| rotation. Note that using <code>-l</code> in an environment which |
| changes the GMT offset (such as for BST or DST) can lead to unpredictable |
| results!</dd> |
| |
| <dt><code>-f</code></dt> |
| <dd>Causes the logfile to be opened immediately, as soon as |
| <code>rotatelogs</code> starts, instead of waiting for the |
| first logfile entry to be read (for non-busy sites, there may be |
| a substantial delay between when the server is started |
| and when the first request is handled, meaning that the |
| associated logfile does not "exist" until then, which |
| causes problems from some automated logging tools). |
| <em>Available in version 2.2.9 and later.</em></dd> |
| |
| <dt><code><var>logfile</var></code></dt> |
| |
| <dd>The path plus basename of the logfile. If <var>logfile</var> |
| includes any '%' characters, it is treated as a format string for |
| <code>strftime(3)</code>. Otherwise, the suffix |
| <var>.nnnnnnnnnn</var> is automatically added and is the time in |
| seconds. Both formats compute the start time from the beginning of |
| the current period. For example, if a rotation time of 86400 is |
| specified, the hour, minute, and second fields created from the |
| <code>strftime(3)</code> format will all be zero, referring to the |
| beginning of the current 24-hour period (midnight).</dd> |
| |
| <dt><code><var>rotationtime</var></code></dt> |
| |
| <dd>The time between log file rotations in seconds. The rotation |
| occurs at the beginning of this interval. For example, if the |
| rotation time is 3600, the log file will be rotated at the beginning |
| of every hour; if the rotation time is 86400, the log file will be |
| rotated every night at midnight. (If no data is logged during an |
| interval, no file will be created.)</dd> |
| |
| <dt><code><var>filesize</var>M</code></dt> |
| |
| <dd>The maximum file size in megabytes followed by the letter |
| <code>M</code> to specify size rather than time.</dd> |
| |
| <dt><code><var>offset</var></code></dt> |
| |
| <dd>The number of minutes offset from UTC. If omitted, zero is |
| assumed and UTC is used. For example, to use local time in the zone |
| UTC -5 hours, specify a value of <code>-300</code> for this argument. |
| In most cases, <code>-l</code> should be used instead of specifying |
| an offset.</dd> |
| |
| </dl> |
| </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="examples" id="examples">Examples</a></h2> |
| |
| <div class="example"><p><code> |
| CustomLog "|bin/rotatelogs /var/logs/logfile 86400" common |
| </code></p></div> |
| |
| <p>This creates the files /var/logs/logfile.nnnn where nnnn is |
| the system time at which the log nominally starts (this time |
| will always be a multiple of the rotation time, so you can |
| synchronize cron scripts with it). At the end of each rotation |
| time (here after 24 hours) a new log is started.</p> |
| |
| <div class="example"><p><code> |
| CustomLog "|bin/rotatelogs -l /var/logs/logfile.%Y.%m.%d 86400" common |
| </code></p></div> |
| |
| <p>This creates the files /var/logs/logfile.yyyy.mm.dd where |
| yyyy is the year, mm is the month, and dd is the day of the month. |
| Logging will switch to a new file every day at midnight, local time.</p> |
| |
| <div class="example"><p><code> |
| CustomLog "|bin/rotatelogs /var/logs/logfile 5M" common |
| </code></p></div> |
| |
| <p>This configuration will rotate the logfile whenever it reaches |
| a size of 5 megabytes.</p> |
| |
| <div class="example"><p><code> |
| ErrorLog "|bin/rotatelogs /var/logs/errorlog.%Y-%m-%d-%H_%M_%S 5M" |
| </code></p></div> |
| <p>This configuration will rotate the error logfile whenever it |
| reaches a size of 5 megabytes, and the suffix to the logfile name |
| will be created of the form |
| <code>errorlog.YYYY-mm-dd-HH_MM_SS</code>.</p> |
| |
| </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="portability" id="portability">Portability</a></h2> |
| |
| <p>The following logfile format string substitutions should be |
| supported by all <code>strftime(3)</code> implementations, see |
| the <code>strftime(3)</code> man page for library-specific |
| extensions.</p> |
| |
| <table class="bordered"><tr><td><code>%A</code></td><td>full weekday name (localized)</td></tr> |
| <tr class="odd"><td><code>%a</code></td><td>3-character weekday name (localized)</td></tr> |
| <tr><td><code>%B</code></td><td>full month name (localized)</td></tr> |
| <tr class="odd"><td><code>%b</code></td><td>3-character month name (localized)</td></tr> |
| <tr><td><code>%c</code></td><td>date and time (localized)</td></tr> |
| <tr class="odd"><td><code>%d</code></td><td>2-digit day of month</td></tr> |
| <tr><td><code>%H</code></td><td>2-digit hour (24 hour clock)</td></tr> |
| <tr class="odd"><td><code>%I</code></td><td>2-digit hour (12 hour clock)</td></tr> |
| <tr><td><code>%j</code></td><td>3-digit day of year</td></tr> |
| <tr class="odd"><td><code>%M</code></td><td>2-digit minute</td></tr> |
| <tr><td><code>%m</code></td><td>2-digit month</td></tr> |
| <tr class="odd"><td><code>%p</code></td><td>am/pm of 12 hour clock (localized)</td></tr> |
| <tr><td><code>%S</code></td><td>2-digit second</td></tr> |
| <tr class="odd"><td><code>%U</code></td><td>2-digit week of year |
| (Sunday first day of week)</td></tr> |
| <tr><td><code>%W</code></td><td>2-digit week of year |
| (Monday first day of week)</td></tr> |
| <tr class="odd"><td><code>%w</code></td><td>1-digit weekday |
| (Sunday first day of week)</td></tr> |
| <tr><td><code>%X</code></td><td>time (localized)</td></tr> |
| <tr class="odd"><td><code>%x</code></td><td>date (localized)</td></tr> |
| <tr><td><code>%Y</code></td><td>4-digit year</td></tr> |
| <tr class="odd"><td><code>%y</code></td><td>2-digit year</td></tr> |
| <tr><td><code>%Z</code></td><td>time zone name</td></tr> |
| <tr class="odd"><td><code>%%</code></td><td>literal `%'</td></tr> |
| </table> |
| |
| </div></div> |
| <div class="bottomlang"> |
| <p><span>Available Languages: </span><a href="../en/programs/rotatelogs.html" title="English"> en </a> | |
| <a href="../ko/programs/rotatelogs.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | |
| <a href="../tr/programs/rotatelogs.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p> |
| </div><div id="footer"> |
| <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> |
| <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> |
| </body></html> |
